# HG changeset patch # User Alys Brooks # Date 2021-11-27 09:03:12 # Node ID 1f50043dc696f7ee90d650e6b9ea5e47d6418424 # Parent f9c82359de412a43267c161d9f7518096a24b143 Add missing information to README. diff --git a/README.mkd b/README.mkd --- a/README.mkd +++ b/README.mkd @@ -5,7 +5,7 @@ As the director of a small state park, your job is to balance conservation, leisure, and fiscal sustainability. Gameplay is still being added. -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!]()) +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)) ## Controls ## @@ -29,6 +29,8 @@ You can build and run the project using VSCode actions. +You can debug the project using the Debug pane in VSCode. + ### File Structure ### ``` @@ -88,7 +90,7 @@ │   ├── *Simulation.cs* Primary simulation class. │   ├── **Sources.md** List of sources. │   ├── *Tile.cs* Draws tiles. -│   ├── **UI** User interface code,, one for each window. +│   ├── **UI** User interface code, one for each window. │   │   ├── *StyleSet.cs* Utility class for setting multiple style variables and colors at once. │ │ ├── . │ │ ├── . @@ -102,9 +104,14 @@ ├── **README_future.mkd** ├── **README.mkd** ├── **scripts** Helper scripts. -│   └── *package.py* Creates packaages. +│   ├── *add-branches.sh* Creates a Mercurial bookmark for each branch +│   ├── *gitmirror.sh* Mirrors this Mercurial repository to a Git repository +│   ├── *LoadInk.csx* Loads Ink file, ensuring its validated +│   ├── *LoadYaml.csx* Loads and validates YAML +│   ├── *package.py* Creates packaages. +│   └── *UpdateYaml.csx* Adds missing entries to the YAML file. ├── **SpriteFontPlus ** Font library. (Vendored) -└── **TODO.taskpaper** Tasks, feature requests, and bugs. +└── **TODO.taskpaper** Tasks, feature ideas, requests, and bugs. ``` Right now, the largest parts of the code are `UI/`, `Engines/`, `FNAGame.cs` (which @@ -114,7 +121,9 @@ ## Acknowledgements ## 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 + 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/) + Fonts: Droid Sans, [Iosevka,](https://typeof.net/Iosevka/) [Typicons by Stephen Hutchings](https://www.s-ings.com/typicons/) Sources for the procedural generation are documented in Sources.md.