Skip to content

Commit 9b3e0e6

Browse files
committed
Update README.md
1 parent 18c6b81 commit 9b3e0e6

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,56 @@ countries and breadth first search (BFS).
55

66
Inspired by [Travle](https://imois.in/games/travle/) by
77
Oisin Carroll.
8+
9+
Thanks to [larsenml](https://larsenml.net) for help fixing bugs
10+
in the early stages of development.
811
# How to Play
12+
- At the beginning of a round, you are assigned a starting
13+
country and a destination country.
14+
- Hit "B" to check your assignment and your current path
15+
at any time.
16+
- Use the D-pad to navigate the alphabetically organized
17+
pages of countries.
18+
- Use "A" to select a country and add it to the path.
19+
- You need to add the starting country to your path,
20+
and remember the ending country when you are done.
21+
- Hit "Y" at any time to see the countries which border
22+
the most recently added country.
23+
- Eg. if you just selected USA, you would get a list
24+
with Canada and Mexico.
25+
926
# How to Build
27+
On a Linux system (tested on Arch), you can build and play
28+
the game by running these commands:
1029
```sh
1130
cd assets
1231
./convert.sh
1332
cd ..
1433
make
15-
desmume graph.nds
34+
desmume worldpath.nds
1635
```
1736
# Technologies and libraries used
1837
- C programming language
1938
- GNU compiler collection
2039
- LibNDS and NightFoxLib for interfacing with the Nintendo DS
2140
- LibCheck for unit testing
2241
# Features
23-
- Graph C module working: construction, adjacency, pathfinding.
42+
- Graph logic: construction, adjacency, pathfinding.
2443
- Countries of the world graph and basic game logic working.
2544
- Implemented as text based game with visuals (dots on the map).
2645
# Rights Information
27-
Worldpath is a homebrew geography game for the Nintendo DS.
28-
Copyright (C) 2024 Alex McColm
46+
Worldpath is a homebrew geography game for the Nintendo DS.
47+
Copyright (C) 2024 Alex McColm
2948

30-
This program is free software: you can redistribute it and/or modify
31-
it under the terms of the GNU General Public License as published by
32-
the Free Software Foundation, either version 3 of the License, or
33-
(at your option) any later version.
49+
This program is free software: you can redistribute it and/or modify
50+
it under the terms of the GNU General Public License as published by
51+
the Free Software Foundation, either version 3 of the License, or
52+
(at your option) any later version.
3453

35-
This program is distributed in the hope that it will be useful, but
36-
WITHOUT ANY WARRANTY; without even the implied warranty of
37-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
38-
General Public License for more details.
54+
This program is distributed in the hope that it will be useful, but
55+
WITHOUT ANY WARRANTY; without even the implied warranty of
56+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
57+
General Public License for more details.
3958

40-
You should have received a copy of the GNU General Public License
41-
along with this program. If not, see https://www.gnu.org/licenses/.
59+
You should have received a copy of the GNU General Public License
60+
along with this program. If not, see https://www.gnu.org/licenses/.

0 commit comments

Comments
 (0)