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 (currently 0.4.2, or git master) and
  13 Guile 2.2.  Install those.
  14
  15 ... Or, if you have Guix, you can set up a "guix environment" which
  16 should have everything you need all set to go:
  17
  18   guix environment -l guix.scm   # optionally add --pure
  19
  20 Next, in mudsync's directory:
  21
  22   source pre-inst-env
  23   guile -l worlds/bricabrac.scm -e run-game
  24
  25 You can then connect in your browser:
  26
  27   http://localhost:8888
  28
  29
  30 ** Playing
  31
  32 Well, try some things!  Assuming you're starting with the bricabrac
  33 world, try "ring the bell", and that should give you some information
  34 to get started.
  35
  36
  37 ** Hacking
  38
  39 When you start up the bricabrac demo, it'll by default start up a
  40 socket you can connect to with emacs + geiser like:
  41
  42 : M-x geiser-connect-local <RET>
  43 :   guile <RET>
  44 :   /tmp/8sync-socket <RET>
  45
  46 Then you can live hack away!
  47
  48 If you change something in bricabrac (or whatever) and want to update
  49 the object you changed, you can "live" put in the new and updated
  50 version from the game-spec at the REPL with:
  51
  52   (inject-gameobj! (game-spec) 'room:lobby)  ; to replace the lobby, but of course
  53                                              ; do what's appropriate for your
  54                                              ; object
  55
  56 That's it for now!