> 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="/pages/tVSgTu1dWbSUHTdKl63V">/pages/tVSgTu1dWbSUHTdKl63V</a></td></tr><tr><td>📖 <strong>PUCK API</strong></td><td><a href="/pages/TqnaN0nWlk5W6f3Ht3dq">/pages/TqnaN0nWlk5W6f3Ht3dq</a></td></tr><tr><td>🚀 <strong>PUBLISHING</strong></td><td><a href="/pages/QX9krmzRURMqmnAJufN6">/pages/QX9krmzRURMqmnAJufN6</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="/files/Zovbw46ahPEIkT9udPUW">/files/Zovbw46ahPEIkT9udPUW</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="/files/B2gNfy3fyO1ua91I8H5U">/files/B2gNfy3fyO1ua91I8H5U</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="/files/QtELO3UiMIvQmWlftavR">/files/QtELO3UiMIvQmWlftavR</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 %}