nilix/xrxs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
Iris Lightshard 2021-10-16 00:40:33 -06:00
parent d3a0940612
commit 292e3c25eb
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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.