The Rust-powered server emulator for Endless Online 🦀

Prerequisites

Before building the server, ensure you have the following installed:

• Rust
• Cargo

I recommend using rustup to install Rust and Cargo.

Building

To build the server, simply run:

cargo build

For a release build, use:

cargo build --release

Note

Set up and configure your database before starting the server. You can use either MySQL/MariaDB or SQLite. Edit config/Config.toml to match your production database before creating a release build.

Database setup and configuration

Reoserv supports both MySQL/MariaDB and SQLite.

1. Choose a database driver in config/Config.toml (or config/Config.local.toml):

   • driver = "mysql" for MySQL/MariaDB
   • driver = "sqlite" for SQLite

2. Configure database connection settings:

   • For MySQL/MariaDB, set host, port, name, username, and password.
   • For SQLite, set name (the server will use <name>.db in the working directory).

3. Install the database schema:

   ./reoserv --install

Warning

If you are upgrading from an older schema version, run migrations before starting the server:

./reoserv --migrate

Back up your database first. This is especially important if your schema still uses legacy tables such as Bank instead of character_bank.

4. If you choose MySQL/MariaDB and are using the provided Compose setup, start only the database service with:

   docker compose up -d db

Docker Compose (Reoserv + MariaDB)

The provided compose.yml starts both services:

• db: MariaDB database
• reoserv: Reoserv server container

Before starting, make sure your config/Config.toml (or mounted config/Config.local.toml) uses:

• driver = "mysql"
• host = "db"
• port = "3306"
• Matching name, username, and password values

Build/start the stack:

docker compose up -d --build

Install schema in the container:

docker compose run --rm reoserv ./reoserv --install

For upgrades, run migrations in the container:

docker compose run --rm reoserv ./reoserv --migrate

Start the server

To run the server, use:

cargo run

Setup quests, NPCs and items for your server

See our documentation for instructions on how to setup quests, NPCs, items and more for your server.

• Classes, Items, Spells, NPCs
• Maps
• Quests

Setup the Endless Online client

See eo-client/README.md for instructions