X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=README;h=18db5e22c21780480dfda59153d5cee624f0c9a8;hb=refs%2Fheads%2F7drl;hp=14115722c4043bd46756d976a8c4694266b413ce;hpb=436d36515ec10f31ab89e6867f59023177f560a2;p=plomrogue diff --git a/README b/README index 1411572..18db5e2 100644 --- a/README +++ b/README @@ -4,8 +4,20 @@ Description ----------- -See -and . +You're stranded on an island. +To leave, you must please the God that rules it. +This God sees the island's animals and plants as its children. +So mere hacking and slashing through the wildlife won't do … + +See also: + + + + + + + + System requirements / installation / running the game ----------------------------------------------------- @@ -56,21 +68,34 @@ p - pick up item D - drop item selected in inventory u - use item selected in inventory -UP - navigate upwards in Inventory -DOWN - navigate downwards in inventory +Up - navigate upwards in inventory +Down - navigate downwards in inventory + +PgUp - scroll upwards in "Things here" window +PgDn - scroll downwards in "Things here" window -Replay game recording ---------------------- +Save files, replay game recording, starting over +------------------------------------------------ -Once you start a new world, every move of yours is recorded in a file called -"record_save". It gets overwritten when a new game world is started after -deletion of the "save" file. Run "./roguelike -s" to watch the current game's -recording from the beginning. Hit any player action key to increment turns (they -will not trigger the actions usually mapped to them, only repeat theactions -done at that point in the game as defined in the "record_save" file). Keys to -manage windows, scroll on the map and quit the program do their usual thing. -Append a number to the -s option (like "-s100") to start the recording at the -respective turn number. +Short version: To start over, quit ./roguelike, delete the files "save" (it's +also a good idea to delete the file "record_save"), and re-start ./roguelike. + +By default, the game state is saved in the file ./save, and read from there on +(server) restart. Another file name to use can be given with the -l option (i.e. +start the game with "./roguelike -l alternate_savefile"). To start over in a new +world, remove ./save, or use the -l option with the name of a file that does not +exist yet. + +Once you start a new world, every game action of yours is appended to a file +called "record_" plus the save file name. Run "./roguelike -s" to watch the +current game's recording from the beginning. Hit any player action key to +increment turns (they will not trigger the actions usually mapped to them, only +repeat the actions done at that point in the game as defined in the record +file). Keys to manage windows, scroll on the map and quit the program do their +usual thing. Append a number to the -s option (like "-s100") to start the +recording playback at the respective turn number. (Don't forget to delete / +empty a game's record file when deleting its save file, or different game's +moves will get mixed up in one record file.) Hacking / server internals and configuration -------------------------------------------- @@ -81,12 +106,14 @@ The game world is set up and made subject to player commands by (written to by ./roguelike-client), ./confserver/world, ./record_save and ./save. -All source files are thoroughly documented to explain more details of -plomrogue's internals. The ./roguelike-server executable can be run with a -v -option for 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 +All source files are thoroughly documented to explain more details of the +PlomRogue engine's internals. The ./roguelike-server executable can be run with +a -v option for 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. + +See ./README_engine for more stuff.