bigfootds/sourcepool-server

TTRPG content management system, ready for you to self-host. Server executable for an admin or DM/GM to run and maintain.

Sourcepool Server

This repository contains the source code for the core "server" component of Sourcepool.

Contributing

To see the to-do list of the Sourcepool ecosystem, please refer to these resources:

• BigfootDS/Projects/Sourcepool

The GitHub project Sourcepool is the primary source of info for task planning, and includes links to the official repositories of the various bits of Sourcepool.

Installation

Installers are provided in the Releases page for MacOS and Windows platforms. Releases towards the top of the page are newer, with the release labelled "latest" being the newest version of the server.

So, MacOS and Windows users, please visit this page: https://github.com/BigfootDS/Sourcepool-Server/releases

Linux users, please refer to the "Build From Source" section of this page.

Build From Source

First, download or clone this repository.

This is a NodeJS project, built on the latest LTS version of NodeJS.

Depending on your platform, you may need to do things like install node-gyp separately.

On all systems, you will need to install the NPM dependencies. In your terminal, run this command:

npm install

On Ubuntu and other Linux systems, you may need to install additional dependencies before running or building this app:

Ubuntu dependencies and building

1. Install dependencies:

sudo apt install libnss3-dev libgdk-pixbuf2.0-dev libgtk-3-dev libxss-dev

2. Create builds with this command:

DEBUG=electron-installer-snap:snapcraft npm run make

MacOS, Windows and other platforms

On most systems, you can simply run the npm run make command in your terminal and things should work.

Attributions

"PBR Paper 02 Texture" texture by plaggy, available on OpenGameArt.org - CC0 - Used in backgrounds in some places of the app, but typically at a reduced opacity (eg. 40% in MacOS DMG installers).

sourcepool-server's Issues

feat: Embed web client in server

The Sourcepool Server should have some sort of UI, even though the app itself is just an API & database.

So, like Jellyfin, the server/backend should include a local web client (eg. a React app).

This means that some web client needs to be created - in its own repo - and that this server needs to embed it somehow. This could be as a git submodule that is only updated when the server does a new release, or as a downloaded-as-needed app that is downloaded and updated during the server's usage without being tied to server releases, or a mix of both of those, or some other completely different option.

Either way, a web client needs to exist before this issue can be worked on.

Depends on...

• Web client, stored in an external repository

feat: Generic, barebones CRUD for all DB models

Some sort of generic, basic (probably validation- and sanitisation-less) CRUD functionality.

Just want to be able to do DB operations through API requests even if we're not super-settled on what data is gonna be in place.

Depends on...

• feat: Basic admin auth

feat: Encounter tracker data

Add data to represent an encounter (combat or otherwise).
Encounters have:

• Rounds (number)
• Initiative (object array)
  • Character (id/string)
  • Order (number)
• Notes (string array)

Characters or the DM can set their Initiative, determining their order in the Encounter.

The DM can progress through an Encounter, moving from Character to Character.

A complete loop through all Characters increments a Round by one.

The DM can modify the health of each Character, either healing or damaging them.

feat: Basic Admin Auth

When the server starts, it should check if any existing admins are found on record for the server.

If no admins are found, all API requests should respond with a message indicating that an admin needs to sign up.

One route will work:
POST /users/admin/create

Needs JSON body data of username and password.

Depends on...

• ElectronJS + ExpressJS project init with embedded DB