README.txt

   1 Bane's Befuddlement
   2 ===================
   3
   4 Entry in PyWeek #16  <http://www.pyweek.org/16/>
   5 URL: http://www.pyweek.org/e/erdslangetjie
   6 Team: erdslangetjie
   7 Members: Neil Muller (drnlm)
   8 License: ICS - see LICENSE.txt
   9
  10
  11 Requirements
  12 ------------
  13
  14 This was developed using pygame 1.9.1 and kivy 1.6.0.
  15
  16 Git repo: http://www.ctpug.org.za/gitweb/?p=erdslangetjie.git;a=summary
  17
  18 Installation notes
  19 ------------------
  20
  21 For Linux, I created a virtualenv and used pip install kivy to setup the latest
  22 kivy environment. Pygame installation didn't work for me using pip, so I used
  23 the system packages for that.
  24
  25 i.e.
  26
  27 $ virtualenv --system-site-packages ve
  28 $ . ve/bin/activate
  29 $ pip install -r requirements.txt  # to install kivy and cython
  30
  31 Running the Game
  32 ----------------
  33
  34 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
  35
  36 Othewise open a terminal / console and "cd" to the game directory and run:
  37
  38   python run_game.py
  39
  40
  41 Game blurb
  42 ----------
  43
  44 Yet again. that annoying superhero has found and destroyed your secret lair.
  45
  46 This time, you were prepared. Your trusty servant, Igor, has laid out a cunning
  47 maze leading to a secret underwater submarine that will allow you to flee
  48 without being caught.
  49
  50 Of course, it would have been better if Igor had managed to get the map to you
  51 before things got compilcated, but the lack of a map is but a minor setback.
  52
  53
  54 How to Play the Game
  55 --------------------
  56
  57 Navigate to the map exit before your nemesis catches up with you.
  58
  59 Move using the cursor keys, WASD or by dragging the player sprite with the mouse.
  60
  61 You always start each maze with a small lead, and can use gates to delay your
  62 pursuer. Your pursuer is relentless, though, so don't take too long deciding
  63 what to do.
  64
  65 Options
  66 ------
  67
  68 You can access the settings panel by pressing F1
  69
  70 Note that changing the start level only takes effect on the next run, since we
  71 don't reload the config when that changes.
  72
  73
  74 Development notes
  75 -----------------
  76
  77 Creating a source distribution with::
  78
  79    python setup.py sdist
  80
  81 You may also generate Windows executables and OS X applications::
  82
  83    python setup.py py2exe
  84    python setup.py py2app
  85
  86 Upload files to PyWeek with::
  87
  88    python pyweek_upload.py
  89
  90 Upload to the Python Package Index with::
  91
  92    python setup.py register
  93    python setup.py sdist upload
  94