#navbar-transition img {
  height: 40px;
}


Delete Space

BasicAuth

Invalid input data error (400)

Authorization not provided error (401)

Insufficient access error (403)

Not found error (404)

Internal server error error (500)

Forge

Get started with Forge and learn how to build and integrate your game systems

Introduction

Learn how to set up a basic inventory system using Forge. You'll define items, create spaces to store them, and assign them to users.

Build Your Game's Inventory System

Group items based on characteristics and usage restrictions

Classifiers

Define and manage item properties and statistics

Attributes

Items are the core components in Forge that drive the dynamics of your game world. Each item can be defined with specific attributes, classifiers, and optional visual representations. This document explains how to define an item, the role of classifiers, and how items interact with the game's mechanics.

Items

 Spaces in Forge serve as structured storage areas where item instances are stored and managed within your game. Each space defines a specific area designated for organizing items based on their usage or category. This document outlines how spaces function as storage compartments and their role in facilitating item management. 

Spaces

Securely authenticate API requests and protect your team's data

Access Control

Create and manage individual occurrences of items with unique properties

Item Instances

Randomize item generation using roll numerators for scalable probabilities

Rolling

Link your game's users with Forge for persistence and state management

User Management

Organize and manage player items to enhance gameplay engagement and strategy

Inventory Systems

Lists all attributes associated with the specified team. Attributes define properties that can be assigned to items or instances within the team context.

List Attributes

Creates a new attribute for the specified team with name and optional min/max values.

Create Attribute

Updates an existing attribute's properties including name, min, and max values.

Update Attribute

Deletes an attribute from the team. Note: Will fail if attribute is attached to items.

Delete Attribute

Lists the classifiers defined for a specific team. Classifiers group items and manage item-related properties.

List Classifiers

Creates a new classifier with associated options for a team

Create Classifier

Updates an existing classifier's properties

Update Classifier

Deletes a classifier and its associated options

Delete Classifier

Lists all items associated with the specified team. Items are blueprints that can be rolled, modified, or assigned attributes.

List Items

Creates a new item blueprint with specified attributes and classifiers.

Create Item

Updates an existing item's properties, attributes, and classifiers.

Update Item

Deletes an item and its associated attributes and classifiers.

Delete Item

Generates a randomized variation of an item. This endpoint is commonly used for loot drops or creating unique instances in games.

Roll an item

Lists all item instances within the specified team. Item instances represent individual occurrences of items with specific attributes and configurations.

List Item Instances

Creates an instance of an item within the specified team. Instances are generated from item templates and can have custom attributes and configurations.

Create an Item Instance

Delete an Item Instance

Moves a specified item instance to a new location within the user's space grid.

Move an Item Instance

Lists the spaces defined within a specific team. Spaces represent areas or containers where item instances can be stored.

List Spaces

Creates a new space for the specified team.

Create Space

Update Space

Lists all users belonging to the specified team. Users can own item instances or interact with spaces.

List Users

Creates a new user within the specified team, associating the user with the team and enabling them to interact with its resources and systems. This endpoint can be used to add players, administrators, or other roles to a team, linking them with unique identifiers for tracking and management.

Create a user

Delete a user

List user spaces

Creating a user space, allows the user to receive and store item instances.

Create a user space

Delete a user space

Lists all spaces where item instances are currently stored within a team. Item instance spaces map items to specific user-defined locations.

attributes

classifiers

items

item-instances

spaces

users

user-spaces

item-instance-spaces

Delete Space

Authorizations

Path Parameters

Response