# FUI
Fantastic User Interface

## Purpose
FUI provides a library of front-end components for use with [Dice Box](https://github.com/3d-dice/dice-box). These are modules are designed to be stand-alone without dependencies on each other. Add only the modules you want to your dice roller. For instructions on how to use a specific module, see the readme file under that module's directory.

## Modules
| Module | Description |
|-|-|
|[Display Results](https://github.com/3d-dice/FUI/tree/main/src/displayResults)|Displays the final roll results based on the JSON object representing the final results|
|[Advanced Roller](https://github.com/3d-dice/FUI/tree/main/src/advancedRoller)|Renders and input field and enables support for the full [Roll20 Dice Specification](https://roll20.zendesk.com/hc/en-us/articles/360037773133-Dice-Reference#DiceReference-Roll20DiceSpecification)|
|[Box Controls](https://github.com/3d-dice/FUI/tree/main/src/boxControls)|Creates a control box with sliders to adjust the dice box configurations dynamically|


## TODO's
|Module|Description|Status|
|-|-|-|
|Theme picker|Select the dice texture to use|WIP|
|Color picker|Set the dice to a specific color using a color picker widget|WIP|
|Dice Picker|UI menu to quickly select 1-5 dice of a specific type|TODO|
|Roll History|A short history of recent dice rolls|TODO|
|Roll Favorites|A place to save your favorite dice rolls|TODO|
|Dice Distribution|Shows what's been rolled over time as a chart|TODO|
|Options slider|UI to adjust physics world|Done|