/
README.md
91 lines (61 loc) · 3.94 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# City Of Thieves
Branch |[![GitHub Actions logo](pics/GitHubActions.png)](https://github.com/richelbilderbeek/city_of_thieves/actions) |[![Codecov logo](pics/Codecov.png)](https://www.codecov.io)
-----------|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`master` |![check](https://github.com/richelbilderbeek/city_of_thieves/workflows/check/badge.svg?branch=master) |[![codecov.io](https://codecov.io/github/richelbilderbeek/city_of_thieves/coverage.svg?branch=master)](https://codecov.io/github/richelbilderbeek/city_of_thieves/branch/master)
`develop` |![check](https://github.com/richelbilderbeek/city_of_thieves/workflows/check/badge.svg?branch=develop) |[![codecov.io](https://codecov.io/github/richelbilderbeek/city_of_thieves/coverage.svg?branch=develop)](https://codecov.io/github/richelbilderbeek/city_of_thieves/branch/develop)
City Of Thieves is a text adventure game after the English gamebook with the same name by Ian Livingstone.
* [Wikipedia](https://en.wikipedia.org/wiki/City_of_Thieves_%28gamebook%29)
![Console version](Screenshots/CityOfThievesConsole_1_0.png)
![Desktop version](Screenshots/CityOfThievesDesktop_1_0.png)
![Nintendo DS version](Screenshots/CityOfThievesNds_1_0.jpg)
![Nintendo DS version on emulator](Screenshots/CityOfThievesNdsEmulator_1_0.png)
## Building
To build all:
```
make
```
### Console
```
make console
```
### Desktop
```
make desktop
```
## Running
Be sure to have already build the files.
Then open the correct Qt Creator project:
* Console: `Console/CityOfThievesConsole.pro`
* Console (test only): `Console/CityOfThievesConsoleTest.pro`
* Desktop: `Desktop/CityOfThievesDesktop.pro`
* NDS: `Nds/source/GameCityOfThievesNds.pro`
## Downloads
* [Windows executable](http://richelbilderbeek.nl/CityOfThievesExe.zip)
* [Arch Linux AUR package](https://aur.archlinux.org/packages/cityofthieves-cli/) (Console version only for the moment)
* [NDS](http://richelbilderbeek.nl/CityOfThievesNds.zip)
* Download the Singularity image:
```
singularity pull library://richelbilderbeek/default/city_of_thieves
```
## Video
* General gameplay: [YouTube](https://youtu.be/0QeDhZQGPFo) [download (.ogv)](http://richelbilderbeek.nl/city_of_thieves.ogv)
## I want to help!
Great!
There is need for some testing and spelling corrections. Create a new Issue or email @richelbilderbeek.
## What are all those files in the folder `Files`?
The `.txt` files contain the story of 'City Of Thieves'.
These are converted to C++ headers and source files by the `FilesToFunctions.sh` scripts.
This was needed, because NitroFS (as part of libnds, as part of DevKitPro) does not support a filesystem on the NDS hardware.
## Contributors
* Richel Bilderbeek [@richelbilderbeek](https://github.com/richelbilderbeek): lead developer
* Jeroen Niemandal [@JeroenN](https://github.com/JeroenN): added autofight
* Carmen IJsebaart [@CarmenIJsebaart](https://github.com/CarmenIJsebaart): testing
* Greg Fivash: testing
* Sander van Kasteel [@sandervankasteel](https://github.com/sandervankasteel): [Arch linux package maintainer](https://aur.archlinux.org/packages/cityofthieves-cli/), bug reporting
* Seb Doekes: [bug report #16](https://github.com/richelbilderbeek/city_of_thieves/issues/16)
* Jesper Doekes: [bug report #16](https://github.com/richelbilderbeek/city_of_thieves/issues/16)
## External links
* [libnds_example_1](https://github.com/richelbilderbeek/libnds_example_1): minimal NDS example
* [libnds_example_2](https://github.com/richelbilderbeek/libnds_example_2): minimal NDS example with Madmax audio
* [Richel Bilderbeek's games](https://github.com/richelbilderbeek/Games)
* [Singularity scriptlet for City of Thieves](https://github.com/richelbilderbeek/singularity_example_6)