CurseForge Setup

CurseForge Setup

This page tracks what is needed to create the CurseForge project page and connect it to GitHub Actions.

Project Page Fields

Suggested values:

• Name: CraftLedger Jobs
• Summary: Server-side jobs, economy, shops, and payouts for Forge servers. No client install required.
• Game: Minecraft
• Project class: Mods
• Main category: Server Utility or Economy, depending on the available CurseForge category list
• Additional categories: Utility & QoL, Server, Economy if available
• Supported environment: Server-side
• License: GPL-3.0-only
• Source URL: https://github.com/aditaa/CraftLedger-Jobs
• Issues URL: https://github.com/aditaa/CraftLedger-Jobs/issues
• Wiki URL: https://github.com/aditaa/CraftLedger-Jobs/wiki
• Logo: .github/assets/logo.png

Description Draft

CraftLedger Jobs adds a configurable jobs and economy layer for Forge servers.

It is designed for server owners who want balances, player payments, shops, sell commands, job payouts, and transaction logs without requiring players to install a client-side mod.

Core features:

• server-side install goal
• configurable currency
• player balances and /pay
• buy and sell shop commands
• configurable jobs
• currency and XP job payouts
• job progression
• placed-block payout protection
• transaction logs
• JSON storage by default
• optional SQLite storage for larger servers

CraftLedger Jobs is pre-release. Public files should only be published after the target Minecraft and Forge version has passed release validation and manual staging.

GitHub Actions Publishing Setup

After CurseForge creates the project, copy the numeric project ID.

Set these in the GitHub repository:

• Repository variable CURSEFORGE_PROJECT_ID
• Repository secret CURSEFORGE_TOKEN

Recommended:

• Create a GitHub Actions environment named curseforge.
• Require reviewer approval for the environment.

Publishing Workflow

Use the manual CurseForge Publish workflow only after staging is complete.

Inputs:

• profile: one target profile or all
• version: release version, such as 0.1.0
• release_type: alpha, beta, or release
• changelog: markdown changelog
• confirm: must be exactly publish

The workflow builds the selected target, runs the Forge server smoke test, and uploads the jar to CurseForge.