README.txt 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. This file has been dedicated to the public domain, to the extent
  2. possible under applicable law, via CC0. See
  3. http://creativecommons.org/publicdomain/zero/1.0/ for more
  4. information. This file is offered as-is, without any warranty.
  5. ========================================================================
  6. HOW TO RUN
  7. If you have downloaded a version of the game designated for a particular
  8. system, simply run the executable.
  9. To run the source code, you will need the following dependencies:
  10. - Python 2 (2.7 or later) or 3 (3.1 or later) <http://www.python.org>
  11. - Pygame 1.9.1 or later <http://pygame.org>
  12. If you are using a version of Python older than 3.4, you will also need
  13. to install pathlib: <https://pypi.python.org/pypi/pathlib/>
  14. Once you have installed the dependencies, you can start the game by
  15. running "hexoshi.py". On most systems, this should be done by
  16. double-clicking on it; if you are shown a dialog asking you if you want
  17. to display or run the file, choose to run it.
  18. To run the game with a particular Python version, open "hexoshi.py" in a
  19. text editor and change the shebang on line one to indicate the version
  20. you want to use, e.g. "python2" or "python3" instead of just "python".
  21. There are some command-line options that can be passed. Run the game in
  22. a terminal with the "-h" command-line option for more information.
  23. SPECIAL CONTROLS
  24. You can exit the game by pressing the middle mouse button. This is a
  25. workaround for a rare bug in Pygame which can lock up the keyboard
  26. controls, explained in detail here:
  27. https://savannah.nongnu.org/forum/forum.php?forum_id=8113