Roll Dice 3D

A 3D dice rolling package using Three.js that provides realistic 3D dice rolling animations and results.

Installation

npm install roll-dice-3d

Usage

import { DiceRoller } from "roll-dice-3d";

// Create a new dice roller instance
const diceRoller = new DiceRoller();

// Roll 3 dice
diceRoller.rollDice(3).then((results) => {
  results.forEach((result) => {
    console.log(`Dice value: ${result.value}`);
    console.log(`Position: ${result.position}`);
    console.log(`Rotation: ${result.rotation}`);
  });
});

// Clean up when done
diceRoller.dispose();

Using with a specific container

const container = document.getElementById("dice-container");
const diceRoller = new DiceRoller(container);

API

DiceRoller

The main class for rolling dice.

Constructor

constructor(container?: HTMLElement)

• container: Optional HTML element to render the dice in. If not provided, the dice will be rendered in the body.

Methods

rollDice(numDice: number): Promise<DiceResult[]>

Rolls the specified number of dice and returns a promise that resolves with the results.

• numDice: Number of dice to roll
• Returns: Promise that resolves with an array of DiceResult objects

dispose(): void

Cleans up resources and removes the renderer from the DOM.

DiceResult

Interface representing the result of a single die roll.

interface DiceResult {
  value: number; // The value rolled (1-6)
  position: Vector3; // The final position of the die
  rotation: Euler; // The final rotation of the die
}

License

MIT