Documentation/index.txt

   1 GalTacK
   2 =======
   3 Felix Rabe <public@felixrabe.textdriven.com>
   4
   5 GalTacK is an unofficial http://www.pygtk.org/[PyGTK] client to the
   6 http://www.imitationpickles.com/galcon/[Galcon]
   7 multiplayer game.  (It was formerly called 'GtkGalcon' and renamed upon the
   8 friendly request of Phil Hassey, the developer of Galcon.)  It is fully
   9 compatible with Galcon.
  10
  11 Right now, GalTacK can be used for basic chatting, but already contains
  12 some code to draw the GalTacK universe.  Check out the <<Screenshots>> at
  13 the end of this page.
  14
  15 *Quick Links:*
  16 http://repo.or.cz/w/galtack.git[Source Code]
  17 | http://lists.felixrabe.textdriven.com/mailman/listinfo/galcon-fanclub[Mailing List]
  18 | link:irc://irc.freenode.net/#galcon[IRC Channel (irc.freenode.net #galcon)]
  19 | http://galbot.zevv.nl/index.php/Main_Page[Galbot]
  20 | http://felixrabe.textdriven.com/pygtk-shell/[PyGTK Shell]
  21
  22 Download
  23 --------
  24
  25 For users:
  26
  27 - Install the dependencies (see below).
  28 - Go to the http://repo.or.cz/w/galtack.git[gitweb] and click on the
  29   "snapshot" link on the right side of the row that contains the yellow
  30   "usable" tag to download a .tar.gz archive.
  31 - Extract the archive.
  32 - Optionally run `python setup.py install` to install GalTacK.  (The
  33     "usable" tag does not guarantee that GalTacK is installable this
  34     way.)
  35 - Run `galtack_client.py`.
  36
  37 For developers:
  38
  39 - First follow the user instructions above and make sure you can run
  40     GalTacK.
  41 - Join the http://lists.felixrabe.textdriven.com/mailman/listinfo/galcon-fanclub[mailing list].
  42 - `git-clone ssh://mob@repo.or.cz/srv/git/galtack`
  43 - Develop on the `mob` branch: `git-checkout -b mob origin/mob`.
  44 - `git-push origin` at will.
  45 - If you would like to have non-mob write access to the repository,
  46     register with http://repo.or.cz/[] and contact me.
  47
  48 Galbot
  49 ------
  50
  51 The core Python module of GalTacK ("galtack") has its origins at the
  52 http://galbot.zevv.nl/index.php/Main_Page[Galbot] project.  The plan is to
  53 merge this module back into Galbot one day (or make it independent of
  54 either project).
  55
  56 Dependencies
  57 ------------
  58
  59 * http://felixrabe.textdriven.com/pygtk-shell/[PyGTK Shell]
  60     (unreleased version from the
  61     http://repo.or.cz/w/pygtk-shell.git[repository]) and its dependencies
  62     (Python 2.5, PyGTK 2.10)
  63 * http://www.twistedmatrix.com/[Twisted] 2.5.0
  64 * You will need to connect to an official Galcon server, so this is also
  65     kind of a "dependency" - there are servers available though.
  66
  67 To do / known issues
  68 --------------------
  69
  70 * Many features have not been implemented yet.
  71 * Unify mixin class naming to `GaltackClientDoActionMixin`.
  72
  73 About version 1.0
  74 -----------------
  75
  76 * This will mark the point where GalTacK is sufficiently usable to play
  77   Galcon without a Galcon client.
  78 * This will mark the point where I (Felix Rabe) draw back from the project
  79   and (hopefully) hand it off to someone interested in continuing it.
  80 * I hope to release it in the next few days or weeks.
  81
  82 Related links
  83 -------------
  84
  85 - http://www.methods.co.nz/asciidoc/[AsciiDoc]
  86 - http://git.or.cz/[Git]
  87 - http://repo.or.cz/[Git repository hosting for free]
  88 - http://subversion.tigris.org/[Subversion]
  89 - http://twistedmatrix.com/trac/[Twisted]
  90 - http://www.wireshark.org/[Wireshark]
  91
  92 [[Screenshots]]
  93 Screenshots
  94 -----------
  95
  96 NOTE: If you ever use the nick 'felixrabe' using the information from those
  97       screenshots (by means of hijacking), you will be kicked, as that nick
  98       is not in use any longer.
  99
 100 image:galtack-0.2.0-screenshot-01-thumb.jpg["GalTacK 0.2",link="galtack-0.2.0-screenshot-01.png"]
 101 image:gtk-galcon-0.0.7-screenshot-01.jpg["GtkGalcon 0.0.7"]
 102 image:gtk-galcon-0.0.6-screenshot-01.png["GtkGalcon 0.0.6"]
 103 image:gtk-galcon-0.0.4-screenshot-01.png["GtkGalcon 0.0.4"]
 104