---

Inspired by the Create Minecraft mod, Ponder is an in-game user documentation API. With this API, any other addon can register their own storyboards and provide visual documentation for their addon, rather than having to maintain an online wiki/rely on word of mouth.

A couple of example storyboards are provided in lua/ponder/storyboards_cl/.

Documentation

• Ponder Wiki - Comprehensive guide to the Ponder system
• Quick Reference Guide - Concise reference sheet for common instructions
• Example Storyboard - Complete example demonstrating various features
• Storyboard Template - Starter template for creating your own storyboards

---

Detailed Documentation

This documentation provides comprehensive information about using the Ponder in-game tutorial system for Garry's Mod. Ponder allows you to create interactive, animated tutorials to explain game mechanics, addons, or any other concept.

Key Concepts

Ponder is built around several key concepts:

• Storyboard: The main container for a tutorial
• Chapter: A section of a storyboard containing a sequence of instructions
• Instruction: An individual action like placing a model, showing text, or moving the camera
• Environment: The 3D space where the tutorial takes place
• Playback: Controls the playback of a storyboard

Getting Started

If you're new to Ponder, we recommend following these steps:

1. Read the Ponder Wiki to understand the core concepts
2. Review the Example Storyboard to see how everything fits together
3. Use the Quick Reference Guide as a handy reference while coding
4. Start creating your own storyboard using the Storyboard Template

Creating Your First Storyboard

To create a basic storyboard:

1. Copy the Storyboard Template to a new file in your addon's lua/ponder/storyboards_cl/ directory
2. Customize the storyboard properties (name, description, icon)
3. Add your own instructions to each chapter
4. Test your storyboard in-game

Tips for Effective Tutorials

1. Plan your storyboard before coding
2. Keep chapters focused on one concept or step
3. Use appropriate timing to allow users to read and understand
4. Add descriptive text to guide the user through each step
5. Test frequently to ensure smooth animations and correct timing

Need Help?

If you encounter issues or have questions:

1. Check the Troubleshooting section in the wiki
2. Review the example files for reference implementations
3. Examine the Ponder source code for deeper understanding

Contributing

If you find errors in this documentation or have suggestions for improvements, please let us know!