https://github.com/deciduously/librollenspielsache

C-compatible Rust crate for working with tabletop RPG entities
https://github.com/deciduously/librollenspielsache

Last synced: 5 months ago
JSON representation

C-compatible Rust crate for working with tabletop RPG entities

• Host: GitHub
• URL: https://github.com/deciduously/librollenspielsache
• Owner: deciduously
• License: bsd-3-clause
• Created: 2020-05-05T12:08:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-17T18:00:19.000Z (about 6 years ago)
• Last Synced: 2025-03-23T21:49:19.403Z (about 1 year ago)
• Language: Rust
• Homepage: https://rollenspielsache.deciduously.com/
• Size: 10.1 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# librollenspielsache

[![Crates.io](https://img.shields.io/crates/v/librollenspielsache)](https://crates.io/crates/librollenspielsache)

[![Docs](https://docs.rs/librollenspielsache/badge.svg)](https://docs.rs/librollenspielsache)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/deciduously/librollenspielsache/Rust)](https://github.com/deciduously/librollenspielsache/actions)

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](https://github.com/deciduously/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.