From: Christopher Allan Webber Date: Tue, 10 May 2016 02:35:12 +0000 (-0500) Subject: Add a basic README file X-Git-Tag: fosdem-2017~143 X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=b90e7d077ce51959945e1ff1d4008fba9d2a7663;p=mudsync.git Add a basic README file --- diff --git a/worlds/README.org b/worlds/README.org new file mode 100644 index 0000000..42154c1 --- /dev/null +++ b/worlds/README.org @@ -0,0 +1,50 @@ +* Mudsync + +Mudsync! What a game. Or is it? + +Well it's not really a game, more of a MUD framework. It does contain +a couple of small demo worlds. The more interesting of them is the +"bricabrac" world. I assume you want to play with it, but I guess +we're getting ahead of ourselves. + +** Installing Mudsync + +First of all, you need 8sync from git master (or 8sync 0.2.0, which +isn't out yet). Yikes! That's pretty new. Luckily, you can get a +tarball here: + + http://dustycloud.org/misc/8sync-0.2.0-pre.tar.gz + +Do the usual "./configure && make && sudo make install" there. + +Next, in mudsync's directory: + + source pre-install-env + guile -l worlds/bricabrac.scm -e run-game + +You can then connect: + + telnet 127.0.0.1 8889 + +** Playing + +Well, try some things! Assuming you're starting with the bricabrac +world, try "ring the bell", and that should give you some information +to get started. + + +** Hacking + +When you start up the bricabrac demo, it'll by default start up a +port you can connect over localhost to if you're using emacs + geiser. +Then you can live hack away! + +If you change something in bricabrac (or whatever) and want to update +the object you changed, you can "live" put in the new and updated +version from the game-spec at the REPL with: + + (insert! game-spec 'room:lobby) ; to replace the lobby, but of course + ; do what's appropriate for your + ; object + +That's it for now!