> For the complete documentation index, see [llms.txt](https://puck.gitbook.io/modding/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://puck.gitbook.io/modding/readme.md).

# Welcome!

This page serves as a general guide on how to start with Puck mod development, how to reference the Puck API and how to finally publish your mod to the Steam Workshop.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>🏃 <strong>GETTING STARTED</strong></td><td><a href="/modding/getting-started/development-environment-setup.md">GETTING STARTED</a></td></tr><tr><td>📖 <strong>PUCK API</strong></td><td><a href="/modding/puck-api/singletons.md">Puck API</a></td></tr><tr><td>🚀 <strong>PUBLISHING</strong></td><td><a href="/modding/publishing/publishing-to-steam-workshop.md">PUBLISHING</a></td></tr></tbody></table>

## Showcase

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Toaster's Crispy Shadows</td><td><a href="https://github.com/ckhawks/ToasterCrispyShadows">https://github.com/ckhawks/ToasterCrispyShadows</a></td><td><a href="https://2911841908-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8ZDIsNKdEz0IT73wepog%2Fuploads%2Fcc0ABDW9KXPQCCN4FwhQ%2Fimage.png?alt=media&amp;token=d5bcd3e7-72df-482c-a68b-bd8a165c7425">image.png</a></td><td><a href="https://steamcommunity.com/sharedfiles/filedetails/?id=3493628417">https://steamcommunity.com/sharedfiles/filedetails/?id=3493628417</a></td></tr><tr><td>GAFURIX' Developer Console</td><td><a href="https://github.com/NAsejevs/GAFURIXDeveloperConsole">https://github.com/NAsejevs/GAFURIXDeveloperConsole</a></td><td><a href="https://2911841908-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8ZDIsNKdEz0IT73wepog%2Fuploads%2FW3jSEEw1aUUPEqscBmC0%2Fimage.png?alt=media&amp;token=7d90ddb7-1b93-4b74-b5a1-2517857f1d56">image.png</a></td><td><a href="https://steamcommunity.com/sharedfiles/filedetails/?id=3493426437">https://steamcommunity.com/sharedfiles/filedetails/?id=3493426437</a></td></tr><tr><td>Toaster's Puck FX</td><td><a href="https://github.com/ckhawks/ToasterPuckFX">https://github.com/ckhawks/ToasterPuckFX</a></td><td><a href="https://2911841908-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8ZDIsNKdEz0IT73wepog%2Fuploads%2F1d0Z7JwmCNo5RSeXHFqM%2Fimage.png?alt=media&amp;token=7158efdd-8749-42da-a4d0-4639e8532eef">image.png</a></td><td><a href="https://steamcommunity.com/sharedfiles/filedetails/?id=3493915291">https://steamcommunity.com/sharedfiles/filedetails/?id=3493915291</a></td></tr></tbody></table>

{% hint style="info" %}
If you're looking to showcase your mod on this page and believe it brings value to people learning the craft, feel free to DM me on [Discord](https://discord.gg/p6AS4CY9Ux) with your submission!
{% endhint %}