API reference¶
The public types of the three libraries you can reference from your own program. For the task-shaped walk-through, with code that compiles, see Embed nfty in your program; for the roll alone, Ticket and Menu API.
| Assembly | Types | What it is |
|---|---|---|
Nfty.Ticket |
49 | The roll, and nothing else. net10.0, no NuGet packages, no imaging library: reference this alone to decide what an asset is - recipe, variants, rolled color, DNA - on a server or in an engine. |
Nfty.Core |
183 | The whole engine: archives, validation, generation, rendering, Sets, export, sealing, statistics. Depends on Nfty.Ticket and ImageSharp. |
Nfty.Model |
31 | Rise: pixel art to 3D. Voxel meshes, glTF writing and reading. Depends on Nfty.Core. |
Namespaces are not assemblies¶
Nfty.Ticket.dll declares types in the namespaces Nfty.Ticket, Nfty.Core.Generation, Nfty.Core.Imaging and Nfty.Core.Model. That is deliberate: those types began life in Nfty.Core and keeping their names meant no consumer's using changed when the roll moved into its own dependency-free assembly. Each page names the assembly a type ships in, so you know which DLL to reference.
How these pages are made¶
From the /// comments in the source and the public surface of the built assemblies, by python tools/api-docs/build.py. They are not edited by hand; change the comment and regenerate. Members that are internal or private do not appear. A method page shows the declaration, then the documentation the author wrote.