X-Git-Url: https://plomlompom.com/repos/?p=plomrogue;a=blobdiff_plain;f=README;h=b0daed45df39fab4b6c0891de95fd1d7aa8e1f96;hp=5759ccd5ebcbd5d21c62c1225bc5582f59ca1a82;hb=81f8bee1a21642c56b1fead9ba79afdad0c8b451;hpb=a50806df8116a81729220bd79870639b18da9d8c diff --git a/README b/README index 5759ccd..b0daed4 100644 --- a/README +++ b/README @@ -35,9 +35,8 @@ To build it, this is furthermore necessary: - gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX - libc library headers (libc6-dev?) -To build and start, do the following steps: +To build and start, just run: -$ ./build.sh $ ./roguelike ./roguelike is a shell script that executes a union of ./roguelike-server and @@ -70,16 +69,16 @@ Hacking / server internals and configuration The game world is set up and made subject to player commands by ./roguelike-server. It's controlled by commands explained in the file -./SERVER_COMMANDS. The server usually reads these from the files ./server/in +./SERVER_COMMANDS. The server usually reads these from the files ./server_run/in (written to by ./roguelike-client), ./confserver/world, ./record_save and ./save. The ./roguelike-server executable can be run with a -v option for possibly helpful debugging info (mostly: what messages the client sends to the server). -Server and client communicate via files in the ./server/ directory (generated -when the server is first run). The ./server/in file is read by the server for -newline-delimited commands. The ./server/out file contains server messages to be -read by clients. The ./server/worldstate file contains a serialized -representation of the game world's data as it is to be visible to the player / -the player's client. +Server and client communicate via files in the ./server_run/ directory +(generated when the server is first run). The ./server_run/in file is read by +the server for newline-delimited commands. The ./server_run/out file contains +server messages to be read by clients. The ./server/worldstate file contains a +serialized representation of the game world's data as it is to be visible to the +player / the player's client.