https://github.com/skewedaspect/rpgkeeper
A site for managing your digital character sheets.
https://github.com/skewedaspect/rpgkeeper
campaign character character-sheet character-sheets dungeon games hacktoberfest javascript nodejs player rpg
Last synced: 5 months ago
JSON representation
A site for managing your digital character sheets.
- Host: GitHub
- URL: https://github.com/skewedaspect/rpgkeeper
- Owner: SkewedAspect
- License: agpl-3.0
- Created: 2015-02-02T02:54:21.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T05:56:53.000Z (over 1 year ago)
- Last Synced: 2024-04-14T22:33:30.598Z (about 1 year ago)
- Topics: campaign, character, character-sheet, character-sheets, dungeon, games, hacktoberfest, javascript, nodejs, player, rpg
- Language: Vue
- Homepage: https://rpgkeeper.com
- Size: 15.5 MB
- Stars: 29
- Watchers: 6
- Forks: 7
- Open Issues: 20
-
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
RPGKeeper
[](https://lgtm.com/projects/g/Morgul/rpgkeeper/alerts/)
[](https://lgtm.com/projects/g/Morgul/rpgkeeper/context:javascript)
* Production: https://rpgkeeper.com
* Beta: https://beta.rpgkeeper.com
RPGKeeper is a digital chracter 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][vue], [TypeScript][ts], and [NodeJS][node]. 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](https://github.com/Morgul/rpgkeeper/issues/new?labels=system%20request&title=[Request]%20).
### 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.
---
## 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:
```dotenv
# 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 `SECRET_SESSION` and `MAILGUN_KEY`). You can get a
`CLIENT_ID` and `CLIENT_SECRET` by creating a new project in the
[Google Developer Console](https://console.developers.google.com/).
### 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: `/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._
[vue]: https://vuejs.org/
[ts]: https://www.typescriptlang.org/
[node]: https://nodejs.org/en/