update README
Iris Lightshard nilix@nilfm.cc
PGP Signature
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEkFh6dA+k/6CXFXU4O3+8IhROY5gFAmFqc+EACgkQO3+8IhRO Y5i8Mw/+PvUKH4sRMVS+t85TKTCUus6JXArb9OSprr0VE3fN9mE9bhaDJKz/RWiy QylRoNutQ770fk6Auu5+vdXbMP58YvXuqM6c9aLd3g92KUN9iUtdrqk2HZ+UZyEM fkaHEnhIrJ9GdiUZIgtsDjASV9PI4yWAdjvy9tGfASq4ejYt7m8KPL8tgUF9lybB 9+4WtWqpIrf+nt+f3dQra91pNuz8QszIeJZyF2mo0IY7NhwcU1hV5wixf0km1Nra qL/yBsEwBnGCVKXAo9xHOfNvzmZ9Dr8CoGJSoLssvZo/ij52d/MS6hs+6UnK3a6v U6Zw3JPff/FzVN4OVA2RCzZithqUa0PzRcleXpo2BBDnLw4Vz4fbNeA8E7lOFsq4 G2U/KdQMuNSg1LGyNZlDmuM8qCneiy1u9Vyprrnuz1vY7n4DtxJH+pxkCdKlA4Aw BQnpTPKbhCIvs35LLmd8HvABJoy8q3JZi6RU/GelBapecK01p9N7wkydmUkeLOkW SFgMD1h5FiBNCvG8roH4hIYwOcLbIuINKSJuLskJxWpofyQ8FRO1C9daIZNrLYsY 4BsYvp0CVDskXJK2ZXXyZCN0wcVAvUOc42TCyDNvV7ojTWtDv0sK12XjtvYOQXDU YHDUOV4kkchSta0q6xdYDqOhanjlvbO8HwtQISKeOHnarcGK5vY= =FNfp -----END PGP SIGNATURE-----
1 files changed,
9 insertions(+),
3 deletions(-)
jump to
M
README.md
→
README.md
@@ -2,7 +2,7 @@ # xrxs
`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 @@ * `DATA_DIR`: the path to the root of the cartridge and realm storage; can be absolute or relative to the `xrxs` executable, but must have the trailing `/`
## 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. + +### 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 repository root should build the `xrxs` executable. +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 @@ ```
./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.