Tweak README.md and add instructions to setup the EO client #173
Conversation
chrzrdx
force-pushed
the
housekeeping
branch
from
011bc26
to
218f8f6
Compare
chrzrdx
changed the title
README.md
Outdated
| @@ -2,51 +2,71 @@ | |||
|
|
|||
| # REOSERV | |||
|
|
|||
| The rust powered [Endless Online](https://game.eoserv.net/) server emulator! | |||
| The Rust-powered server emulator for [Endless Online](https://game.eoserv.net/) 🦀 | |||
There was a problem hiding this comment.
I should have fixed this a while ago but can you change the URL here to https://endless-online.com
README.md
Outdated
| To build the server simply run | ||
| - [Rust](https://www.rust-lang.org/) | ||
| - [Cargo](https://doc.rust-lang.org/cargo/appendix/glossary.html#cargo) | ||
| - [Docker](https://docs.docker.com/engine/install/) |
There was a problem hiding this comment.
Docker isn't required for building the server. Just recommended for running in dev environments
README.md
Outdated
|
|
||
| You can run the server with | ||
| - `debug`: This will print human-readable data structures for every packet. |
There was a problem hiding this comment.
This is no longer true, I removed the debug packet printing a while back :P
I'm pretty sure trace will print raw byte arrays though
There was a problem hiding this comment.
So, should we remove the RUST_LOG flag completely (as a configuration option for the user)?
There was a problem hiding this comment.
I guess it doesn't need to be exposed no
README.md
Outdated
|
|
||
| `cargo run` | ||
| ## Setup quests, NPCs and items for your server |
There was a problem hiding this comment.
We can add a link to the docs here
See [docs](https://reoserv.net/docs/pubs) for help
|
@sorokya We can also consider moving eo-client to its own repository, and link to that in the docs (or in CONTRIBUTING.md) |
chrzrdx
force-pushed
the
housekeeping
branch
2 times, most recently
from
97ed8fd
to
c943997
Compare
- Clean up instructions in README.md - Add instructions to setup EO client - Replace compose.yml setup with a docker command in README.md to spin up MySQL when developing locally. This also removes the need to have an .env file altogether. We might bring .env back in a later iteration if we didn't want to check in changes to the database connection settings in Config.toml.
chrzrdx
force-pushed
the
housekeeping
branch
from
c943997
to
55669ac
Compare
.envfile altogether. We might bring.envback in a later iteration if we didn't want to check in changes to the database connection settings in Config.toml.