deployables

Guide: Adding New Deployable Items

This guide outlines the general steps to add a new deployable item (like campfires, storage boxes, or sleeping bags) to the game. Replace bracketed placeholders (e.g., [Item Name], [item_name]) with your specific item's details.

1. Server: Define the Item

• File: server/src/items_database.rs
• Action: Add a new ItemDefinition struct entry for your [Item Name]. * Set category: ItemCategory::Placeable.
  • Set icon_asset_name: "[item_name].png".
  • Configure is_stackable (usually false for placeables), stack_size (usually 1), is_equippable: false.
  • (Optional) Define a crafting recipe later if needed.

2. Server: Create the Entity Logic

• New File: server/src/[item_name].rs
• Action:
  • Define the [ItemName] struct (e.g., SleepingBag) with #[spacetimedb::table(name = [item_name], public)].
  • Required Fields: id: u32 (PK, auto_inc), pos_x: f32, pos_y: f32, chunk_index: u32, placed_by: Identity, placed_at: Timestamp. Add other fields as needed for the item's function.
  • Add collision/interaction constants (copy/adapt from server/src/wooden_storage_box.rs or server/src/campfire.rs).
  • Implement place_[item_name] reducer:
    • Find your item's definition ID.
    • Validate the item instance (ownership, type).
    • Validate placement distance/collision.
    • Consume the item from player inventory/hotbar (using helpers from server/src/items.rs or server/src/inventory_management.rs).
    • Calculate chunk_index using calculate_chunk_index from server/src/environment.rs.
    • Insert the new [ItemName] entity.
  • Implement interact_with_[item_name] reducer (at least basic distance check if interaction is needed).
  • Implement pickup_[item_name] reducer (if applicable):
    • Validate interaction.
    • Check if pickup conditions met (e.g., empty).
    • Add item back to player inventory using add_item_to_player_inventory from server/src/items.rs.
    • Delete the entity if item added successfully.
  • Implement validate_[item_name]_interaction helper (if needed).
• File: server/src/lib.rs
• Action:
  • Add mod [item_name];
  • Add pub use crate::[item_name]::[ItemName]; near the end of the file.
  • Add use crate::[item_name]::[item_name] as [ItemName]TableTrait; to the table trait imports near the top.