Skip to content

installation.md

Latest commit

 

History

History
52 lines (35 loc) · 1.96 KB

installation.md

File metadata and controls

52 lines (35 loc) · 1.96 KB

Installation

Prerequisites

  • Balatro (Steam)
  • Lovely mod loader for Balatro
  • Steamodded mod framework — required by balatrobot
  • balatrobot mod (our fork) installed into Balatro — provides the JSON-RPC server the bot talks to
  • Python 3.13+

Why our fork? Jack Potts requires API fields and fixes not yet in upstream balatrobot: edition scoring values, joker ability data, The Ox's locked hand, Ancient Joker suit, The Idol's round-target card, boss blind forcing, endless mode support, and several endpoint hang fixes. A PR is open to merge most of these upstream — once accepted, the official mod will work for those changes. Until then, use our fork.

Install

git clone https://github.com/DrLatBC/JackPotts.git
cd JackPotts
pip install -e ".[dev,runtime]"

The runtime extra pulls in the balatrobot client library. The dev extra adds pytest and related tooling.

Environment config

Create .env.local in the repo root (gitignored, loaded automatically):

BALATRO_EXE=G:\SteamLibrary\steamapps\common\Balatro\Balatro.exe
LOVELY_DLL=G:\SteamLibrary\steamapps\common\Balatro\version.dll
UVX_PATH=C:\path\to\.venv\Scripts\uvx.exe

Adjust paths to match your Steam library. UVX_PATH is only required if uvx isn't on your system PATH (e.g. when installed inside a virtualenv).

Optional: JackPotts dashboard

To push per-game data to a dashboard instance, add:

JACKPOTTS_URL=https://your-dashboard.example
JACKPOTTS_API_KEY=...

Leaving these blank disables the dashboard client entirely — the bot runs the same, just without remote reporting. See dashboard.md for details.

Verify install

pytest -q

All 380 unit tests should pass without a running game.
⚡