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    Linux
  22    -----
  23
  24    For Linux, I created a virtualenv and used pip install kivy to setup the
  25    latest kivy environment. Pygame installation didn't work for me using pip,
  26    so I used the system packages for that.
  27
  28    i.e.
  29
  30    $ virtualenv --system-site-packages ve
  31    $ . ve/bin/activate
  32    $ pip install -r requirements.txt  # to install kivy and cython
  33
  34    Windows
  35    -------
  36
  37    The windows zipfile is a stripped down version of the kivy windows
  38    portable distribution - http://kivy.googlecode.com/files/Kivy-1.6.0-w32.zip.
  39
  40    Unzip it and run the included bane_pyweek_16.bat file to run the game.
  41
  42    Tested on a windows 7 virtula machine.
  43
  44
  45    Android Notes
  46    -------------
  47
  48    The zip file works with the kivy launcher -
  49    http://kivy.googlecode.com/files/KivyLauncher-1.6.0.0.apk . Download the
  50    file to /mnt/sdcard/kivy, unzip it to it's own directory and then run the
  51    kivy launcher. It should list the game as an option to run.
  52
  53    I unfortunately didn't get find the time to look supporting detecting device
  54    rotation or building an apk.
  55
  56    The android zipfile doesn't include the editor, since I never tested that
  57    on android.
  58
  59 Running the Game
  60 ----------------
  61
  62 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
  63
  64 Othewise open a terminal / console and "cd" to the game directory and run:
  65
  66   python run_game.py
  67
  68
  69 Game blurb
  70 ----------
  71
  72 Yet again. that annoying superhero has found and destroyed your secret lair.
  73
  74 This time, you were prepared. Your trusty servant, Igor, has laid out a cunning
  75 maze leading to a secret underwater submarine that will allow you to flee
  76 without being caught.
  77
  78 Of course, it would have been better if Igor had managed to get the map to you
  79 before things got compilcated, but the lack of a map is but a minor setback.
  80
  81
  82 How to Play the Game
  83 --------------------
  84
  85 Navigate to the map exit before your nemesis catches up with you.
  86
  87 Move using the cursor keys, WASD or by dragging the player sprite with the mouse.
  88
  89 You always start each maze with a small lead, and can use gates to delay your
  90 pursuer. Your pursuer is relentless, though, so don't take too long deciding
  91 what to do.
  92
  93 Options
  94 ------
  95
  96 You can access the settings panel by pressing F1
  97
  98 Note that changing the start level only takes effect on the next run, since we
  99 don't reload the config when that changes.
 100
 101
 102 Development notes
 103 -----------------
 104
 105 Creating a source distribution with::
 106
 107    python setup.py sdist
 108
 109 You may also generate Windows executables and OS X applications::
 110
 111    python setup.py py2exe
 112    python setup.py py2app
 113
 114 Upload files to PyWeek with::
 115
 116    python pyweek_upload.py
 117
 118 Upload to the Python Package Index with::
 119
 120    python setup.py register
 121    python setup.py sdist upload
 122