Installation

Installation

Requirements

• A dedicated Forge server
• Java 17 or newer where required by the target Minecraft version
• A CraftLedger Jobs jar built for the same Minecraft and Forge target as the server

The primary target is:

• Minecraft 1.20.1
• Forge 47.4.10

Server Install

1. Stop the server.
2. Copy the CraftLedger Jobs jar into the server mods/ folder.
3. Start the server.
4. Confirm config/craftledger/ is created.
5. Join from a client that does not have CraftLedger Jobs installed.
6. Run /balance and the rest of the manual checklist.

Server-Only Compatibility

CraftLedger Jobs is intended to be server-side only. Players should be able to join with an unmodified client or a client modpack that does not include CraftLedger Jobs.

If clients cannot join, check that the jar metadata still contains:

• displayTest="IGNORE_SERVER_VERSION"
• Forge and Minecraft dependency metadata with side="SERVER"

Server Data

Config files are created in config/craftledger/:

• common.toml
• shop.json
• jobs.json
• messages.json

World data is stored in world/craftledger/:

• players.json
• job_payouts.json
• placed_blocks.json
• transactions.log

Back up world/craftledger/ with the world.

SQLite Storage

The default storage backend is JSON. For larger servers, set:

storageBackend = "sqlite"

This stores player balances, jobs, payout totals, and transactions in:

world/craftledger/craftledger.sqlite

Changing storage backend or SQLite file requires a server restart.

For existing JSON data:

1. Run /craftledger storage migrate json-to-sqlite dry-run.
2. Review the output.
3. Run /craftledger storage migrate json-to-sqlite.
4. Set storageBackend = "sqlite" in common.toml.
5. Restart the server.

Test migration on a disposable world before using it on production data.