![StepCraft Banner](https://i.imgur.com/b8grWNu.png)

### 🔴 TO USE THIS PLEASE REACH OUT TO: stepcraft.team@gmail.com. We are currently in closed Beta :)

Connect your players' real-world movement to in-game rewards.

StepCraft is a **server-side Minecraft Fabric mod** that turns real-world step goals into in-game rewards. Players sync their steps through the **StepCraft Companion mobile app**, then return to your server to claim rewards when they hit the goals you set.

Instead of generic login bonuses, StepCraft gives your community rewards that feel earned.

To register your server, head over to the [StepCraft Website](https://stepcraft.org/).

***

## What StepCraft Adds

* Daily step-based reward goals
* Monthly leaderboard rewards
* In-game reward claiming
* Step-history screens for players
* Public and private server support
* Invite-code and QR-code joining
* Configurable reward tiers
* Custom claim windows
* Join reminders for unclaimed rewards
* Custom reminder messages
* In-game player and admin menus
* Web dashboard setup and management
* Companion mobile app for players
* In-game UI title and layout customization
* Live config reload support

***

## Why Server Owners Use It

StepCraft helps communities build a daily habit around your server.

Players stay active in real life, sync their steps, and come back to claim rewards in Minecraft. Monthly leaderboards add longer-term goals, while daily rewards keep players checking in regularly.

StepCraft works especially well for:

* survival servers
* SMP communities
* friend groups
* fitness-focused communities
* servers looking for a unique retention system

***

## Server Features

### Daily Rewards

Create step goals and reward tiers for your players. When players hit those goals, they can claim rewards in-game.

### Monthly Leaderboards

Reward your most active players over a full month. Players can view the monthly leaderboard and claim finalized monthly rewards through the StepCraft UI.

### Claim Windows

Control how long players have to claim missed or pending rewards.

### Join Reminders

Players can receive private reminders when they join if they have unclaimed daily or monthly rewards.

Reminder messages can be customized from the dashboard and support Minecraft-style formatting.

### Public or Private Servers

Run a public StepCraft server or keep access limited with invite codes and QR-code joining.

### Dashboard Management

Use the StepCraft Web Dashboard to manage server setup, reward tiers, invite codes, reminder messages, billing, and server settings.

![Reward Config](https://cdn.modrinth.com/data/eNk0ACQx/images/6085e34216ce07a517608bcdb5ec0bf4de4da3a3.png)

### Companion App

Players use the StepCraft Companion app to join servers, sync steps, track progress, and see available rewards.

![Player App UI](https://cdn.modrinth.com/data/eNk0ACQx/images/64af97c47f7ccee425bc16147e43074ac8c8441c.png)

### In-Game Admin Tools

Admins can manage StepCraft from in-game menus, including server setup, player tools, reward testing, monthly rewards, join reminders, and UI customization.

![Admin UI](https://cdn.modrinth.com/data/eNk0ACQx/images/87901902ade67e37a6486b7025879556cc7ea569.png)

***

## Private Server Support

Private servers can use invite codes and QR-code joining so only approved players can connect through StepCraft.

This makes StepCraft easy to use with friend groups, family servers, private SMPs, and invite-only communities.

![Player Server Joining](https://cdn.modrinth.com/data/eNk0ACQx/images/8f8878606293afc861f6f60d9cdc4e58b2193a00.png)

***

## Getting Started

1. Install the StepCraft mod on your Minecraft server.
2. Register your server through the [StepCraft Website](https://stepcraft.org/).
3. Connect your API key to the mod.
4. Configure rewards and settings in the dashboard.
5. Let players join through the StepCraft Companion app.
6. Players sync steps and claim rewards in-game.

***

## Commands

StepCraft uses `/stepcraft` for player, admin, setup, and customization tools.

### Player Commands

`/stepcraft`
Opens the StepCraft player UI.

`/stepcraft ui`
Opens the StepCraft player UI.

`/stepcraft steps`
Opens your step-history screen.

`/stepcraft steps <username>`
Shows step history for a player. Regular players can only view themselves. Admins can view other players.

`/stepcraft claim_reward`
Opens the reward-claiming UI.

`/stepcraft claim_reward <username>`
Claims rewards for a player. Regular players can only claim for themselves. Admins can claim for other players.

`/stepcraft monthly_leaderboard`
Opens the monthly leaderboard and monthly reward flow.

### Admin Commands

These commands require operator/admin permissions.

`/stepcraft ui_admin`
Opens the StepCraft admin UI.

`/stepcraft set_api_key <key>`
Saves the StepCraft API key for this server.

`/stepcraft reload`
Reloads StepCraft config and UI data without a full server restart.

`/stepcraft info`
Shows StepCraft server info from the backend.

`/stepcraft claim_status <username>`
Checks reward claim status for a player.

`/stepcraft players_data`
Shows full player records from the backend.

`/stepcraft player_names`
Shows the StepCraft player name list for the server.

`/stepcraft bans`
Shows current StepCraft bans.

`/stepcraft ban [username] [reason]`
Bans yourself or a specific player.

`/stepcraft unban [username]`
Unbans yourself or a specific player.

`/stepcraft delete_player [username]`
Deletes your own StepCraft player record or a specific player record.

### UI Customization Commands

These commands require operator/admin permissions.

`/stepcraft ui_titles_config list`
Lists configurable UI title keys.

`/stepcraft ui_titles_config get <key>`
Shows the current and default value for a UI title.

`/stepcraft ui_titles_config set <key> <title>`
Sets a custom UI title.

`/stepcraft ui_titles_config reset <key>`
Resets a UI title to its default value.

`/stepcraft ui_layout_config list_screens`
Lists customizable StepCraft screens.

`/stepcraft ui_layout_config list <screen>`
Lists layout elements for a screen.

`/stepcraft ui_layout_config set_slot <screen> <key> <0-53>`
Moves a UI element to a slot.

`/stepcraft ui_layout_config set_icon <screen> <key> <minecraft:item_id>`
Changes a UI element icon.

`/stepcraft ui_layout_config set_visible <screen> <key> <true|false>`
Shows or hides a UI element.

`/stepcraft ui_layout_config reset <screen> [key]`
Resets a screen layout or specific layout key.

`/stepcraft ui_layout_config editor <screen>`
Opens the in-game layout editor.

***

## Notes

* StepCraft is server-side only.
* Players use the Companion app to sync steps and join servers.
* Server setup and management are handled through the StepCraft Website.
* Backend-connected commands require a valid StepCraft API key.
* `/stepcraft steps` replaces the older `/stepcraft today_steps` command.
* Monthly rewards are accessed through `/stepcraft monthly_leaderboard`.

***

## Links

[StepCraft Website](https://stepcraft.org/)