repository·master·Indexed 20 days ago
https://github.com/clockworklabs/bitcraftpublicServer-side logic and state management for BitCraft, a community sandbox MMORPG. Built using SpacetimeDB, the repository includes game logic, state management, and custom Rust macros for shared tables, event-driven timers, and feature gating. It provides detailed implementations for claim systems, dropped inventory lifecycles, and server-side systems.
This repository contains the server-side code for BitCraft, a community sandbox MMORPG. It includes game logic, state management, and server-side systems.
Note: This repository does not include the game client or the tools required to connect to the official BitCraft game servers. It is intended for public inspection, experimentation, and contribution.
The BitCraft server is built on SpacetimeDB, a real-time, reactive backend platform for multiplayer games.
The server is structured as a SpacetimeDB module where:
tables.reducers.If you want to run a minimal version of the server locally, you should first consult the SpacetimeDB documentation.
The BitCraft source code is licensed under the Apache 2.0 license.
To ensure exploits are addressed quickly and not abused, do not share them publicly. Submit them privately using the official exploit reporting form.
Verified, meaningful, and previously unreported exploits may be eligible for a unique in-game reward.
To successfully execute a claim resupply, the following conditions must be met within the reduce logic:
Permission::Usage and ClaimPermission::Usage for the target building.owner_building_entity_id of the claim.supplies must be less than its max_supplies.inventory_entity_id must exist.pocket_index must be within the valid range of the inventory's pockets.ItemType::Cargo.building_repairs_desc as having a valid repair_value.If any of these conditions fail, the reducer returns an error (e.g., "Too far", "Building is not under a claim", or "Claims can only be charged with supplies.").
The system uses a state machine driven by scheduled reducers to manage item persistence:
DroppedInventoryOwnershipTimer is scheduled. While this timer is active, the items are considered private to the owner.dropped_inventory_lose_ownership triggers:dropped_inventory_despawn triggers, the DroppedInventoryState and its associated InventoryState and LocationState entries are deleted from the database.The duration required to deconstruct a building is determined by the event_delay_recipe_id function. The calculation follows this logic:
time_requirement from the building's DeconstructionRecipeDesc.recipe.get_skill_type()).time_factor derived from the tool's power relative to the desired_tool_power required by the recipe.deconstruct_default_time from the global parameters_desc.If the player does not possess the required tool, the action is invalidated.
Deconstructing buildings is subject to several permission and state checks:
| Restriction Type | Condition |
|---|---|
| Permission | Must have Permission::Build or ClaimPermission::Build on the tile/building. |
| Premium Buildings | Must be the owner or a co-owner of the claim. |
| Watchtowers | Cannot be deconstructed. |
| Player Housing | Cannot be deconstructed if there are active residents (locked_until <= ctx.timestamp). |
| Elevators | Cannot be deconstructed if they are currently in use (checked via player_use_elevator_timer). |
| Dimensions | Cannot deconstruct portal buildings in interiors, or any buildings in AncientRuin or Dungeon dimensions. |
| Proximity | Actor must be within a distance of 2 from the building. |
The init_region_info reducer allows an Admin to set up the initial parameters for a world region.
Parameters:
world_width: Width in chunks.world_height: Height in chunks.region_index: The index of the current region.region_count: Total number of regions (must be a square number).Requirements:
Role::Admin.region_count must be a perfect square.region_index cannot exceed region_count.This function populates WorldRegionState and WorldRegionNameState and updates the Globals table with the current region_index.
#[spacetimedb::reducer]
pub fn init_region_info(
ctx: &ReducerContext,
world_width: i32,
world_height: i32,
region_index: u8,
region_count: u8,
) -> Result<(), String>The initialize reducer is an init reducer that sets up the initial state of the database. It performs the following actions:
Admin roles to the database owner and the database identity.ServerIdentity.AdminBroadcast, Globals, and Config tables.Config table is set to env: "dev" and agents_enabled: false.Note: If the environment is not dev, the reducer enforces that the caller must be the owner of the database.
#[spacetimedb::reducer(init)]
pub fn initialize(ctx: &ReducerContext) -> Result<(), String>The identity_connected reducer is triggered via the client_connected event. It manages access control for connecting identities:
developer table, they are logged and allowed to connect.Role::SkipQueue are allowed to connect.blocked_identity table or fails is_authenticated checks, the connection is rejected with "Unauthorized".If an identity has no valid user or permission, the connection is rejected with "Identity with no user or permission is disallowed from connecting".
#[spacetimedb::reducer(client_connected)]
#[shared_table_reducer]
pub fn identity_connected(ctx: &ReducerContext) -> Result<(), String>The following reducers allow administrators to reset a player's onboarding state to specific predefined milestones within the Alpha 3 version of the game. These are useful for testing or correcting player progression.
Note: These reducers are specific to Alpha 3 and may become invalid as onboarding logic changes.
Requirements:
Role::Admin permissions.entity_id (u64) of the player.Available Milestones:
admin_alpha3_reset_onboarding_to_first_temple_quest: Resets to the first temple quest.admin_alpha3_reset_onboarding_to_second_temple_quest: Resets to the second temple quest.admin_alpha3_reset_onboarding_to_third_temple_quest: Resets to the third temple quest.admin_alpha3_reset_onboarding_to_fourth_temple_quest: Resets to the fourth temple quest.admin_alpha3_reset_onboarding_to_fifth_temple_quest: Resets to the fifth temple quest.admin_alpha3_reset_onboarding_to_first_expand_quest: Resets to the first expand quest.admin_alpha3_reset_onboarding_to_second_expand_quest: Resets to the second expand quest.admin_alpha3_reset_onboarding_to_third_expand_quest: Resets to the third expand quest.admin_alpha3_reset_onboarding_to_fourth_expand_quest: Resets to the fourth expand quest.