#fun #tabletop #rpg #entities #api #interface #build

librollenspielsache

API for working with tabletop RPG entities

4 releases

0.1.2 May 8, 2020
0.1.1 May 5, 2020
0.1.0 May 5, 2020
0.0.1 May 5, 2020

#2187 in Game dev

35 downloads per month

BSD-3-Clause

20KB
490 lines

librollenspielsache

Crates.io Docs GitHub Workflow Status

WIP - there's like nothing actually here yet. This is more a guiding plan.

The Rollenspielsache is a set of tools for managing tabletop RPG games. The goal is to handle the mechanics seamlessly, allowing you to participate or run a tabletop encounter without getting distracted by rule clarifications.

Overview

This repo contains the core library as a Rust crate with an eventually optional C-FFI interface. In Rust you get to use the full Rust API, I plan to expose as much as I can, but the FFI interface is much more barebones and largely guided by need. Use cargo build --release to produce target/release/librollenspiel.so. Then, add this directory to your $LD_LIBRARY_PATH to create a binding. Use cargo test to run the tests.

Features

This library aims to cover as much territory as possible, reducing automating as many interactions as possible for a seamless experience while running (or playing) a game, whether that's in person or digitally via another system like roll20.

Types

  • Party, either player or NPC (for encounters) - APL, CR
  • Character - class, race
  • Item
  • Skill/Ability/Spell (given by items)

Systems - make everything as agnostic as possible:

  • D&D 5E
  • Starfinder

TODO roll20 integration?

Data-ready

  • C-compatible - see librollenspielsache-rb for an example of how to use from another language.
  • Redis-ready - each type has a method to build an appropriate Redis command for insertion.

Usage

Control the build with cargo. Use make all as a shortcut to put the compiled shared object file for FFI usage in dist/. Point your linker to this file to use it.

Dependencies

~12–20MB
~283K SLoC