Subscribe to download
Sort Hand Tool

This tool allows any player to sort their hand easily and instantly.

• Trigger via scripting hotkey (Default: NumPad 1) or by manually clicking tile
  
• Customizable sort order
  
• Customizable group methods (e.g. all suits together, all numbers together, ignore suit)
  
• Customizable for any type of deck (i.e. not limited to normal playing cards)
  
• One tool for the entire table, or individual tools so each player can use their own preferred sort order
  
• You can set up multiple sort configurations in a single tool (including for multiple deck/game types)!
  
• Pre-labeled deck included

• Expects a standard deck by default (don't worry, you can use this with any deck, not just normal playing cards) with the card value in the Name field (e.g. "Ace", "Two", "Three", etc...) and the suit in the Description (e.g. "Diamond", "Heart", etc...). A pre-labeled deck is included.
  
  
• Scripting hotkey to trigger is Numpad 1
  
  
• Sorts deck in new-deck order - all suits together, face-up order: Jokers, followed by A-K (spades, diamonds, clubs, hearts)
  
  
• One tool works for the entire table

The top of the object script has all the customization settings.


There are two reference card order tables - one for values and one for suits. These represent the left-to-right order when looking at your hand of how you want the cards to be sorted.

refCardOrder:
Order of card values (as you want them to appear from left to right). These are values that would be in the card Name.

refSuitOrder:
Order of card suits (as you want them to appear left to right). These are values that would be in the card Description.


Grouping is keyed on the reference suit table, and the grouping mode is set via groupSuitMode.

0: Ignore suits (this can also be used when you're using cards that don't need a second piece of information, so the Description fields are blank)
1: All suits are together
2: All card numbers are together


Note: The suits "BW" and "Color" are used to distinguish between the two Jokers (color vs black/white).



New-Deck Order:

groupSuitMode = 1
refCardOrder = {"King", "Queen", "Jack", "Ten", "Nine", "Eight", "Seven", "Six", "Five", "Four", "Three", "Two", "Ace", "Joker", }
refSuitOrder = {"Heart", "Club", "Diamond", "Spade", "BW", "Color", }

The above settings will result in a sort that looks like this[i.imgur.com].


Ding Pai Order (i.e. Fours are high and suit order from low to high is diamonds, clubs, hearts, spades):

groupSuitMode = 2
refCardOrder = {"Joker", "Four", "Three", "Two", "Ace", "King", "Queen", "Jack", "Ten", "Nine", "Eight", "Seven", "Six", "Five", }
refSuitOrder = {"Spade", "Heart", "Club", "Diamond", "BW", "Color", }

The above settings will result in a sort that looks like this[i.imgur.com].



You can customize this tool to work with any type of deck, not just normal playing cards.

Essentially, this does a two-level sort using the card Name as the main key and card Description as the grouping key.


An example is provided for Uno (covering some of the specialized editions).

groupSuitMode = 1
refCardOrder = {"Oogie Boogie", "Invisibility", "Howler", "Draw 4", "Draw 3", "Draw 2", "Wild", "Reverse", "Skip", "Nine", "Eight", "Seven", "Six", "Five", "Four", "Three", "Two", "One", "Zero", }
refSuitOrder = {"Wild", "Blue", "Green", "Red", "Yellow", }

The above settings might result in a sort that looks like this[i.imgur.com]. (Note that this only shows a partial hand, not the entire deck, due to the deck size.)



By default, a single tool will work for the entire table.

However, you can spawn additional tools and customize them with different sort settings.


There are two ways to configure the triggering for multiple tools with different sorting options:

1. One tool for most people to use (supports the scripting hotkey), and the exceptions trigger the minority tool(s) by clicking the tool's button.
   
   
2. Each player gets a sorting tool. In this case, set the description of each tool with their player's color. This way, everyone can use the scripting hotkey but will only trigger their own sorting tool.

You can set up multiple sort configurations within a single tool, which can even span different deck/game types!

1. Start by creating a different Sort Hand tool for every configuration you want.
   
2. Select them all. The order of the states will be based off of the order in which they are highlighted.
   
3. Right click the one you want to be the primary state and choose "Create States" from the menu.
   
4. Done! Now they are all combined into a single tool with multiple states. You can switch between them either through the right-click menu or just by hovering your cursor over it and pressing the number of the state you want (e.g. "1", "2", "3", etc...)!

See the mod's screenshots for an example of what this will look like. The sample image shows a single tool made up of 4 states which I referenced earlier as sorting examples - New Deck Order, Ding Pai, Ding Pai Reversed, and Uno.


This tool has a lot of flexibility - how you use it is up to you!


p.s. If you like this mod, please give it a thumbs up!