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
  • RPGGO is a role-play game framework built around AI.
  • In summary, users can engage in conversations with NPCs to acquire information while the "DM" will oversee the game

Was this helpful?

  1. DATA SCHEMA

Understand the data schema

How it functions?

PreviousGetting StartedNext🪿LLM-based Game Open Schema (L-GOS)

Last updated 3 months ago

Was this helpful?

You can interact with the API through HTTP requests from any language, For ease of use and comprehension, here are some key concepts and data flows within RPGGO. Understanding these will help you rapidly build your own AI-native app.

RPGGO is a role-play game framework built around AI.

To integrate concepts from both gaming and storytelling, we've designed four fundamental elements: games, scenes, goals, and NPCs to assist you in crafting your open-world experience.

  • Game: A complete gaming experience, which can encompass multiple scenes, using various scenes to enrich perspectives and clues, facilitating a progressive storytelling approach.

  • Scene (Chapter in V2): A specific location or scenario within the game. Each scene contains one or more goals. When all goals are achieved, the game transitions to the next scene for further exploration.

  • Goal: Specific goals within a scene that players must accomplish. These goals often require dialogue with NPCs to obtain clues necessary for completion. Typically, multiple goals will progressively uncover deeper clues to aid players.

  • NPC (Character in V2): Individuals or observers present in a scene. Additionally, each scene requires a DM to assist in advancing the game or handling unexpected situations. Players can freely interact with NPCs to gather clues or just for fun.

In summary, users can engage in conversations with NPCs to acquire information while the "DM" will oversee the game

  • Users can submit answers and reasoning to the DM to achieve next goal set within a scene.

  • Once all goals in a scene are completed, the game progresses to the next scene, at which point goals and NPCs may have undergone new changes.

  • Victory in the game is achieved when all scene goals are met.

  • Bad endings are under designed, which is based on value checks, and this will be released soon, more detailed controls and multi storylines can be made from the creator side easily.

For schema details , go to next chapter.

🔢
🪿LLM-based Game Open Schema (L-GOS)
Key Concepts