A management tool for your favorite 5e TTRPGs! Keep track of your maps, NPCs, rule references, spells, and monsters in this virtual notebook. Roll virtual dice, click interactive stat sheets, and more.
Explore the docs »
View Demo
·
Report Bug
Table of Contents
The GMCM is built as a Gatsby theme plugin. Your content will reside in .mdx
files inside src/content
that will autogenerate pages/content as you create them.
It's simplest to use the GMCM as a localhost tool, but even if you plan to host an instance of your GMCM, it's important to get your local environment set up first.
To get a local copy up and running, follow these simple steps.
Make sure that your terminal accepts yarn/npm
and gatsby
commands.
- yarn/npm
npm -v yarn -v
- Gatsby CLI
gatsby -v
Install these if they are not already.
- Create the folder where your new gatsby site will live locally
mkdir my-gmcm cd my-gmcm
- Create a
package.json
yarn init -y
- Install your packages
yarn add react react-dom gatsby @iamgarrett/gatsby-theme-gmcm
- Inside
my-gmcm/
create a file calledgatsby-config.js
and add:module.exports = { plugins: ['@iamgarrett/gatsby-theme-gmcm'], };
- Run
When the process is complete, your GMCM will be live at
gatsby develop
http://localhost:8000/
When you first run gatsby develop
you'll find your local site at http://localhost:8000/
. It will be filled with example content that is housed within the plugin. To begin adding your own content, go to your project's root directory and you'll see that gatsby-theme-gmcm
has created a src/content
directory. This is where all your content will live.
There are four directories you can add to begin adding content:
/src/content/adventures
/src/content/references
/src/content/spells
/src/content/monsters
In order, these will be used to contain your campaigns/adventures, any rule references you wish to document, spell documentation, monster documentation.
For more information about creating your own content, please refer to the Wiki documentation
Distributed under the MIT License. See LICENSE.txt
for more information.
Project Link: https://github.com/game-master-campaign-manager/gatsby-theme-gmcm