UltimateCards Reloaded

Quick Installation Guide

1. Download the latest version of UltimateCards from here.
2. Download the latest version of Vault from here.
3. Drag both files into your plugins directory on your server.
4. Run the server, and an UltimateCards directory should be created (plugins/UltimateCards)
5. Open the config.yml file in that folder and configure any options.
6. Open the tables.yml file and change the initial default tables
7. Restart the server.

Quick poker playing guide

1. /table new MyTable 1000 poker - This will create a poker table, named MyTable, and buy you in for 1000.
2. /table listsettings - List all available settings for your poker table.
3. Set a few settings, if you so desire, by using /table set [setting] [value]. For example, if you want to display turns publicly, do /table set displayTurnsPublicly true.
4. Once you are ready for people to join, use /table open.
5. Gather all your players around your table. It is recommended that you build an actual table with a few chairs, for role playing purposes and generally better atmosphere while playing. Then, tell your players to join by doing /table sit [your table ID] [buyin]. You can check your table ID with /table list. Alternatively, you may /table invite [player name] all of your players.
6. All players at the table should have received a map, which is used as an on-screen helper GUI (see below). If you had no space in your inventory upon joining the table, the map would have dropped in front of you. You may not throw or move this map.
7. Start the table with /table start. Play the hand using the /poker commands.
8. At the end of each hand, you will be paid a rake of the final pot. New hands start automatically - if they start too fast, change the autoStart setting or turn it off to allow more time for your players to get ready. Things like adding more money to your stack are only possible in-between hands.
9. When you are done playing, /table delete to return the remaining stacks of each player and delete the table.

Quick blackjack playing guide

1. /table new MyTable 1000 blackjack - This will create a blackjack table, named MyTable, and buy you in for 1000. You can also say "bj" instead of "blackjack".
2. /table listsettings - List all available settings for your blackjack table.
3. Set a few settings, if you so desire, by using /table set [setting] [value]. For example, if you want to display turns publicly, do /table set displayTurnsPublicly true.
4. Once you are ready for people to join, use /table open.
5. Gather all your players around your table. It is recommended that you build an actual table with a few chairs, for role playing purposes and generally better atmosphere while playing. Then, tell your players to join by doing /table sit [your table ID] [buyin]. You can check your table ID with /table list. Alternatively, you may /table invite [player name] all of your players.
6. All players at the table should have received a map, which is used as an on-screen helper GUI (see below). If you had no space in your inventory upon joining the table, the map would have dropped in front of you. You may not throw or move this map.
7. Start the table with /table start. Play the hand using the /blackjack (or /bj) commands.
8. New hands start automatically - if they start too fast, change the autoStart setting or turn it off to allow more time for your players to get ready. Things like adding more money to your stack are only possible in-between hands.
9. When you are done playing, /table delete to return the remaining stacks of each player and delete the table.

All commands are separated into 4 groups:

• /table - Used for table creation, deletion, management and customization, including player joining/leaving etc.
• /cards - Alias for /table
• /poker - Used for playing poker
• /blackjack or /bj - Used for playing blackjack

Here is a list of them all. Pipe | means it's an alias, so you can type either /table create or /table new. Parameters in brackets () are optional, in square brackets [] they are required.

Remember that there is usage help available on every command in-game through the use of /table help [command]!

/table | /cards
Table managment

• ban | b [player name] - Bans the specified player from your table, disallowing them to join until you unban them.
• close | lock | c - Closes your table and doesn't allow other to sit down.
• create | new | cr [name] [buyin] [gametype] - Creates a table and buys you in for the specified amount.
• delete | del | d - Deletes your table and returns money to everyone sitting at it. Returns money.
• kick | boot | k [player ID] - Kicks the specified player from your table. Returns their money.
• listsettings | ls - Lists all available table settings available for your current table.
• open | unlock | o - Opens your table and allows others to sit down.
• set [setting] [value] - Sets your table's [setting] to the specified [value].
• start | go | s - Deals the next hand.
• unban | pardon | forgive | u [player name] - Unbans the specified player from your table.
• save - Saves a table permanently.
• unsave - Deletes a saved table permanently.
• relocate - Changes a table's location to wherever you are standing.

Table interaction

• details | info | d (table ID) - Displays details of either your own table or the specified table.
• invite | i [player name] - Sends a message to the specified player, inviting them to join.
• leave | getup | stand | standup - Leaves your table and returns your money.
• money | balance | m - Displays the size of your stack.
• players | listplayers | lp (table ID) - Lists all players sitting at your table or the specified table, including their stacks, status and more.
• rebuy | addmoney | addstack | r [amount] - Adds the specified amount to your stack.
• sit | join | s [table ID] [buyin] - Sits you at the specified table with the specified buy-in. If you have permissions, teleports you to the table.
• tables | list | l - Lists all created tables, their open/closed status, and their ID.
• teleport | tp [table ID] - Teleports you to the specified table ID.
• withdraw | cashin | w [amount] - Withdraws the specified amount of money from your stack.
• reload - Reloads the plugin configuration.

• help (command) - Gives help on the specified /table command, or lists all commands.

/poker

