Neuro Game SDK

This repository contains the API documentation for allowing Neuro-sama to play games.

There are also official SDKs available for Unity and Godot, as well as community-maintained SDKs. If you would like to use the Neuro API in a different engine or programming language, you will have to implement the websocket protocol yourself. If you do so, consider opening a pull request to this repository to share your implementation with others by adding a link to the README.

Changelog

Significant API and SDK changes will be documented in the CHANGELOG.md file.

Last update: 7th of January 2025, 12:20 GMT

Contents

API Documentation

Please familiarize yourself with the API documentation before using the SDKs.

SDKs

SDKs created and maintained by Alex, which are located in this repository. Pull requests are welcome.

• Unity SDK
• Godot SDK

Tools

• Randy is a simple bot that mimics the Neuro API. It makes random actions and can be used to test your integration.

Community-Maintained

SDKs

Third-party SDKs created and maintained by the community.

• Rust SDK
• JavaScript/TypeScript SDK
• Java SDK
• Lua SDK
• Gamemaker SDK
• C SDK
• Python SDK
• Kotlin SDK

Tools

• Tony is a graphical testing interface, similar to Randy, but it allows the user to write messages manually.
• Jippity is a testing tool that aims to be a more "realistic" version of Randy, by using OpenAI to mimic Neuro.
• Gary is another backend implementation for advanced use. Originally created for testing with local LLMs like Llama, now also has support for a Randy-like "random generator" mode and a web UI for Tony-like manual sending.

Information

The official SDKs have been created and optimized for turn-based games, namely Inscryption, Liar's Bar and Buckshot Roulette.

Due to how the API works, we do not recommend using them with real-time games.

Since you need to describe the entire game state in text, and receive actions in text, only games where that is feasible will work well with this API.

Examples

Games that could work

• Inscryption
• Liar's Bar
• Buckshot Roulette
• Keep Talking and Nobody Explodes
• Uno
• Monopoly
• Most visual novels
• Most card games

Games that would not work

• Among Us
• Skyrim
• League of Legends
• Celeste
• Euro Truck Sim
• CSGO
• Any real-time strategy game
• Shooters
• Platformers

You get the idea. Turn based games in general are perfect for this. Anything else and you're kinda stretching the limits of what the API can do.

Vedal said you can use this for more complex games but he told me "you wouldn't get it" so I'm not even going to try to imagine how this would even work, and I am just going to assume that he is wrong.