diff --git a/README.md b/README.md index d95940e..59da809 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ `xrxs` is an experimental game server using the Plan 9 protocol `9p`. -The client is intended to be a specialized [uxn](https://wiki.xxiivv.com/site/uxn.html) ROM that can load other ROMs (possibly preserving its own code to maintain a common menu system or interface to `xrxs`). +The client is a specialized [uxn](https://wiki.xxiivv.com/site/uxn.html) ROM that can load other ROMs over the network via the `9p` service. ## design @@ -57,9 +57,12 @@ The realm should be synchronized to disc when realm membership, limit, or passwo ## build/run -`xrxs` is built/tested in a Linux environment with `plan9port` and the C standard library as the only dependencies. With minimal modifications it will probably run just as well on Plan9, *BSD, WSL, and MacOS. -Running `./build.sh` from the repository root should build the `xrxs` executable. +### server + +The `xrxs` server is built/tested in a Linux environment with `plan9port` and the C standard library as the only dependencies. With minimal modifications it will probably run just as well on Plan9, *BSD, WSL, and MacOS. + +Running `./build.sh` from the `server` directory should build the `xrxs` executable. You can run a local server (for testing, split-screen games, or single-player games) with: @@ -79,3 +82,6 @@ Similarly, you can stop the service with: ./xrxs-srv.sh stop ``` +### client + +From the `uxn-client` directory, run `./build.sh` to compile the ROM and `./uxn-xrxs.sh` to mount the `9p` service and run client. Both scripts assume you have `uxnasm` and `uxnemu` in your `PATH` respectively.