Skip to content

Commit 20b4580

Browse files
authored
Create README.md
1 parent a3e2e50 commit 20b4580

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# [AIO] Gamba Suite
2+
3+
Gamba Suite is a powerful tool for managing, rolling, and resetting dice with automated poker, 13/21 & Tri hand evaluation and game interaction.
4+
5+
## Features
6+
7+
- Manage multiple dice: Handle operations involving multiple dice, including adding, removing, and tracking their states.
8+
- Roll and reset dice: Simulate rolling dice and resetting them to their initial state.
9+
- Automatically evaluate poker hands: Determine the value of poker hands based on the rolled dice.
10+
- Automatically evaluate tri sum: Calculate the sum of three dice and evaluate specific conditions or outcomes.
11+
- Automatically evaluate 13 sum: Rolls two dice and calculates their sum. If the sum is less than 7, it will roll additional dice, recalculating the sum with each new roll until the sum is 7 or higher.
12+
- Automatically evaluate 21 sum: Rolls three dice and calculates their sum. If the sum is less than 15, additional dice will be rolled, with recalculations after each roll until the sum is 15 or higher.
13+
14+
## Installation
15+
16+
1. **Clone the repository:**
17+
18+
Open your terminal and clone the repository using the following command:
19+
20+
```bash
21+
git clone https://github.com/JTD420/gamba-suite.git
22+
```
23+
24+
2. **Navigate to the project directory:**
25+
26+
Change your working directory to the project's directory:
27+
28+
```bash
29+
cd Gamba-Suite
30+
```
31+
32+
3. **Build the project:**
33+
34+
Use the `go build` command to build the project:
35+
36+
```bash
37+
go build
38+
```
39+
40+
4. **Run the project:**
41+
42+
After building, execute the project with:
43+
44+
```bash
45+
./Gamba-Suite
46+
```
47+
48+
## Usage
49+
50+
### Setup
51+
52+
1. **Run the Project:**
53+
54+
After executing `./Gamba-Suite`, the application will start running.
55+
56+
2. **Initialize Dice:**
57+
58+
To set up, simply doubleclick all the dices. The program will record the dice in the order they were rolled. After setup is complete, you can begin using the available commands.
59+
60+
61+
### Chat Commands
62+
63+
- `:roll` - Rolls all dice used in poker and announces the results of their values.
64+
- `:tri` - Rolls all dice used in the tri game and announces the total sum of the three dice.
65+
- `:13` - Rolls all dice used in the 13 sum game and announces the total sum once it is 7 or higher.
66+
- `:21` - Rolls all dice used in the 21 sum game and announces the total sum once it is 15 or higher.
67+
- `:verify` - Re-announces the most recent total sum for 13/21 in chat. Useful if the user was muted during the original announcement.
68+
- `:close` - Closes all dices.
69+
- `:reset` - Clears any previously stored dice data for a fresh start.
70+
- `:chaton` - Enables announcing the results of the dice rolls.
71+
- `:chatoff` - Disables announcing the results of the dice rolls.
72+
- `:commands` - View a hotel alert with all available commands.
73+
74+
## Contributing
75+
76+
Contributions are welcome! Please submit a pull request or open an issue to discuss any changes.
77+
78+
## License
79+
80+
This project is licensed under the MIT License.
81+
82+
```
83+
84+
Feel free to customize the content according to your needs.
85+
```
86+
87+
## Special Thanks
88+
89+
Special thanks to Nanobyte for his original [poker](https://github.com/boydmeyer/poker) Extension <3

0 commit comments

Comments
 (0)