diff --git a/.github/media/preview.gif b/.github/media/preview.gif new file mode 100644 index 0000000..d11191b Binary files /dev/null and b/.github/media/preview.gif differ diff --git a/README.md b/README.md index 5cf9d78..e9550f3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,63 @@ -# dice-tower +

+ Dice-Tower +

+

... they see them rolling ...

+ +

+ Key Features • + How To Build • + Credits • + License +

+ +![preview](.github/media/preview.gif) + +--- + +## Key Features + +* Connect to a room with others +* Configure your dice (theme and color) +* Roll any dice +* See the dice roll (Can be used as a Browser Source in OBS) +* Watch roll results (also available as Browser Source in OBS) + +--- + +## How To Build + +To clone and run this application, you'll need `git`, `java21` and `docker`. + +```bash +# Clone this repository +$ git clone https://git.arindy.de/arindy/dice-tower.git + +# Go into the repository +$ cd dice-tower + +# Build the binary +$ ./mvnw clean verify -Pnative + +# Build the container +$ docker build -f src/main/docker/Dockerfile.native-micro -t dice-tower . + +# run the container in the background +$ docker run --network host -d dice-tower + +# Visit the dice-tower in your browser on http://localhost:8080 +``` + +--- + +## Credits + +This software uses the following open source packages: + +- [3D-Dice/dice-box](https://github.com/3d-dice/dice-box) +- [3D-Dice/dice-themes](https://github.com/3d-dice/dice-themes) +- [W3.CSS Color Themes](https://www.w3schools.com/w3css/w3css_color_themes.asp) + +## License + +GPL-3 diff --git a/src/main/resources/templates/pub/index.html b/src/main/resources/templates/pub/index.html index 4264059..8f5785f 100644 --- a/src/main/resources/templates/pub/index.html +++ b/src/main/resources/templates/pub/index.html @@ -94,21 +94,22 @@ -
-

Dice-Tower

-

Welcome to Dice-Tower

-
+
+

Dice-Tower

+


+