Practical overview
When it fits
Use OpenGameAgent when building an AI-native game and you want a TypeScript runtime for character-agent loops, with the game retaining authority over actions and world state.
Who it is for
- Game developers embedding agent behavior in characters or worlds.
- Teams building with Unity, Godot or Unreal Engine.
- Developers who need durable character state and game-authorized actions.
Documented uses
- Connect game inputs to an agent loop and return character responses.
- Coordinate continuing behavior with durable goals, signals, schedules and mailboxes.
- Keep game-side control over permissions, rules, authoritative state and world writes.
- Add optional structured memory to game characters.
Requirements & limits
The repository is public and the source preview is MIT-licensed. The TypeScript workspaces are supplied as source; their private package setting prevents accidental npm publication.
- The local example uses a deterministic model fixture and in-memory event store, while a real game needs host-side model selection, credentials, persistence and authorization.
- The runtime is written in TypeScript and includes SQLite authority and thin integrations for Unity, Godot and Unreal Engine.
- The project is under active development; the README recommends pinning a commit when integrating it.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Build and run the local example
Build the TypeScript source and run the documented local example that submits game input to one character.
Before you start
- Node.js 24.15.0
- npm 11.12.1
- Git
Steps
Clone the OpenGameAgent repository and change into its directory.
Run npm ci to install dependencies.
Run npm run build.
Run npm run example:local.
Expected outcome
The local example registers one character, accepts a game input and prints a reply using a deterministic model fixture and an in-memory event store.
Guide limitations
- The example needs no API key or network access, but it uses a deterministic fixture rather than a real model connection.
- Real-game integration requires selecting a model, configuring host credentials, persisting runtime state, and authorizing tools and actions.
- The project is under active development; its README recommends pinning a commit for game integration.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 14 October 2026
- Original website title
- EricSun0218/OpenGameAgent · Official homepage title · retained in its source language

