RollHelper is an Android application designed to help tabletop gamers with their dice rolls. Built with Jetpack Compose and Material Design 3, the app provides an intuitive, visually appealing interface for selecting dice types, rolling them, and viewing the results. It's a handy tool for Dungeons & Dragons (D&D) players and other tabletop RPG enthusiasts who want to simplify dice rolling and keep track of their roll history.
Rollhelper is now awaiting Google's final approval before becoming available on Google Play Store.
- Select Dice Type and amount: Choose from a range of dice types (D4, D6, D8, D10, D12, D20).
- Animated Dice Rolls: Visualize the rolling process with smooth animations.
- Roll History: Keep a record of your recent rolls.
- User-Friendly Interface: A clean and simple design built with Jetpack Compose and Material Design 3.
- Stat & proficiency modifiers: User can choose to add ability score modifiers, proficiency modifier and even expertise.
To run the RollHelper app locally, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/RollHelper3.git
-
Open the project in Android Studio:
- Ensure you have the latest version of Android Studio installed.
-
Build the project:
- Sync the Gradle files and build the project.
-
Run the app:
- Connect an Android device or use an emulator, then click the 'Run' button in Android Studio.
- Select Dice Type: Click on any dice type chip (D4, D6, D8, D10, D12, D20) to select the type of dice you want to roll.
- Set Dice Count: Use the slider to adjust the number of dice to roll.
- Roll the Dice: Press the "Roll" button to see the animated result of your roll.
- View Roll History: Scroll down to see a list of your most recent rolls and their results.
- Kotlin: The primary language used for development.
- Jetpack Compose: Android’s modern toolkit for building native UI.
- Material Design 3: For consistent UI components and theming.
- Coroutines: For managing asynchronous operations and concurrency.
- Snackbar: To display brief messages at the bottom of the screen.
- Minor fixes: Fix issues regarding light vs darkmode.
- Sound Effects: Might add a dice rolling sound.
- Optimization: Improve dice animations and general app optimizing.
- API updates: Updating app to meet Google's API requirements.
- Thanks to the open-source community for the libraries and tools that made this project possible.
- Thanks to Robert Brooks - gamedeveloperstudio.com for allowing usage of purchased dice files.
- Inspiration from the Dungeons & Dragons and tabletop gaming community.
Some image assets used for dice animations and stills (located in assets/dice/) are intentionally excluded from the public repository via .gitignore. These files include proprietary content licensed from third-party creators and cannot be redistributed.
If you are a collaborator or contributor and require access to these assets for development purposes, please contact the maintainer directly.
This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. See the LICENSE file for more details.
© 2024, Christian / Nozdub. All rights reserved.