README.org

   1 * Mudsync
   2
   3 Mudsync!  What a game.  Or is it?
   4
   5 Well it's not really a game, more of a MUD framework.  It does contain
   6 a couple of small demo worlds.  The more interesting of them is the
   7 "bricabrac" world.  I assume you want to play with it, but I guess
   8 we're getting ahead of ourselves.
   9
  10 ** Installing Mudsync
  11
  12 First of all, you need 8sync from git master (or 8sync 0.2.0, which
  13 isn't out yet).  Yikes!  That's pretty new.  Luckily, you can get a
  14 tarball here:
  15
  16   http://dustycloud.org/misc/8sync-0.2.0-pre.tar.gz
  17
  18 Do the usual "./configure && make && sudo make install" there.
  19
  20 Next, in mudsync's directory:
  21
  22   source pre-install-env
  23   guile -l worlds/bricabrac.scm -e run-game
  24
  25 You can then connect:
  26
  27   telnet 127.0.0.1 8889
  28
  29 ** Playing
  30
  31 Well, try some things!  Assuming you're starting with the bricabrac
  32 world, try "ring the bell", and that should give you some information
  33 to get started.
  34
  35
  36 ** Hacking
  37
  38 When you start up the bricabrac demo, it'll by default start up a
  39 port you can connect over localhost to if you're using emacs + geiser.
  40 Then you can live hack away!
  41
  42 If you change something in bricabrac (or whatever) and want to update
  43 the object you changed, you can "live" put in the new and updated
  44 version from the game-spec at the REPL with:
  45
  46   (insert! game-spec 'room:lobby)  ; to replace the lobby, but of course
  47                                    ; do what's appropriate for your
  48                                    ; object
  49
  50 That's it for now!