RPGGO Developer Documentation
  • Introduction
    • 🎮RPGGO API: the AI Engine for Game
    • 😎Getting Started
  • DATA SCHEMA
    • 🔢Understand the data schema
    • 🪿LLM-based Game Open Schema (L-GOS)
  • CREATOR API
    • 🆕V2 API
      • Create Character
      • Create Game SpriteSheet
  • Player API
    • ⚙️API Overview
      • API V2 (New)
        • Game Control
        • Chat with NPCs & Check Goal with SSE
      • API V1 (Deprecated)
        • Game
        • NPC
        • Memory
        • ErrorCode
    • 📰Notes: API V2 Released
      • Changes
  • Open Source Use Cases
    • 🍎Step by Step: Discord with V1 API
    • 🍒Simple Chat Game with V2 API
    • 🏰2D AI Town with V2 API
    • 🌴Stardew Valley Mod with V2 API
    • 🌐AI Game Website with V2 API
  • Thesis
    • 🗒️Thesis 2024: A Text-to-Game Engine for UGC-Based Role-Playing Games
    • 🗒️Initial Vision 2023: Text-To-OpenWorld Engine
  • Support
    • 🔑Apply Your Test Key
    • 📩Contact us
Powered by GitBook
On this page
  • Part 1. Data Schema
  • Part 2. Game Control - Manage the User Experience in Game
  • Part 3. Chat with NPCs & Check Goal with SSE - What's in SSE
  • Part 4. Multi-modal Output
  • Part 5. Game List Authorization
  • Part 6. Sample Code

Was this helpful?

  1. Player API
  2. API Overview

API V2 (New)

Fetch Game, Set Control, Integrate Characters, Chat in SSE, Manage User Goal Check with AI Released on May 11, 2024.

Last updated 8 months ago

Was this helpful?

Part 1. Data Schema

If you've read Understand the data schema already, in V2 API, we renamed "Scene" to "Chapter", and "NPC" to "Character".

Part 2. Game Control - Manage the User Experience in Game

  • Get Game Data

  • Start Game

  • Switch Chapters

  • Continue Sessions (Game progress memory)

Part 3. Chat with NPCs & Check Goal with SSE - What's in SSE

  • Chat with NPCs in SSE (single chat, group chat)

  • Normal NPC Conversations

  • Game Control Messages AI Powered Goal Check

  • Async via SSE: V1 provides synced api call only. But V2, we turn to async msg push, which means all the generation will be pushed to client via SSE.

Part 4. Multi-modal Output

  • V2 support image, audio, music generation in real-time.

  • Currently its a whitelist logic under gameid, request for multi-modal game experience by sending us your GameId, dev@rpggo.ai

Part 5. Game List Authorization

  • You can only access permission-granted games.

  • Let us know if you are interested in any GameId or a GameId list. send request to dev@rpggo.ai

Part 6. Sample Code

  • Here is an example of node.js to play with our V2 API. Simple Chat Game with V2 API

Sample game for Multi-modal output

⚙️
🔢Understand the data schema
Game Control
Chat with NPCs & Check Goal with SSE
https://rpggo.ai/game/25e19be0-2b17-47e9-9891-d12a7131506b#/game?gameId=25e19be0-2b17-47e9-9891-d12a7131506b