Skip to content

SkewedAspect/rpgkeeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,070 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RPGKeeper

RPGKeeper is a digital character manager. While there are many others out there that are targeted to one or two systems, RPGKeeper aims to be a universal character management system. It can support any TTRPG system ever created, as long as that system is added into it's codebase. Building a system is a time-consuming process, but it's possible to get the basics going in just a few hours. With support for a 'generic' system, RPGKeeper allows you to get down to playing quickly even if it doesn't support your game with a dedicated system.

FAQ

But what about Roll20?

Don't get us wrong, Roll20 certainly has a lot of features, and a dedicated fanbase. But Role20 is a map first, and a character/campaign manager second. Often, character sheets are built based off the official paper sheets from games; which often don't translate well to a digital format. RPGKeeper takes a different approach: we focus on building user experiences centered around playing your character, without worrying about keeping the sheet the same as the paper version. Characters are a first class citizen.

How many Characters can I have?

Currently, there are no limits on number of characters.

I have a game I want to add a system for!

Well, are you a developer? RPGKeeper is written in VueJS, TypeScript, and NodeJS. If you know (or are willing to learn) those technologies, then fork the code, and start adding a system. If, instead, you're just a gamer and want us to do the work, then Request a System.

Can I share a link to my character?

You can! Simply copy the url from your browser, and send that link to someone else. They will see a read-only version of your character.


Docker

RPGKeeper is available as a Docker image at morgul/rpgkeeper:latest.

Quick Start

docker run -d -p 5678:5678 morgul/rpgkeeper:latest

Note: Without a volume mount, any characters or data you create will be lost when the container stops. See Volume Mounts below for persistent data.

Environment Variables

Authentication:

  • DOMAIN - The public domain where RPGKeeper is hosted (required for Google OAuth, e.g., "https://rpgkeeper.example.com")

Admin/Mod Assignment:

  • ADMIN_EMAILS - Comma-separated list of email addresses that should automatically get admin privileges when they create an account (e.g., "user@example.com,admin@example.com")
  • MOD_EMAILS - Comma-separated list of email addresses that should automatically get moderator privileges when they create an account

Example:

docker run -d -p 5678:5678 \
  -e DOMAIN="https://beta.rpgkeeper.com" \
  -e ADMIN_EMAILS="your.email@example.com" \
  -v /path/to/rpgk.db:/app/db/rpgk.db \
  morgul/rpgkeeper:latest

Single User Mode (No Authentication)

For personal, single-user deployments where the container is NOT exposed to the internet, you can enable Single User Mode to bypass authentication entirely.

⚠️ WARNING: Single User Mode has NO authentication security. Anyone who can access the container can view and modify all data. Only use this for personal deployments on trusted networks.

Enable Single User Mode:

docker run -d -p 5678:5678 \
  -e SINGLE_USER_MODE="true" \
  -v /path/to/rpgk.db:/app/db/rpgk.db \
  morgul/rpgkeeper:latest

When enabled:

  • Google OAuth is disabled
  • A default user account is automatically created
  • All requests are automatically authenticated as this user
  • No login screen is shown
  • Logout functionality is disabled

Recommended use cases:

  • Personal home server deployments (not internet-facing)
  • Local development/testing
  • Single-user containers on trusted networks

Not recommended for:

  • Multi-user deployments
  • Internet-facing servers
  • Shared hosting environments

Volume Mounts

The image includes a pre-built static.db file at /app/db/static.db containing official game supplement definitions (weapons, armor, talents, etc.).

Important: If you mount a volume at /app/db, it will shadow the bundled static.db file. You have two options:

Option 1: Mount only the database file (recommended)

docker run -d -p 5678:5678 -v /path/to/rpgk.db:/app/db/rpgk.db morgul/rpgkeeper:latest

Option 2: Mount the directory and copy static.db (one-time setup)

# Start container
docker run -d --name rpgkeeper -p 5678:5678 -v /path/to/data:/app/db morgul/rpgkeeper:latest

# Copy static.db to your volume
docker cp rpgkeeper:/app/db/static.db /path/to/data/static.db

# Restart container
docker restart rpgkeeper

Development

RPGKeeper is, and always will be an open source project. We want to encourage developers to help improve it, and add new features that we haven't even considered before. As such, we want to keep how to contribute front and center in this readme. All contributions are welcome!

Getting started

Before getting started you will need the following installed:

  • NodeJS >= v16

You will also need to add a .env file to the root of the project. This file should contain the following:

# Defaults for local development
SESSION_SECRET='etched municipality unconscionably fribble *&^%$## 88'
CLIENT_ID='712153107187-8e00g8d18nbk5esiffhkrbtr12vktlvq.apps.googleusercontent.com'
CLIENT_SECRET='hOsFjUL-f_yky8djy1OSuvmp'
SERVER_PORT=5678

You will want to replace these with your own values (especially SESSION_SECRET and MAILGUN_KEY). You can get a CLIENT_ID and CLIENT_SECRET by creating a new project in the Google Developer Console.

Running

The first thing you will want to do is to install dependencies:

  • npm

Finally, you will need to start the dev server:

  • npm run dev

It should create a new database file: <project_root>/db/rpgk.db. You should now be able to access the running client at http://localhost:5678/.

Checking your work

Before you are allowed to push, the project will force you to run through the linter. If the linter doesn't pass, you don't get to push. To check on your own, I recommend you run: npm run lint. If this passes then you know you're good to go.

Note: Merge requests will not be accepted without passing linting.