PuzzleSpring Documentation
Work in Progress This documentation is currently under active development. Some sections may be incomplete or subject to change.
Welcome to the PuzzleSpring documentation. PuzzleSpring is a Django-based puzzle hunt hosting platform for organizing competitive puzzle-solving competitions with team collaboration, real-time updates, and automated answer checking.
Get Started
Installing PuzzleSpring
Set up the server and configure your instance.
Perfect for server administrators who need to deploy and configure PuzzleSpring.
Creating Your First Hunt
Build puzzles, configure unlocking rules, and prepare content.
Perfect for hunt organizers who need to set up puzzles and configure hunt mechanics.
Running a Live Hunt
Manage teams, respond to hints, and monitor progress.
Perfect for hunt staff who need to manage teams and respond to participants during a hunt.
Participating in a Hunt
Set up notifications and get the most out of your hunt experience.
Perfect for participants who want to customize their experience and stay informed during a hunt.
Additional Resources
Customization
Customize templates, add custom files, and create info pages.
Reference
Technical documentation for developers including data models and API endpoints.
Contributing
Guidelines for contributing to PuzzleSpring.
FAQ
Frequently asked questions.