Typist mod for Balatro

this mod is an implementation of fully keyboard-driven UX for Balatro. it adds keybindings for all of the gameplay actions, and includes code from DorkDad141's Keyboard Shortcuts & FlushHotkeys for quickly selecting the best hand available or making flush & high card hands -called "the cheat layer" in typist-. join the discussion on the official Balatro discord: typist's thread, server invite

video demo

installation

the only dependency is the lovely code injector, which is also a dependency of the Steamodded mod loader, so if you have smods you can just drop this repo into your Mods directory and it'll get picked up. if not then follow the first two steps of Steamodded's "How to install Steamodded" guide, namely "Step 1: Anti-virus setup" and "Step 2: Installing Lovely", then download the mod (either with git clone or from the green "Code" button at the top of the page) and save it to the appropriate directory for your platform:

• windows: %AppData%/Balatro/Mods
• mac: ~/Library/Application Support/Balatro/Mods
• linux+wine/proton: ~/.local/share/Steam/steamapps/compatdata/2379780/pfx/drive_c/users/steamuser/AppData/Roaming/Balatro/Mods

compatibility

game versions:

• 1.0.1n
• 1.0.1o

other mods:

• WilsontheWolf/DebugPlus v1.4.x
  • hold ctrl as a leader for the entire keyboard except typist and debugplus.console if the game is in debug mode
• V-rtualized/BalatroMultiplayer v0.1.8.4, versions 0.2.x, and the private 1.0 alpha
  • on pvp blinds space toggles the ready state instead of immediately starting the blind
  • in lobby menu space starts the run (if you're the host)
• Amvoled/Taikomochi rev 26d2507
  • enter on the game over screen retries the last ante for zen mode runs
• Agoraaa/FlushHotkeys 4c0b1df
  • FlushHotkeys keyboard shortcuts are removed to prevent conflicts
  • FlushHotkeys' select_best_hand implementation is used instead of mine (will be removed in the future)

feature overview

• toggling hand cards with asdfgh... keys
• a complete implementation of every action in every game state, with
  • space being generally the "proceed" button:
    • it plays the selected hand
    • selects the upcoming blind
    • uses consumable cards
    • selects the highlighted pack item
    • starts a new run from the game over screen
  • tab being the dismiss button:
    • it discards the selected hand
    • moves from the shop to blind selection
    • sells consumable or joker cards
    • skips the current booster pack
    • closes any overlay menu
    • exits to main menu from the game over screen
  • the bottom row of the keyboard as the "control panel", for example:
    • in rounds:
      • hold z for the quick deck preview
      • press , to select the leftmost 5 cards
      • . to select the rightmost 5 cards
      • c to sort by suit
      • v to sort by rank
      • b to sort by enhancement+score, where glass cards are moved to the end, and lucky and mult cards to the beginning
    • in the shop:
      • c to buy an item or a pack or a voucher
      • v to buy and use an item, or buy a pack or a voucher
    • n to deselect all cards in a cardarea and m to invert card selection in rounds
    • x to view run info whenever it's available
    • & others (see ./mod/layout.lua) the full keymap as well as other layouts
• cardarea keybind layers for selecting, moving, selling & using cards. these apply globally for
  • consumables, accessed by holding '
  • jokers, accessed by holding [
  • a convenience jokers+consumables area accessed with the number row buttons and no leader key
  • pack cards, with no leader key
  • the shop, with no leader key
  • the hand, which is accessed
    • by holding / everywhere for selection and movement of a single card
    • by holding shift+/ for multiselect in booster packs
    • with no leader key for multiselect in rounds
• mnemonic keys for less frequent actions, like s to skip blinds, r to reroll the shop or boss, b in the cheat layer (accessed by holding p) to pick the best hand out the available cards, f in the cheat layer to fish for the best flush in hand, etc
• holding \ on a selected card to drag it out of its area, this can be used to snatch a joker away before the Amber Acorn boss can shuffle it

unacorn-smol.mp4

• support for qwerty, dvorak and workman keyboard layouts, where positional keys are kept consistent across both layouts and mnemonic keys aren't changed. (e.g. asdf to toggle the first four cards in qwerty translates to aoeu in dvorak, but r to reroll the shop or the boss blind stays r in both layouts)
• support for keybind overrides, so you can change the default keybinds to your liking
• any key to skip the splash screen and space to click any "play" or "continue" button, so a run can be started from game launch until the first blind with the space button only

TODOs

• deck selection keybinds, the "new run" menu has only one keybind, space to start a run with the selected deck, would be nice to add hjkl for deck and stake selection too

future plans

• half-keyboard layouts to be used with one hand on the mouse and the other on one side of keyboard (similar to photoshop and other editing software)
• menu navigation keybinds, menus are the only part of the game that currently requires the mouse to navigate
• redesign arcana and spectral packs UX, hand manipulation in these screens is a bit clunky due to the need for shift+/ for cardarea multiselect
• use the controller UI to display keybind hints