Player documentation now lives in the Farm Tablet Wiki. That is the single source of truth, kept in step with the current build. This folder keeps only the developer and API reference, which the wiki does not duplicate.
| I want to | Page |
|---|---|
| Install or update the mod | Installation |
| Learn the controls | Getting Started |
| See what every app does | The Apps |
| Move, resize, or reskin the tablet | Customising the Tablet |
| Change a setting or the open key | Settings |
| Use the developer console | Console Commands |
| Companion mod apps | Mod Integration Apps |
| Play on a server | Multiplayer |
| Fix a problem | Troubleshooting and FAQ |
These live in this folder because they are reference material, not player guides.
| Document | What is inside |
|---|---|
| developer/architecture.md | Module map, init sequence, rendering pipeline, multiplayer |
| developer/writing-an-app.md | Step by step guide to building a new app |
| developer/settings-system.md | The settings classes, XML types, adding new settings |
| developer/data-provider.md | Cache system, methods, return shapes, TTL |
| developer/renderer.md | Layer model, scoping rules, methods, colour palette |
| developer/eventbus.md | Events, the on/off/emit API, companion patterns |
| api/ | Public API for every class and method |
Note: the developer docs describe internal structure and can lag behind the code between refactors. When in doubt, the source in
src/is authoritative.