Update the library to version 6.12.4
[spiritwrak.git] / README
1 This repository contains a copy of SPIRITWRAK by D. S. Yu.
2
3 https://ifdb.tads.org/viewgame?id=tqpowvmdoemtooqf
4 http://mirror.ifarchive.org/if-archive/games/source/inform/spiritw_src.zip
5
6 The recommended way to get a copy of this git repository is a
7 recursive clone:
8
9     git clone --recursive https://jxself.org/git/?p=spiritwrak.git
10
11 This will clone all submodules recurively. If you did not perform a
12 recurive clone, once you have a copy of this git repository you will
13 also need the source code for the standard library:
14
15         git submodule update --init --recursive
16
17 To compile this game you will also need my modified version 6 of the
18 Inform compiler from https://jxself.org/git/?p=inform.git
19
20 Once the compiler has been compiled and is ready for use return to
21 this directory and run:
22
23     inform '$huge' '$MAX_OBJECTS=1000' '$MAX_SYMBOLS=8150' \
24     '$MAX_CLASSES=50' '$MAX_DICT_ENTRIES=1500' \
25     '$MAX_ZCODE_SIZE=200000' ++include_path=src ++include_path=lib \
26     -v8 src/spirit
27
28 Or you can run the included build.sh script which does the same thing.
29
30 You will then get the story file for this game that can be run using
31 any appropriate Z-Machine interpreter, such as Frotz. Your GNU/Linux
32 distro probably has that packaged already for easy installation.
33
34 --
35 Copyright (C) 2019 Jason Self <j@jxself.org>
36
37 You may copy, redistribute and/or modify this file under the terms of
38 the GNU General Public License as published by the Free Software
39 Foundation, either version 3 of the License, or (at your option) any
40 later version.
41
42 This file is distributed in the hope that it will be useful, but
43 WITHOUT ANY WARRANTY; without even the implied warranty of
44 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
45 General Public License for more details.
46
47 You should have received a copy of the GNU General Public License
48 along with this file. If not, see https://gnu.org/licenses/