Description:
Add missing information to README.
Commit status:
[Not Reviewed]
References:
Diff options:
Comments:
0 Commit comments
0 Inline Comments
Unresolved TODOs:
There are no unresolved TODOs
@@ -5,7 +5,7 | |||
|
5 | 5 | |
|
6 | 6 | As the director of a small state park, your job is to balance conservation, leisure, and fiscal sustainability. Gameplay is still being added. |
|
7 | 7 | |
|
8 | This is inspired by Maxis' Sim series of games, particularly SimSafari, and Chris Sawyer's Tycoon games. Its premise more closely resembles SimPark, but I never played it except for a demo. (Alternatively, watch [1990's Sim Games. SO GOOD!]()) | |
|
8 | This is inspired by Maxis' Sim series of games, particularly SimSafari, and Chris Sawyer's Tycoon games. Its premise more closely resembles SimPark, but I never played it except for a demo. (Alternatively, watch [1990's Sim Games. SO GOOD!](https://www.youtube.com/watch?v=APFnM6DqtiA)) | |
|
9 | 9 | |
|
10 | 10 | ## Controls ## |
|
11 | 11 | |
@@ -29,6 +29,8 | |||
|
29 | 29 | |
|
30 | 30 | You can build and run the project using VSCode actions. |
|
31 | 31 | |
|
32 | You can debug the project using the Debug pane in VSCode. | |
|
33 | ||
|
32 | 34 | ### File Structure ### |
|
33 | 35 | |
|
34 | 36 | ``` |
@@ -88,7 +90,7 | |||
|
88 | 90 | │ ├── *Simulation.cs* Primary simulation class. |
|
89 | 91 | │ ├── **Sources.md** List of sources. |
|
90 | 92 | │ ├── *Tile.cs* Draws tiles. |
|
91 |
│ ├── **UI** User interface code, |
|
|
93 | │ ├── **UI** User interface code, one for each window. | |
|
92 | 94 | │ │ ├── *StyleSet.cs* Utility class for setting multiple style variables and colors at once. |
|
93 | 95 | │ │ ├── . |
|
94 | 96 | │ │ ├── . |
@@ -102,9 +104,14 | |||
|
102 | 104 | ├── **README_future.mkd** |
|
103 | 105 | ├── **README.mkd** |
|
104 | 106 | ├── **scripts** Helper scripts. |
|
105 | │ └── *package.py* Creates packaages. | |
|
107 | │ ├── *add-branches.sh* Creates a Mercurial bookmark for each branch | |
|
108 | │ ├── *gitmirror.sh* Mirrors this Mercurial repository to a Git repository | |
|
109 | │ ├── *LoadInk.csx* Loads Ink file, ensuring its validated | |
|
110 | │ ├── *LoadYaml.csx* Loads and validates YAML | |
|
111 | │ ├── *package.py* Creates packaages. | |
|
112 | │ └── *UpdateYaml.csx* Adds missing entries to the YAML file. | |
|
106 | 113 | ├── **SpriteFontPlus ** Font library. (Vendored) |
|
107 | └── **TODO.taskpaper** Tasks, feature requests, and bugs. | |
|
114 | └── **TODO.taskpaper** Tasks, feature ideas, requests, and bugs. | |
|
108 | 115 | ``` |
|
109 | 116 | |
|
110 | 117 | Right now, the largest parts of the code are `UI/`, `Engines/`, `FNAGame.cs` (which |
@@ -114,7 +121,9 | |||
|
114 | 121 | ## Acknowledgements ## |
|
115 | 122 | |
|
116 | 123 | Art: [Isometric 64x64 Outside Tileset by Yar](https://opengameart.org/content/isometric-64x64-outside-tileset), various images from the Library of Congress and USDA Forest Service |
|
124 | ||
|
117 | 125 | Libraries: [FNA](https://fna-xna.github.io/), [SpriteFontPlus](https://github.com/rds1983/SpriteFontPlus), [Tracery.Net](https://github.com/josh-perry/Tracery.Net), [ImGui.NET](http://imgui.net/), and [Encompass-cs](http://moonside.games/docs/encompass/) |
|
126 | ||
|
118 | 127 | Fonts: Droid Sans, [Iosevka,](https://typeof.net/Iosevka/) [Typicons by Stephen Hutchings](https://www.s-ings.com/typicons/) |
|
119 | 128 | |
|
120 | 129 | Sources for the procedural generation are documented in Sources.md. |
You need to be logged in to leave comments.
Login now