Documentation

RustMC docs

Run a server, configure it, and change what it does with plugins. The server guides and the plugin API reference come straight from the RustMC repository, at bbd81209ad.

Start

• Quick start

Running a server

• rustmc.yml
• World generation
• Bedrock players
• Network
• The web map
• The web portal
• Backups
• Maintenance mode
• Anti-xray
• The resource-pack host
• The MCP endpoint
• Restarting the server when a plugin asks
• Fake players

Plugin API

• rustmc plugin API

Guides

• Getting started
• Your first Rust plugin
• Your first WebAssembly plugin
• A plugin's own creatures
• Recipes

Concepts

• Events
• Hooks
• Data
• Guarantees

Reference

• Manifest
• Event reference
• The guest SDK, rustmc-guest

Hook points

• Hook point reference
• Commands
• Packets
• Game events as hook points
• Subsystem hook points
• Every hook point

Host calls

• Host calls
• Blocks
• The plugin bus
• Plugin creatures
• Entities and display entities
• Inventory, items and components
• Web map and chunk pre-generation
• Menus (GUI)
• Outbound HTTP and plugin ports
• Packets and plugin channels
• Resource packs
• Player state
• Players
• Recipes
• Schematics
• The server
• The server network
• Settings and disabled systems
• Storage
• Tab list, nametags, sidebar, boss bars and scores
• Chat and text
• Worlds, time, border, game rules, sound and particles

WebAssembly

• The WebAssembly ABI
• Limits

Contributing

• Adding a hook point
• How the API is proven