Buying a Unity tool shouldn’t feel like opening a mystery box.
A feature list can tell you what a package claims to do. A trailer can show the happy path. Neither tells you what the public interfaces look like, how the pieces relate, or how much work you’ll have to do to fit the package into an existing project.
So we’re making the GGG API reference publicly browsable before purchase.
The documentation is part of the product
We’ve reworked the Developer Tools area of our website to bring the asset catalog and API documentation together.
The reference is organized around how C# developers actually navigate an API:
- Package — start with Inventory or Equipment.
- Namespace — narrow down to the relevant part of the code.
- Type — inspect classes, interfaces, and the members they expose.
No scavenger hunt through unrelated development notes. No release machinery getting dumped onto a public page. Just the contracts you came to inspect.
Written beside the code, not copied into a second universe
The reference starts with XML documentation comments on the public C# APIs. DocFX extracts that information and produces Markdown, which our Hugo website turns into documentation pages.
Why do it this way? Because we don’t want to hand-edit one description in the source, another on the website, and a third in some forgotten README until all three disagree.
We’ve also built a release-aware process: an approved package gets an immutable Git tag, while documentation corrections can be made independently. Automated checks reject implementation changes in a documentation-only revision. That lets us clarify an explanation without pretending customers received new code.
What it doesn’t do
An API reference is not a getting-started tutorial. It won’t replace sample scenes, examples, or video walkthroughs, and it can’t promise that a package fits every architecture on earth.
We’ll continue adding guides and demonstrations. The reference simply gives you a useful place to start—and a way to check our work.
What’s next
Inventory and Equipment are our first approved modules. As the GGG toolkit grows, each released package should get the same treatment: clear public contracts, discoverable documentation, and examples that show how the pieces work in an actual game.
Take a look at the API reference. If something is confusing, that’s useful feedback. We’d rather improve the docs than make you reverse-engineer our intentions.
The code can keep its secrets where it matters. The public API shouldn’t have to.
— Guts Glory Games