Shiver Dice extension for Owlbear Rodeo 2
...
This project uses React for UI, Three.js for rendering and Rapier for physics.
The physics simulation is used to both generate the animation for the roll as well as the final roll values.
Wait is it really random if physics is used to determine the result? How do I know the dice rolls are fair?
Short answer yes, the dice are fair. Long answer here's a statistical analysis of the rolling methodology.
In order to sync rolls over the network efficiently we rely on the fact the Rapier is a deterministic physics engine. This means that across two different computers we'll get the same result given the same initial parameters.
So we only need to make sure that all the initial parameters are synced and then each client can run its own simulation and end up with the correct animation.
This project uses Yarn as a package manager.
To install all the dependencies run:
yarn
To run in a development mode run:
yarn dev
To make a production build run:
yarn build
All source files can be found in the src folder.
If you'd like to create a new dice set with the existing dice styles edit the diceSets.ts file in the sets folder.
If you'd like to add a new dice style the 3D models for the dice are split across four folders: materials, meshes, colliders and previews.
The materials folder contains the PBR materials for each dice style.
The meshes folder contains the 3D geometry used for the dice.
The colliders folder contains the simplified collider geometry for the dice.
The previews folder contains 2D image previews for each dice.
All the code specific for the Owlbear Rodeo extension is in the plugin folder.
GNU GPLv3
Copyright (C) 2023 Jussi Soini