TCG Assistant is a Flutter-based mobile application designed to assist players of Trading Card Games (TCGs) with various utilities such as dice rolling, coin flipping, and life point tracking. This README provides an overview of the app, its features, and how to get started with the codebase. It works well on Android, but has not been tested on iOS. Feedback is welcome on this.
Features
TCG Assistant provides the following features: Dice Roller: Simulate dice rolls with sound effects for games that require random outcomes or to determine who plays first. Coin Flipper: Simulate coin flips with sound effects for similar reasons as above. Life Point Tracker: Keep track of life points for games like Yu-Gi-Oh! and Magic: The Gathering. Sound Settings: Toggle sound effects on/off.
Getting Started
To get started with the TCG Assistant app codebase, follow these steps:
Prerequisites:
Flutter: Make sure you have Flutter installed. You can download it from the official Flutter website: https://docs.flutter.dev/get-started/install
Android Studio: I used Android Studio to develop this and test it on emulated as well as physical Android devices. You can download it from the official Android Studio website: https://developer.android.com/studio
Installation
Clone the GitHub repository: git clone https://github.com/yourusername/tcg-assistant.git
Navigate to the project directory: cd tcg-assistant
Install the app's dependencies: flutter pub get
Running the App
You can run the app on an emulator or physical device. Use the following command to start the app: flutter run
Usage
Once the app is running, you can access its features by navigating through the app's interface. Here's a brief overview: Dice Roller: Tap the dice images to simulate rolls. Coin Flipper: Tap the coin image to simulate a coin flip. Life Point Tracker: Use this feature to track life points during TCG matches. Sound Settings: Adjust sound settings, including mute.
Issues
If you encounter any bugs or have suggestions for improvements, please open an issue on the GitHub repository. Be sure to include detailed information about the problem you're experiencing.