shapez 2 Modding Docs
An unofficial, community reference for modding shapez 2 with the ShapezShifter API.
This site has two halves:
- Guide — hand-written pages that explain how the game is put together: the mod lifecycle, the map model, coordinate systems, simulations and item lanes, rendering, and how to hook into any of it.
- API Reference — a generated, searchable index of every public type and
member in the modding-relevant game assemblies plus
ShapezShifter.
Start here
| If you want to… | Read |
|---|---|
| Get a project building at all | Getting Started |
| Understand which assembly owns what | Architecture |
| Know when your code runs | Mod Lifecycle |
| Walk islands, buildings, and their state | The Map Model |
Stop guessing what _G and _I mean |
Coordinate Systems |
| Read what a machine is actually doing | Simulations and Item Lanes |
| Work out what crosses a platform's boundary | Ports and Notches |
| Draw something in the world | Rendering |
| Change behaviour the API doesn't expose | Hooking the Game |
About the API reference
The reference is generated with DocFX directly from the shipped game assemblies. The game ships no XML documentation comments, so the reference gives you accurate signatures, inheritance, and implementors — but no prose. That prose is what the Guide is for.
Note
This is a community effort and is not affiliated with tobspr Games. The official documentation lives in Notion; these pages aim to complement it, not replace it.