README.txt 1.91 KB
Newer Older
onpon4's avatar
onpon4 committed
1
2
3
4
This file has been dedicated to the public domain, to the extent
possible under applicable law, via CC0. See
http://creativecommons.org/publicdomain/zero/1.0/ for more
information. This file is offered as-is, without any warranty.
5
6
7
8
9
10

========================================================================


HOW TO RUN

onpon4's avatar
onpon4 committed
11
12
13
14
15
If you have downloaded a version of Hexoshi designated for a particular
system, simply run the executable.

To run the Hexoshi source code, you will need the following
dependencies:
16
17

- Python 2 (2.7 or later) or 3 (3.1 or later) <http://www.python.org>
18
- Pygame 1.9.1 or later <http://pygame.org/download.shtml>
19

onpon4's avatar
onpon4 committed
20
21
Once you have installed the dependencies, you can start Hexoshi by
running hexoshi.py. On most systems, this should be done by
onpon4's avatar
onpon4 committed
22
23
24
double-clicking on it; if you are shown a dialog asking you if you want
to display or run the file, choose to run it.

onpon4's avatar
onpon4 committed
25
Python 2 will be used by default. To run Hexoshi with Python 3 instead,
onpon4's avatar
onpon4 committed
26
27
you can either change the shebang on line 1 from "python2" to "python3",
or explicitly run the Python 3 executable, e.g. with
onpon4's avatar
onpon4 committed
28
"python3 hexoshi.py" (the exact command may be different depending on
onpon4's avatar
onpon4 committed
29
your system).
30

onpon4's avatar
onpon4 committed
31
There are some command-line options that can be passed. Run Hexoshi in a
32
33
terminal with the "-h" command-line option for more information.

onpon4's avatar
onpon4 committed
34

35
36
HOW TO PLAY

37
Use the arrow keys and Enter to navigate the menus. By default, Anneroy
38
39
40
41
42
43
44
45
46
47
48
49
50
51
is controlled by the arrow keys, Space, Left Ctrl, and Left Shift. You
can change the controls in the Options menu.

Other controls:
- F11: Toggle fullscreen.
- Escape: Return to the title screen.
- Middle mouse button: Quit the game.

The middle mouse button quitting the game is meant to work around a bug
in Pygame which sometimes locks up the keyboard when toggling fullscreen
or changing the window size. See this post on the SGE blog for more
information:

https://savannah.nongnu.org/forum/forum.php?forum_id=8113