Zonrotan / owlbear_myz_dice

3D dice roller built for Mutant Year Zero in Owlbear Rodeo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mutant: Year Zero Dice for Owlbear Rodeo

3D dice extension for playing Mutant: Year Zero and its' expansions in OwlBear Rodeo, based on the OwlBear Rodeo Dice Extension.

Thanks to the OwlBear Rodeo dev team for letting amateurs like me fiddle with their Dice roller

MASSIVE thanks to jjsoini for help with the Pushing function. Check him out!

Example

Installing

The extension can be installed by clicking the "ADD EXTENSION" button on your Owlbear Rodeo profile and copy-pasting this link into the URL field.

https://myz-dice.onrender.com/manifest.json

How it Works

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.

Read more in their original repo!

Building

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

Project Structure

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.

License

GNU GPLv3

About

3D dice roller built for Mutant Year Zero in Owlbear Rodeo

License:GNU General Public License v3.0


Languages

Language:TypeScript 99.1%Language:HTML 0.6%Language:CSS 0.3%