Chaturbate Hangman Bot

Short Description:

Chaturbate Hangman Bot

Full Description

A fun, interactive Hangman game bot for Chaturbate that allows viewers to play the classic word-guessing game in chat.

## Features

- Three difficulty levels with different word lists
- Custom words set by broadcaster
- Configurable prizes for winners
- ASCII art hangman display
- Broadcaster and moderator controls
- Automatic or manual game start
- Configurable cooldown between games
- Tip requirement to play (optional)
- Configurable guesses per tip amount
- Bonus guesses for generous tippers
- Easy to use with simple chat commands

## Setup

1. Log in to your Chaturbate account
2. Go to your Chaturbate Apps & Bots section
3. Create a new app and paste the code from `hangman-bot.js`
4. Configure the settings according to your preferences
5. Activate the bot

## Configuration Options

| Setting | Description | Default |
|---------|-------------|---------|
| Word Difficulty Level | Choose from Easy, Medium, or Hard word lists | Medium |
| Allow broadcaster to set custom words | Enable broadcaster to set custom words for games | Yes |
| Maximum wrong guesses | Number of wrong guesses allowed before game over (3-10) | 6 |
| Cooldown between games | Time in seconds between games (0-300) | 60 |
| Allow moderators to control the game | Let moderators start/stop games | Yes |
| Start a game automatically after setup | Begin a game immediately upon activation | Yes |
| Tokens required to play | Number of tokens users must tip to play (0 = anyone can play) | 5 |
| Guesses per tip amount | Number of guesses a user gets for each tip at the required amount | 3 |
| Give bonus guesses for higher tips | Award extra guesses when users tip larger amounts | Yes |
| Allow mods to play without tipping | Let moderators participate without tipping | Yes |
| Prize 1-5 | Prizes that winners can choose from | Various defaults |

## Commands

### For Everyone
- Type any single letter to make a guess
- `!guess [word]` - Guess the entire word
- `!hangman help` or `!hm help` - Display help information
- `!prize [number]` - Select a prize (winners only)
- `!guesses` - Check how many guesses you have remaining

### For Broadcasters and Moderators
- `!hangman start` or `!hm start` - Start a new game
- `!hangman stop` or `!hm stop` - Stop the current game

### For Broadcasters Only
- `!setword [word]` - Set a custom word for the next game

## How the Game Works

1. When a game starts, the bot selects a random word based on the difficulty level (or uses a custom word set by the broadcaster)
2. The word is displayed as underscores (e.g., `_ _ _ _ _`)
3. Viewers tip the required amount to become eligible to play and receive guesses
4. Each tip at the required amount gives the tipper a set number of guesses (configurable)
5. Eligible viewers guess letters by typing a single letter in chat (using one guess per attempt)
6. If the letter is in the word, it will be revealed in the display
7. If the letter is not in the word, it's counted as a wrong guess and the hangman drawing progresses
8. The game ends when:
- A player guesses all the letters correctly
- A player guesses the complete word correctly
- The maximum number of wrong guesses is reached
9. The winner gets to choose from the available prizes

## Custom Words

The broadcaster can set custom words for the Hangman game:

- Use the command `!setword [word]` to set a custom word for the next game
- The word will only be used for the next game, then revert to random words
- Only the broadcaster can set custom words
- Setting custom words allows for themed games or specific content relevant to your audience
- The custom word feature can be disabled in the bot settings

## Prize System

The bot includes a customizable prize system:

- Configure up to 5 different prizes in the bot settings
- When a player wins, they can choose one of the available prizes
- Winners select their prize by typing `!prize [number]` (e.g., `!prize 2`)
- The broadcaster is responsible for fulfilling the prize
- Prizes can be anything you want to offer: photos, videos, private shows, etc.
- All available prizes are displayed at the start of each game and in the room subject

## Tip and Guess System

The bot includes a configurable tip and guess system:

- Set the "Tokens required to play" option to any value above 0 to enable tip requirements
- Configure how many guesses each player gets per tip using the "Guesses per tip amount" setting
- Enable bonus guesses for higher tips to reward generous tippers
- Players who tip 5x the required amount get double the guesses
- Viewers must use one guess per letter or word attempt
- When a player runs out of guesses, they need to tip again to continue playing
- Players are notified when they're running low on guesses (3 or fewer remaining)
- If a player tries to guess a letter that was already guessed, they don't lose a guess
- The broadcaster can always play regardless of tips/guesses
- Moderators can play without tipping if the "Allow mods to play without tipping" option is enabled
- Guesses are reset between games
- Players can check their remaining guesses with the `!guesses` command

When a viewer attempts to make a guess without remaining guesses, they'll receive a message reminding them to tip for more guesses.

## Limitations and Notes

- The bot uses the room subject to display the game state, which will replace any existing room subject
- The word lists are predefined, but you can modify them in the code if desired
- Only broadcasters and moderators can start or stop games (unless configured otherwise)
- Each letter can only be guessed once
- Setting the tip requirement to 0 allows everyone to play without tipping

## Customization

You can customize the bot by editing the following parts of the code:

- Word lists: Modify the `wordLists` object to add/remove words for each difficulty level
- Hangman ASCII art: Edit the `drawHangman` function to change the visual representation
- Colors: Change the color codes in the `cb.sendNotice` calls
- Tip requirements: Adjust the settings for different tipping thresholds
- Guesses per tip: Configure how many guesses players get per tip and the bonus system
- Prizes: Configure up to 5 custom prizes in the bot settings

## Support

If you encounter any issues or have suggestions for improvements, please create an issue on GitHub.

Enjoy your Hangman bot!