Skip to content

Latest commit

 

History

History
56 lines (49 loc) · 1.97 KB

File metadata and controls

56 lines (49 loc) · 1.97 KB

FS25 Farm Tablet — Documentation

Welcome to the Farm Tablet docs. Everything is split into four sections depending on who you are and what you need.


📂 Structure

docs/
├── general/            Player-facing guides — install, use, configure
│   ├── getting-started.md
│   ├── apps-reference.md
│   ├── settings-reference.md
│   ├── console-commands.md
│   ├── edit-mode.md
│   └── mod-integrations.md
│
├── developer/          How the mod works internally
│   ├── architecture.md
│   ├── writing-an-app.md
│   ├── settings-system.md
│   ├── data-provider.md
│   ├── renderer.md
│   └── eventbus.md
│
├── api/                Complete public API reference
│   ├── FarmTabletManager.md
│   ├── FarmTabletSystem.md
│   ├── FarmTabletUI.md
│   ├── AppRegistry.md
│   ├── DataProvider.md
│   ├── Renderer.md
│   ├── EventBus.md
│   └── Constants.md
│
└── faq/
    └── faq.md          Common questions from users and developers

🧭 Where to start

I want to… Go to
Install the mod and start playing general/getting-started.md
See what every app does general/apps-reference.md
Change settings / keybind general/settings-reference.md
Use console commands general/console-commands.md
Drag and resize the tablet general/edit-mode.md
Use with Income/Tax/NPC mods general/mod-integrations.md
Understand how the mod works developer/architecture.md
Build a new app developer/writing-an-app.md
Look up a specific method api/
Get answers fast faq/faq.md