Skip to content

1.0

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

1.0

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
attention
attention
 
 
events
events
 
 
handshake
handshake
 
 
state
state
 
 
tools
tools
 
 
README.md
README.md
 
 

README.md

GABP 1.0 Examples

This directory contains working examples of GABP (Game Agent Bridge Protocol) messages that demonstrate the protocol in action.

Directory Structure

  • handshake/ - Session initiation examples showing the hello/welcome exchange
  • tools/ - Tool discovery and invocation examples
  • events/ - Event subscription and notification examples
  • state/ - State management examples for getting and setting game state
  • attention/ - Optional attention inspection, lifecycle, and acknowledgement examples

Using These Examples

Each example file shows a complete GABP message in JSON format. These can be used to:

  • Understand the protocol message structure
  • Test your GABP implementation
  • Validate against the schemas in ../../SCHEMA/1.0/
  • Learn the expected flow of communications

Message Naming Convention

Files are numbered to show typical interaction flows:

  • 001_, 002_, etc. - Sequential messages in a conversation
  • .req.json - Request messages (from bridge to mod)
  • .res.json - Response messages (from mod to bridge)
  • .msg.json - Event messages

Validation

You can validate these examples against the GABP schemas:

npm install -g ajv-cli
ajv -s ../../SCHEMA/1.0/envelope.schema.json -d '**/*.json'

All examples in this directory should validate successfully against the envelope schema and their specific method schemas.