INSTALL.adoc

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