Add initial work
[viable-idea.git] / README
1 This started as an idea from Max [0] but I'm thinking to take it in a 
2 different direction, without the editor role so there isn't an overall 
3 plan. People submit contributions to develop the game and story in 
4 whatever direction they wish, although please try to coordinate with 
5 each other. It will be interesting to see the different directions 
6 that people take this in!
7
8 Please send your contributions by email to j@jxself.org to be included 
9 in this copy.
10
11 [0] https://intfiction.org/t/anyone-want-to-join-making-a-simple-game/59022
12
13 The recommended way to get a copy of this game is a recursive clone:
14
15     git clone --recursive https://jxself.org/git/viable-idea.git
16
17 This will clone all submodules recursively. If you did not perform a
18 recursive clone, once you have a copy of this git repository you will
19 also need the source code for the standard library:
20
21     git submodule update --init --recursive
22
23 To compile this game you will also need my modified version of the 
24 Inform compiler from https://jxself.org/git/?p=inform.git
25
26 Once the compiler has been compiled and is ready for use return to 
27 this directory and run:
28
29     inform +include_path=lib src/viable-idea
30
31 Or you can run the included build.sh script which does the same thing, 
32 assuming that the inform compiler is included in your PATH.
33
34 You will then get the story file for this game that can be run using 
35 any appropriate Z-Machine interpreter, such as Frotz. Your GNU/Linux 
36 distro probably has that packaged already for easy installation.
37
38 A great big thanks to David Griffith for keeping Inform 6 alive.
39
40 --
41 This file is copyright (C) Jason Self <j@jxself.org>. Each 
42 person that contributes to this game retains the copyright for their 
43 own contributions but agrees to license them as follows:
44
45 You may copy, redistribute and/or modify this game under the terms of 
46 the GNU Affero General Public License as published by the Free 
47 Software Foundation, either version 3 of the License, or (at your 
48 option) any later version.
49
50 This game is distributed in the hope that it will be useful, but 
51 WITHOUT ANY WARRANTY; without even the implied warranty of 
52 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
53 Affero General Public License for more details.
54
55 You should have received a copy of the GNU Affero General Public 
56 License along with this game. If not, see https://gnu.org/licenses.