Embed AI-native game in your own web
.png?alt=media&token=8d3c446f-845b-480b-80be-e23b15dc4906)
Make your first web AI RPG!
Key Concepts
# 🪿LLM-based Game Open Schema (L-GOS) https\://github.com/RPGGO-AI/l-gos-spec I pronounce 'L-GOS' as "Large Goose" :)
| Name | Type | Example Value | Description |
|---|---|---|---|
| name | String | "📒 Sample: Dungeon Master" | |
| avatar_url | String | "https://a.com/xxx.jpg" | http image url |
| background | String | "Play a text-based dungeon crawler game. You are the game designer, dungeon master, and host for the game session. I am The player. use the DND 5E system." | |
| appearance | String | "A dungeon master" | |
| traits | Array | ["Confident", "Creative", "Drama"] | |
| tone | Array | ["Drama"] | |
| intro | String | "Welcome to my Tavern, Traveler. This is the DND 5E playground." | |
| tags | Array | ["Male", "Game", "Serious", "Narration"] | See the tags definitions here: [L-GOS Tags](https://github.com/RPGGO-AI/l-gos-spec/blob/main/schema_v1/tag_v1.md) Just fill in the value under the specific type, case-insensitive Only one value can be selected for each type |
| opening_line | String | "I'm thrilled to be your Dungeon Master for this thrilling journey. Before we begin, let me clarify a few things. Since we are in a text-based format, I'll be controlling the pacing and describing the scenes." | |
| creator | String | "Your-RPGGO-ID" | It must be your own user ID, otherwise the character will not appear in your creator tool list |
| creator_notes | String | "" | |
| modules | Array | [] | Not supported yet, can be null |
| publish_status | String | "opensource" | Optional parameters： opensource published unpublished |
Super Mario, Sheet
Super Mario, gif
Pikachu, gif
| Name | Type | Example Value | Description |
|---|---|---|---|
| style | String | "v1" | Two versions available ["v1", "v2"]. Default is v1. |
| form | String | "sheet" | Tow formats available ["sheet", "gif"]. Default is "sheet", for game engine use case. "gif" is more suitable for profile, avatar needs. |
| prompt | String | "Super Mario in snow cloth" | Describe the appearance of the sprite sheet. Default is "", which means for a random generation. |
| scale_by | int | 2 | tile size of the sprite sheet. Default is 2. |
> Note, you need to fill in your own api key in the curl. For how to apply api key, [Apply Your Test Key](/dev-docs/support/apply-your-test-key) {% code title="Sample Curl" lineNumbers="true" %} ```bash curl --location 'https://api.rpggo.ai/v2/assets/spritesheet/create' \ --header 'Content-Type: application/json' \ --header 'Authorization: YOUR-API-KEY' \ --data '{ "style": "v1", "prompt": "a girl", "form": "sheet", "scale_by": 2 }' ``` {% endcode %} {% tabs %} {% tab title="200: OK " %} {% code lineNumbers="true" %} ```json { "code": 200, "msg": "ok", "data": { "img_url": "https://storage.googleapis.com/rpggo-imagegen/CHARACTER_SHEET/54d9b5f8d25d4a1991eb2d2f26cdaa3f.gif" } } ``` {% endcode %} {% endtab %} {% tab title="10000008: Unauthorized " %} ```json { "code": 10000008, "message": "Authentication failed，Invalid token" } ``` {% endtab %} {% tab title="10000000: Low balance" %} ```json { "code": 10000000, "message": "user balance is not enough" } ``` {% endtab %} {% endtabs %} ### **Rate Limits** * each api call will spend 30 GG coins. Make sure you have balance in your account. # API Overview The description of V2 of APIs powered by RPGGO's AI engine ## Data Schema > The Rendering Basis of your Game {% content-ref url="/pages/M1dtqsT4rHDaTugU2b1Q" %} [Understand the data schema](/dev-docs/data-schema/understand-the-data-schema) {% endcontent-ref %} * [Understand the data schema](/dev-docs/data-schema/understand-the-data-schema) and knows how to integrate into your product and drive the movement of your characters ## :gear: API V2 Details Check the developer doc for what you can build with RPGGO's AI Engine {% content-ref url="/pages/HTF25OKMaXbZooEmusvb" %} [API V2 (New)](/dev-docs/player-api/api-overview/api-v2-new) {% endcontent-ref %} ## Interested In Accessing? Apply Now {% content-ref url="/pages/9ZEowCG4134gZ6Y6er5B" %} [Apply Your Test Key](/dev-docs/support/apply-your-test-key) {% endcontent-ref %} ## Create a Game and Get GameID to Test Edit in Creator Tool, and Get the Game Url as ID > This is an open platform free for editing and making games, designed for game script writers and newbies who are not familiar with game designs. * [Creator Tool](https://creator.rpggo.ai/) - The UGC Platform of RPGGO * RPGGO Creator Tool Video tutorial: [RPGGO Tutorial: How to Create A RPG on My Own Using AI? Introduction to Creator Tool](https://www.youtube.com/watch?v=QzzZ22o54Vc) ## What's in API V1: {% content-ref url="/pages/F7oJXUQVfV7Ump63nTeV" %} [API V1 (Deprecated)](/dev-docs/player-api/api-overview/api-v1-deprecated) {% endcontent-ref %} # API V2 (New) Fetch Game, Set Control, Integrate Characters, Chat in SSE, Manage User Goal Check with AI Released on May 11, 2024. ## Part 1. Data Schema {% content-ref url="/pages/M1dtqsT4rHDaTugU2b1Q" %} [Understand the data schema](/dev-docs/data-schema/understand-the-data-schema) {% endcontent-ref %} If you've read [Understand the data schema](/dev-docs/data-schema/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) {% content-ref url="/pages/RIeEzH0QHIehue7FN6FT" %} [Game Control](/dev-docs/player-api/api-overview/api-v2-new/game-control) {% endcontent-ref %} ## 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 {% content-ref url="/pages/cgYpBaNNMeU7HLkS3H5S" %} [Chat with NPCs & Check Goal with SSE](/dev-docs/player-api/api-overview/api-v2-new/chat-with-npcs-and-check-goal-with-sse) {% endcontent-ref %} * **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,
# Game Control Fetch Game, Start Game, Change Chapters while Goal Check Triggers, Resume with Memories ### 1. Get metadata of a specific game retrieve the game basic information for preview `POST`
# Step by Step: Discord with V1 API Based on our Discord game, here is a basic practice to demonstrate how to create a simple detective game using our API. {% hint style="info" %} Before diving into this document, it is strongly recommended to read [here](/dev-docs/data-schema/understand-the-data-schema) to understand the relationships between games, scenes, goals, DMs, and NPCs. {% endhint %} > All interfaces require the application of an app ID and authentication. The specific process can be found [here](/dev-docs/support/apply-your-test-key) ## GameList You need to call the [gamelist interface ](/dev-docs/player-api/api-overview/api-v1-deprecated/game#list-games)to retrieve all playable games. This API will return basic game information, which you can display as needed. In our Discord game, we display the game name and a brief description to help players choose. Additionally, you need to remember the game ID and scene ID. When starting the game in the next step, the API will require these to specify the game. The relationship between games and scenes can be referenced [here](/dev-docs/data-schema/understand-the-data-schema).
{% embed url="
{% embed url="
