gridmonger
gridmonger copied to clipboard
johnnovak
Your trusty old-school cRPG mapping companion
Your trusty old-school cRPG mapping companion
Project website
https://gridmonger.johnnovak.net
Build instructions
Requires Nim 2.0.2
Dependencies
You can install the dependencies with Nimble:
nimble install koi osdialog riff semver winim with
winim is only needed for the Windows builds.
Compiling
The main branch is usually in flux as it often contains work-in-progress
changes intended go into the next release. Check out the latest tag instead to
build the last stable version:
git tag
# replace with the latest tag
git checkout v1.1.0
To build the debug version (debug logging enabled, file dialogs disabled):
nim debug
To build the release version (file dialogs enabled):
nim release
Run nim help for the full list of build tasks.
NOTE: Create an empty directory Config in the project root directory to
enable portable mode (that's what you normally want during development).
Manual & website
The website (GitHub Pages site) and manual are generated from Sphinx sources.
The website is published from the docs directory of the master branch.
Requirements
Building
- To build the website, run
nim site - To build the manual, run
nim manual - To create the zipped distribution package of the manual from the generated
files, run
nim packageManual - Check out the release build instructions for further details.
Theme development
You can run make watch_docs_css or make watch_frontpage_css from the
sphinx-doc directory to regenerate the CSS when the SASS files are changed
during theme development.
Packaging & release process
See RELEASE.md.
Credits
The user interface uses the Roboto font by Google for all text (Regular, Bold, and Black variants).
The Gridmonger logo uses Versal Gothic by Juan Casco.
The TTF icon font was created with the amazing IcoMoon App. Most icons are from the below sources available through the app, some are my own creations, then a few were converted from random free SVG clipart I found online.
- IcoMoon - Free (GPL / CC BY 4.0) — http://keyamoon.com/
- Font Awesome (CC BY 4.0) — https://fontawesome.com/
- Zondicons (CC BY 4.0) — http://www.zondicons.com/
- Brankic 1979 (Freeware) — https://www.brankic1979.com/iconss/
- Material Icons (Apache License 2.0) — https://fonts.google.com/icons
License
Developed by John Novak <[email protected]>, 2020-2024
This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.
johnnovak