Magic-number elimination.
[open-adventure.git] / INSTALL.adoc
1 = Installing Open Adventure =
2
3 The instructions below assume your system uses Python 3 by default,
4 but the actual Python code in Open Adventure is 2/3 agnostic. Adjust
5 the example commands below accordingly.
6
7 1. Install PyYAML for Python 3 (which requires Python 3) and libedit
8 from http://thrysoee.dk/editline/ (aka: editline) on your system.
9
10 On Debian and Ubuntu: 'apt-get install python3-yaml libedit-dev'.
11 On Fedora: 'dnf install python3-PyYAML libedit-devel'.
12
13 If you are using MacPorts on OS X: 'port install py3{5,6}-yaml', as
14 appropriate for your Python 3 version.
15
16 You can also use pip to install PyYAML: 'pip3 install PyYAML'.
17
18 2. 'make'.
19
20 3. Optionally run a regression test on the code with 'make check'.
21
22 4. Run the resulting 'advent' binary to play.
23
24 If make returns the following message:
25
26 ./make_dungeon.py Traceback (most recent call last): File "./make_dungeon.py", line 10, in import sys, yaml ImportError: No module named yaml
27
28 try editing make_dungeon.py to change #!/usr/bin/env python to read
29 #!/usr/bin/env python3