Documentation/index.txt

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