Skip to content

Commit

Permalink
Address feedback - part 1
Browse files Browse the repository at this point in the history
  • Loading branch information
chrzrdx committed Sep 22, 2024
1 parent 218f8f6 commit 904fb22
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@

# REOSERV

The Rust-powered server emulator for [Endless Online](https://game.eoserv.net/) 🦀
The Rust-powered server emulator for [Endless Online](https://endless-online.com) 🦀

## Prerequisites

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

- [Rust](https://www.rust-lang.org/)
- [Cargo](https://doc.rust-lang.org/cargo/appendix/glossary.html#cargo)
- [Docker](https://docs.docker.com/engine/install/)

I recommend using [rustup](https://rustup.rs/) to install Rust and Cargo.

Expand All @@ -30,7 +29,13 @@ cargo build --release

## Database setup and Configuration

1. Create a `.env` file at the root of the repository using `.env.example` as a template. Replace `CHANGEME` with your own secure passwords, leaving other configuration options as is:
1. If you don't already have a MySQL database set up, you can use our Docker Compose configuration to spin up a local instance. To do this, run:
```sh
docker compose up
```
This will start a local MySQL database with the configuration specified in the `.env` file.

2. Create a `.env` file at the root of the repository using `.env.example` as a template. Replace `CHANGEME` with your own secure passwords, leaving other configuration options as is:

```ini
# database settings
Expand All @@ -41,13 +46,7 @@ MYSQL_DATABASE="reoserv"
TZ="UTC"

# misc
RUST_DEBUG="debug" # or "trace" for more detailed output
```

2. Start the container:

```sh
docker compose up
RUST_DEBUG="info" # or "trace" for more detailed output
```

3. Edit the server configuration in `config/Config.toml` or a copy of it (`config/Config.local.toml`). Edit the database connection settings to match the `MYSQL_PASSWORD` in the `.env` file.
Expand All @@ -67,6 +66,12 @@ The logging level can be adjusted by changing the `RUST_LOG` variable in the `.e

## Setup quests, NPCs and items for your server

See [our documentation](https://reoserv.net/docs) for instructions on how to setup quests, NPCs, items and more for your server.

- [Classes, Items, Spells, NPCs](https://reoserv.net/docs/pubs)
- [Maps](https://reoserv.net/docs/maps)
- [Quests](https://reoserv.net/docs/quests)

## Setup the Endless Online client

See `eo-client/README.md` for instructions

0 comments on commit 904fb22

Please sign in to comment.