• cards | hand - Displays your hand.
• reveal | show | display - Shows your hand to all the people around you.
• allin | shove | a - Puts you all in/bets your whole stack.
• bet | b [amount] - Bets/raises TO the specified amount.
• board | community - Displays your table's community cards.
• call | match | ca - Calls.
• check | ch - Checks.
• fold | muck | f - Folds your hand.
• pot | pots | p - Displays all pots on this table.
• help (command) - Gives help on the specified /poker command, or lists all commands.

/blackjack

• hit | hitme | hit (hand ID) - Gives you an additional card.
• stand | stay | s (hand ID) - Stands.
• bet | b [amount] - Bets the specified amount, and allows you to play the next hand.
• split | sp - Splits your hand into two separate hands.
• doubledown | double | dd - Doubles your bet and gives you an additional card.
• help (command) - Gives help on the specified /blackjack command, or lists all commands.

List of features

• Automatic card dealing
• Automatic community card dealing
• Automatic side pot creation
• Automatic hand evaluation
• Automatic payouts to winners
• Amazing, completely vanilla (no plugins required) on-screen GUI
• Great sound effects for new turns, wins and losses! (no plugins required)
• Players can teleport to tables
• Player chip stacks are handled by the plugin
• Players can create tables
• Players can customize various settings in their tables
• Players can invite, kick, ban people from their tables
• Players can permanently save their created tables to remain after server resets
• Customizable player turn timer
• Supports most economy systems
• All Texas Holdem playing mechanics integrated:
  • Betting
  • Calling
  • Folding
  • Checking
  • All-ins and side pots
  • Hand revealing
  • Pot paying
• All Blackjack playing mechanics integrated:
  • Betting
  • Hitting
  • Standing
  • Splitting
  • Double Down
• And much more!

The plugin comes with an on-screen GUI which uses maps to provide a sleek, interactive user experience without need for any extra mods or plugins.

Poker GUI
Player status legend:
N - Normal
F - Folded
A - Action
The red mark in the corner of a player's status box indicates the dealer button.

Blackjack GUI
Player status legend:
N - Normal
S - Stayed
A - Action

• ucards - Gives access to all commands.
• ucards.table - Gives access to all /table commands.
• ucards.cards - Gives access to all /cards commands.
• ucards.poker - Gives access to the /poker commands.
• ucards.blackjack - Gives access to the /blackjack commands. OPs automatically get the ucards node.
  
  In addition to those permissions, a permission node exists for every single command. These nodes are formed as follows:
  
  ucards.commandgroup.command
  
  For example:
  
  ucards.table.teleport - Node for /table teleport.
  
  
  The full command name needs to be used for these nodes to work.
  
  Nobody (except OPs) get any permissions unless you give it to them through your permission system. You should be able to use ANY permission system and it will work.

This is the default configuration file (config.yml) for the plugin. If your configuration file is missing one of these options (probably due to a plugin update), please add them in. If not, the plugin will take these default values.

options:
  general:
    autoUpdate: true #Auto-update the plugin
    cleanupOnDisable: true #Upon server reload/disable, remove all tables and return money
    disableCommandsWhilePlaying: false
    preventMovementOutsideChatRange: true
  log:
    enableLog: false #log.txt in /UltimateCards/ folder
    dateFormat: 'dd/MM/yyyy HH:mm:ss'
  chat:
    displayTag: true #[UC] tag in front of every message
    #Custimize message colors
    colorTag: '&1'
    colorNormalMessage: '&f'
    colorErrorMessage: '&c'
    colorHighlight: '&6'
  generalDefaults: #Upon creating any table, these will be the default settings
    allowRebuys: true
    displayTurnsPublicly: false
    autoStart: 0
    minBuy: 0
    maxBuy: 100000
    publicChatRange: 30
    turnSeconds: 60
    autoKickOnLeave: false
  poker: #Upon creating a poker table, these will be the default settings
    fixRake: -1  #-1 allows players to set the rake, 0 or positive numbers fix the rake to that amount (players won't be able to change it)
    defaults:
      minRaiseIsAlwaysBB: true #If true, the min-raise will simply be the big blind
      sb: 500
      bb: 1000
      ante: 0
      dynamicFrequency: 0
      rake: 0.05
      minRaise: 200
  blackjack: #Upon creating a blackjack table, these will be the default settings
    defaults:
      allowDoubleDown: true
      minBet: 100
      amountOfDecks: 5
The plugin also comes with a default tables.yml file. This file specifies saved tables. EDIT THIS FILE BEFORE USING THE PLUGIN

EditYourConfig:
    gameType: poker
    owner: "SomeAccount" #Rake from every hand (if enabled) will be deposited into SomeAccount's money account
    location: ["world",0,0,0]
    settings:
        allowRebuys: true
        displayTurnsPublicly: false
        autoStart: 0
        turnSeconds: 60
        minRaiseIsAlwaysBB: true
        minBuy: 0
        maxBuy: 100000
        sb: 500
        bb: 1000
        ante: 0
        dynamicFrequency: 0
        rake: 0.05
        minRaise: 200
        autoKickOnLeave: true
EditYourConfig2:
    gameType: bj
    owner: "SomeAccount" #All dealer winnings will be deposited into SomeAccount's money account, leave as '' (blank, two single apostrophes) for the server to gain all winnings.
    location: ["world",100,0,100]
    settings:
        allowRebuys: true
        displayTurnsPublicly: false
        autoStart: 0
        turnSeconds: 60
        allowDoubleDown: true
        minBet: 100
        amountOfDecks: 5
        autoKickOnLeave: false