Skip to content

Commit a2bfd6c

Browse files
committed
docs: how-to run game
1 parent 357f3ca commit a2bfd6c

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.org

+42
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,48 @@ A story game in the tribal epoch of Colombia.
44

55
* Project
66

7+
** Create executable
8+
9+
You can create an executable with [[https://github.com/roswell/roswell][roswell]], running the following 2 commands:
10+
11+
#+BEGIN_SRC sh
12+
cd /path/to/colombia-tribal/src
13+
ros build ../colombia-tribal.ros
14+
#+END_SRC
15+
16+
Beware! Ensure you run the =ros build= command from within the =src=
17+
directory!
18+
19+
** Run the executable
20+
21+
Once you have built the executable, simply call the executable from
22+
the terminal as follows:
23+
24+
#+BEGIN_SRC sh
25+
cd src/
26+
../colombia-tribal
27+
#+END_SRC
28+
29+
Again, in order for the process to find all css files and images, it needs to be ran
30+
from the src directory.
31+
32+
** Zip release
33+
34+
The executable found in the release was tested on ubuntu 18.04 and debian 10.
35+
36+
To start the game, run the following commands in the terminal, from
37+
inside the directory containing the zip file:
38+
39+
#+BEGIN_SRC sh
40+
unzip ./colombia-tribal-1.0.0.zip
41+
cd ./colombia-tribal-1.0.0/
42+
./colombia-tribal
43+
#+END_SRC
44+
45+
** Web URL
46+
47+
You can as well find the game at the following URL: http://172.105.86.13:5000/
48+
749
** Game engine
850

951
The Game story and actions are specified in ORG files. These contain

0 commit comments

Comments
 (0)