Fortuna
IRC [Wheel of] Fortune bot
Documentation
{Intro | Rules | Commands | Etc}
Intro
A few words before we start...
Written because a certain someone *cough cough* was both not maintaining his bot and requesting money for the source to be publically released,
Fortuna is an IRC bot that plays games similar to Wheel of Fortune (with a few differences).
It supports games with less than three players (and potentially games with more than three players, if demand warrants such);
the ability to use custom game layouts to alter the wheel, timing of rounds/tossups, bonus prizes, etc.;
and multiple games running concurrently on multiple separate channels.
You can find Fortuna on irc.badnik.net, primarily in the channel #fortune.
What's missing
- Supplemental questions (questions asked after the puzzle is solved) aren't supported yet. This means there's no "CLUE" category.
- You currently are not required to win the round you obtain the ONE MILLION
or $UPER BONU$ wedges on. (This might stay as a 'feature'.)
What's bugged
- Introductions for players in 5/6 player games don't work right. Whatever.
What might be bugged
Open source?
Well ... it is now.
The source is available on GitHub, though keep in mind it requires the XIRC2 Base to run.
{Intro | Rules | Commands | Etc}
Rules
#todo
If you've seen Wheel of Fortune in any of its incarnations, you should have at least a basic idea of what's going on. If not, well, I'll eventually write something up here.
Spaces
- Cash
$400
$5000
These wedges are the ones you'll be seeing the most when you play Fortune, obviously. Land on one of these and you'll be asked to pick a consonant.
If it's in the puzzle (and hasn't already been revealed -- kinda important), you'll receive the amount the square is worth; times however many letters were in the puzzle.
- LOSE A TURN
Land on this and you lose your turn. Do not pick a consonant, do not pass Go, do not collect $200, go directly to the next player's turn.
If you're curious, two of these wedges exist in rounds one through three, and only one of them exists in round four and beyond.
- BANKRUPT
The well-known big brother to Lose A Turn, this not only costs you your turn, but all your assets in the current round.
Again, for the curious folks, every round has exactly one of these wedges, and the ONE MILLION / $UPER BONU$ wedges
contain 1/3 width BANKRUPT wedges on their sides that disappear when they are picked up.
- Prizes
TRIP ($5,718)
FURNITURE ($2,901)
These wedges are randomized at the start of every game and are worth random amounts of money. You can pick them up by successfully picking a letter while on them, as you'd expect.
It's worth noting that prizes do not count towards your available funds, only your overall winnings if you finish the round holding one of them. This means that you cannot use the money earned from a prize to buy a vowel.
Also, you don't get awarded multiple prizes if more than one of the letter you picked shows up in the puzzle - you only get one prize. Try not to pick extremely common letters!
- FREE PLAY
This wedge normally works like a $500 cash space, but it has a few perks to it; namely, you don't have to guess a consonant at all.
You are allowed to pick a vowel while on this wedge, and while this won't earn you any money, it will not cost you any money either.
The other minor perk of this wedge is that you cannot lose your turn while calling a letter on it -- in other words, guessing a letter not in a puzzle, or repeating a letter that's already been picked will not cost you your turn.
- Mystery Wedges (?) $1000
These wedges work like $1,000 cash spaces when you first land on them, but successfully guessing a letter gives you the opportunity to pick the wedge up and flip it over (like a prize, no less).
A $10,000 bonus could be under the wedge, or it could be BANKRUPT instead... Either way; once one of them is flipped over, the other one acts as a regular $1,000 cash space for the rest of the round.
- ONE MILLION
Available in rounds one through three, on a narrow space (1/3 width) surrounded by BANKRUPT s.
Land on it, and you get to pick it up. Take it through the entire game (in other words, don't hit any more BANKRUPTs for the rest of the game), and the top prize becomes $1,000,000.
Of course, your chances of winning it are still 1/24, so good luck with that.
- $UPER BONU$
Unique to this game, only available after round four starts. Similar to the $1,000,000 wedge, this wedge is narrow and surrounded by BANKRUPT s.
Carrying this through to the end of the game doubles all of the prize values, leading to a maximum bonus of $200,000... or if you're somehow carring the million dollar wedge too, $2,000,000.
- WILD CARD
Available in rounds one through three. Pick up this wedge and it'll allow you to use the !wildcard command.
Upon use, you can guess another consonant without spinning the wheel again, at the same dollar value. You can't use it unless you just earned money from a cash space though -- no repeat prizes, no leeching off of someone else landing on $5000.
As a separate bonus, if you keep it until the game ends, you get one extra consonant to help you solve the Bonus Round puzzle.
- DOUBLE $$ PLAY
A relic from an ancient era; available only after round four starts. Pick up this wedge and it'll allow you to use the !doubleplay command.
Upon use, you will spin the wheel automatically, and any cash value you land on will be doubled ($400 -> $800; $5,000 -> $10,000; etc.).
Of course, if you land on BANKRUPT or LOSE A TURN , it's wasted.
{Intro | Rules | Commands | Etc}
Commands
Outside of a game
- !player [name]
Gives you information on a player, or yourself if you omit the player name.
- !stats
Lets you see various game statistics, like how much (fake e-)money has been given out to date.
- !spin
If no game is running in a channel Fortuna is in, you can freely spin the wheel and try your luck.
The open wheel currently uses the default Round 3 configuration.
- !top [score / money / solo]
Shows the top five players, sorted by a specific statistic. By default, sorts by total money won overall; but this can be changed to top single-game winnings or top solo winnings.
- !fortune [-players (player limit)] [-solo] [-rounds (round limit)] [-time (time limit)] [-minimum (minimum round winnings)] [-layout (layout)] [-wheel]
Starts a new game of Fortune, or enters you into one if there is a game waiting for players.
-players lets you change the maximum player limit of the game from 2 to 6. This lets you play with just one friend, or with a whole party of people. Games with more than three players are not recommended, however.
-solo puts the game into a special one-player mode that tasks you with going as far into the game as possible with a set amount of turns.
-rounds lets you change the maximum round number that will be reached, from unlimited to twenty (0-20). Default is 6.
-time lets you change the amount of time that it will take for the final bell to ring, from never to one hour (0-3600). Default is 20 minutes (1200).
Note that you cannot set both -rounds and -time to 0, for hopefully obvious reasons.
-minimum lets you change the minimum round winnings from none to $10,000 (0-10000). If a player finishes a round with less than this amount of cash on hand, it is bumped up to this amount instead. Default is 1000.
Note that using any of -rounds, -time, or -minimum will disqualify your game from rankings.
-layout lets you use a wheel/prize/game setting layout different from the default ("regular"). A list of layouts will be available in the future.
-wheel will display the full wheel after every spin, like if !wheel is typed. Note that this doesn't work well unless you use a fixed-width font. I'd recommend against doing this, anyway.
- !leave
If you want to leave the game before it starts, use this command. If no players are left (i.e. you were the only one waiting for a game), the game will be ended.
Toss-up
- ! [answer]
!solve [answer]
Lets you buzz in, giving you 20 seconds to solve the puzzle (locking everyone else out in the meantime).
You can optionally give the answer when buzzing in instead of using the 20 seconds to type it in afterwards, though this is not recommended.
During a round, for anyone in game
- !puzzle
Re-shows the current puzzle, in case you forgot or haven't seen it in a while.
- !letters
Shows what letters have not been used, with vowels marked in red.
- !scores
Shows the amount of money all players have in the current round, and the JACKPOT bonus as well if necessary. The 'podium' of the person who's currently taking their turn is brighter than the others.
- !overall
Shows the current amount of banked money each player has. The 'podium' of the person in the lead is brighter than the others.
- !turn
Simply outputs the name of the player who is currently taking their turn.
- !wheel
Shows the exact position of the wheel, and some of the surrounding area, in case you're curious just how close you were to the ONE MILLION space. Note that this doesn't work well unless you use a fixed-width font.
During a round, for the player taking a turn
- !s
!spin
Spins the wheel. If you land on something other than BANKRUPT or LOSE A TURN , prompts you for a letter afterwards.
- !b [vowel]
!buy [vowel]
Allows you to buy a vowel, if you have $250 to spare.
You don't have to give the vowel you want to buy immediately, but it's nice to do so.
- !v [answer]
- !solve [answer]
Gives you 20 seconds to solve the puzzle, just like in the toss-up mode.
Once again you can optionally give the answer in the command itself. This isn't as bad of an idea as it was before, however; since everyone else has to wait their turn to solve the puzzle anyway.
- !w [consonant]
!wc [consonant]
!wildcard [consonant]
If you have a WILD CARD on hand, you can use it by doing this. See the rules section for more info on what the Wild Card does.
Giving the consonant in the command isn't required, but again it's nice to do so.
- !d
!dp
!doubleplay
If you have a DOUBLE $$ PLAY card on hand, you can use it by doing this; the wheel is spun automatically afterwards for you. See the rules section for more info on what the Double Play does.
Operator only commands
- !endgame
Terminates the currently running game in the channel immediately. Statistics will not be saved. Requires chanops to use, at minimum.
- !skip
Stops whatever the game is currently doing and advances on, discarding money, etc. Requires chanops to use, at minimum.
Notes
- To prevent outsiders from disturbing the game too much, you have to be in a game to use any of the round commands (even the ones that don't require it to be your turn).
{Intro | Rules | Commands | Etc}
Etc
???