Installation¶

This guide walks you through setting up your development environment for creating Lands.io mods.

Install the SDK¶

pnpm add @lands.io/mod-sdk

Project Setup¶

Create a new mod project with the following structure:

my-mod/
├── manifest.json       # Mod metadata
├── gameplay.ts         # Main mod file (exports default class)
├── config.ts           # Optional: Game config overrides
├── executions/         # Custom executions
├── ui/                 # UI components (buttons)
└── utils/              # Shared utilities

Manifest File¶

Every mod needs a manifest.json:

{
  "id": "my-awesome-mod",
  "name": "My Awesome Mod",
  "version": "1.0.0",
  "description": "A custom game mode for Lands.io",
  "author": "Your Name",
  "entry": "gameplay.ts"
}

Next Steps¶

Now that you have the SDK installed, continue to the Quick Start guide.