Your trusty old-school cRPG mapping companion
Project homepage
https://gridmonger.johnnovak.net
Build instructions
Requires Nim 1.6.10+
Dependencies
- koi
- nim-glfw (
gridmonger
branch) - nim-nanovg
- nim-osdialog
- nim-riff
- winim
You can install most of the dependencies with Nimble:
nimble install nanovg osdialog riff winim
For koi
and nim-glfw
, clone their Git repositories, check out the
gridmonger
branch in nim-glfw
, then install both with nimble develop
for
local development.
Compiling
Debug build (debug logging enabled, file dialogs disabled on Windows):
nim debug
Release build:
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 to use during
development).
Building the manual & website
The website (GitHub Pages site) and manual are generated from Sphinx sources.
The website is published from the /docs
directory in 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
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
License
Developed by John Novak <john@johnnovak.net>, 2020-2023
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.