Grimoire Documentation

Grimoire is a procedural content generation library for Windows x64 with a C-facing API.

This documentation is focused on practical integration guidance and curated API behavior details.

What You Will Find

• Setup instructions for consuming headers and binaries
• API guides for random and noise modules
• Function-level signatures, constraints, and behavior notes
• Practical recipes for terrain, clouds, and deterministic pipelines
• Roadmap and platform expansion priorities
• Notes on deterministic behavior and usage constraints
• Security and disclosure policy links

Suggested Reading Path

1. Start with Getting Started for integration and troubleshooting.
2. Read API Overview and Common Types to understand ABI and seed conventions.
3. Use Random API and Noise API for detailed behavior.
4. Use Quick Reference for signature lookups.
5. Use Recipes for real-world patterns.
6. Check Roadmap for planned platform milestones.

Project Status

Current release line: 1.0.x

For release history, see CHANGELOG.md in the repository root.