Capability reference

Capability reference

Protocol identifiers reported by a connected game server

A capability is one function a game server tells Forgeport it supports. This is the identifier reference for debugging and support; installation guides use human task names and explain how support is enabled.

Required status is family-specific. Choose the relevant feature overview:

Accounts and characters

CapabilityHuman taskResult boundary
VERIFY_GAME_CREDENTIALSVerify a game account before linking itValid, invalid, not found, blocked, or temporary error; player-facing errors do not reveal whether an account name exists
CREATE_GAME_ACCOUNTCreate a game account from the player portalCreated, already exists, invalid name, or temporary failure
LIST_ACCOUNT_CHARACTERSShow characters owned by one linked accountValidated character summaries; an empty list is a successful result
LIST_CHARACTER_SKILLSCheck what the selected character already knowsKnown skill ids/levels or unavailable; used to prevent an invalid skill purchase before charging
GET_ACCOUNT_PREMIUM_STATUSShow current account Premium expiry and purchase policyUTC expiry or inactive, plus EXTEND or REPLACE

Catalog and delivery

CapabilityHuman taskResult boundary
SEARCH_GAME_CATALOGFind items by id or name in AdminItem id/name plus optional type, grade, and stackable hint
SEARCH_SKILL_CATALOGFind skills by id or name in AdminSkill id/name and maximum level
DELIVER_ITEM_GRANTGive a purchased itemApplied, already applied, queued, retryable, refused, permanent failure, or reconciliation required
DELIVER_SKILL_GRANTTeach a purchased skillSame durable delivery outcomes; delivery must never downgrade a known skill
DELIVER_CURRENCY_GRANTCredit a supported in-game currencyAccount-scoped durable delivery outcome
DELIVER_ACCOUNT_PREMIUMStart or extend an account Premium periodAccount-scoped durable delivery outcome using the purchased duration
CHARACTER_SERVICESRename a character or change genderDurable delivery outcome after server-owned validation
PLAYER_ONLINE_EVENTResume a delivery held until loginPublished event with normalized account and character id
UNSTUCK_CHARACTERMove a stuck character to configured coordinatesUnstuck, wrong online state, not found, or failed

Status and public data

CapabilityHuman taskResult boundary
GET_SERVER_STATUSShow that the connector is reachableDerived from the active connector connection
GET_ONLINE_COUNTShow the current online-player countNon-negative count reported with heartbeat data
LIST_RANKINGSShow PvP, PK, or level boardsValidated character summaries ordered for the requested metric
LIST_CLANSPublish the clan directoryValidated clan rows
LIST_SIEGESPublish castle ownership and schedulesValidated states and UTC timestamps
LIST_BOSSESPublish raid and grand-boss statusValidated state and optional UTC respawn window

Delivery outcomes

OutcomeWhat Forgeport does
APPLIEDCompletes the command
ALREADY_APPLIEDCompletes a replay without applying it again
QUEUEDWaits for the connector to report the final server result
RETRYABLE_FAILURERetries or waits for the required player state
REFUSEDCancels the order and releases the player's coins
PERMANENT_FAILUREStops retrying
RECONCILIATION_REQUIREDStops automatic replay and requires an owner decision

Common refusal codes

The connector helpers use CHARACTER_NOT_ON_ACCOUNT, UNKNOWN_ITEM, UNKNOWN_SKILL, and SKILL_ALREADY_KNOWN. Character services and queued delivery also use CHARACTER_NAME_TAKEN, RESERVED_CHARACTER_NAME, INVALID_CHARACTER_NAME, KAMAEL_GENDER_LOCKED, GENDER_UNCHANGED, DELIVERY_FAILED, and DELIVERY_EXPIRED. Unknown server codes are preserved for diagnostics and shown to players as a generic refusal with coins returned.

For payload examples used during gateway debugging, see the protocol v1 reference.

On this page