README.txt

   1 Thank you for downloading Orange Guy's Quest, version 1.3, by
   2 Philip Pavlick.
   3
   4  -- Introduction --
   5 Orange Guy's Quest is an old game project that I wrote while learning to
   6 program in high school.  It was last modified in 2011 and was found again
   7 several years later while I was going through old programming projects.  I
   8 found that I still liked it, so I decided to patch it up and release it to the
   9 world.  Hopefully as time comes I'll have time to further improve upon it.
  10
  11 Version 1.0 and 1.1 both require Python and Pygame, but have no further
  12 dependencies.  If memory serves me correctly they were originally written for
  13 Python 2.7 and should be compatible with this version of Python.  No word yet
  14 on whether it is forwards-compatible with Python 3, but I wouldn't think so.
  15
  16  -- Rules --
  17 You are Orange Guy.  This game is a platformer inspired by old dungeon
  18 crawlers, so naturally your only objective is to find the down staircase (red)
  19 by opening doors (blue) with keys (green) while avoiding enemies and spikes
  20 (purple).  Along your way you may also encounter golden keys (yellow) which
  21 open hidden doors.
  22
  23 Most of the instructions are given in the first few levels.  The BACKSPACE key
  24 is used to restart the level; falling off the level won't do this for you.  In
  25 the classic versions of the game, being killed by an enemy or a spike will
  26 kill the game immediately.
  27
  28  -- Running the Game --
  29 After you have Python and Pygame installed, you should be able to run Orange
  30 Guy's Quest on any system from within its directory by using the following
  31 command:
  32
  33  python orange.py
  34
  35  -- Command-line Options --
  36 The following command line options can be used to configure your game from the
  37 command line.  All of these will override the default configuration (see below)
  38
  39  -? or --help           Runs the game with a set of introductory levels rather
  40  --intro                than the standard or user-defined level set.
  41
  42  --levels               The next argument will be the path to a level file
  43
  44  -r or -s               Retro or Sprite graphics
  45  -a or -b               Ancient or Blocky graphics
  46
  47  -w or -x               the next argument will be the Width of the window in
  48                         pixels
  49  -h or -y               the next argument will be the Height of the window in
  50                         pixels
  51  -W                     the next two values will be the game Window's width
  52                         and height, respectively
  53
  54  -D                     shows Debug output in the terminal
  55
  56 For example, if I want my original block-style graphics with debug output and
  57 choosing levels from a fresh batch I've just cooked up, I can use this command:
  58
  59  python orange.py -b -D --levels new-levels.txt
  60
  61 If I wanted to run a larger game window so I can see more of the levels at
  62 once, I might use either of these two commands:
  63
  64  python orange.py -W 800 600
  65  python orange.py -w 800 -h 600
  66
  67  -- Configuration --
  68 You can make some configuration changes by altering the source code in
  69 orange.py.  You will find the configuration options after scrolling past the
  70 license information message.
  71
  72 As of version 1.1, LEVELFILE specifes where the game can find levels.  If you
  73 specify a file that does not exist, the game will complain at you.  You can
  74 also specify what level file to use in the command line options (see above),
  75 but this config flag has been included for those times when you just really
  76 don't feel like typing in the same file name over and over again.
  77
  78 Introduced in the Definitive Edition is the setting INTROLEVELS, which
  79 contains the path to some introductory levels for players who are new at the
  80 game.  This value can not be changed, but the levels it represents can be
  81 accessed with the -?, --help, or --intro command line options.
  82
  83 In version 1.1, the WINDOWS configuration setting was added.  This defaults to
  84 False.  If set to True, the game will use a backslash (\) instead of a slash
  85 (/) to go down directory trees.  You shouldn't need to change this, but it's
  86 included "just in case."
  87
  88 The next configuration option is USERECTS.  This defaults to False, which will
  89 give you some pleasing retro pixel art graphics.  If you set USERECTS to True,
  90 it will give you the original block graphics that I used when I first started
  91 coding the game.  Any other value will give a prompt allowing you to choose.
  92
  93 WIN_X and WIN_Y, introduced in version 1.3, set the width and height of the
  94 game window, respectively.  Note that the game does not scale the sprites
  95 relative to window size; such a feature was attempted at one point but it made
  96 the entire game a framerate disaster for some reason.
  97
  98 In theory, blocky graphics are faster because they don't require reading image
  99 files (aside from images files for the text) but modern computers should be
 100 fast enough to run either version.
 101
 102 DEBUG will allow you to see debug output; I do not recommend setting
 103 this to True, as you can enable this using the -D command line option (see
 104 above)