# <img src="Assets/icon.png" width="29" style="vertical-align:middle;">  Neuro SDK

This repository contains the API documentation for allowing [Neuro-sama](https://twitch.tv/vedal987) 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](./CHANGELOG.md) file.

Last update: 1st of July 2026, 12:45 GMT

## Contents

### API Documentation
Please familiarize yourself with the [API documentation](./API/README.md) before using the SDKs.

### SDKs
SDKs created and maintained by Alex, which are located in this repository. Pull requests are welcome.
- [Unity SDK](./Unity/README.md)
- [Godot SDK](./Godot/README.md)

### Example Projects
Open-source game integrations created with the Neuro SDK:

- [Slay the Spire 2](https://github.com/VedalAI/neuro-sts2)
- [Inscryption](https://github.com/VedalAI/neuro-inscryption)
- [Buckshot Roulette](https://github.com/VedalAI/neuro-buckshotroulette-reference) (reference source code)
- [Hollow Knight](https://github.com/VedalAI/neuro-hollow-knight)
- [Cyberpunk 2077](https://github.com/VedalAI/neuro-cyberpunk)
- [Pokémon Platinum](https://github.com/VedalAI/neuro-pokemon-platinum)

### Tools
- [Randy](./Randy/README.md) is a simple bot that mimics the Neuro API. It makes random actions and can be used to test your integration.

## Community-Maintained

> [!Caution]
> These links are provided **solely for convenience** so that community members can find other implementations more easily.  
> We **do not review, verify, or endorse** any of the projects listed below, and they may change or stop working at any time.  
> Use any community-maintained SDKs, tools, or code **at your own risk**. We **do not take any responsibility** for their functionality, security, or reliability.

<details>
<summary>I understand. Click to expand and view list.</summary>

### SDKs
Third-party SDKs created and maintained by the community.
- [Rust SDK](https://github.com/chayleaf/rust-neuro-sama-game-api)
- [JavaScript/TypeScript SDK](https://github.com/AriesAlex/typescript-neuro-game-sdk)
- [Java SDK](https://github.com/alexcrea/jacn-sdk)
- [Lua SDK](https://github.com/Gunoshozo/lua-neuro-sama-game-api)
- [Gamemaker SDK](https://github.com/noellepunk/Neuro-Gamemaker-SDK)
- [C SDK](https://github.com/xslendix/libneurosdk)
- [Python SDK](https://github.com/CoolCat467/Neuro-API)
- [Kotlin SDK](https://github.com/RedEpicness/neuro-sdk-kotlin)
- [C++ SDK](https://github.com/chris-pie/neuro-sdk-websocketpp)
- [Generic C# SDK](https://github.com/pandapanda135/CSharp-Neuro-SDK)
- [Ren'Py SDK](https://github.com/caheuer/neuro-renpy-implementation#for-developers)
- [RPG Maker VX Ace SDK](https://github.com/Pasu4/rpg-maker-vxa-neuro-sdk)
- [StarCraft II SDK](https://github.com/ArthurWiese/SC2-Neuro-API-Integration)

### Tools
- [Tony](https://github.com/Pasu4/neuro-api-tony) is a graphical testing interface, similar to Randy, but it allows the user to write messages manually.
- [Jippity](https://github.com/EnterpriseScratchDev/neuro-api-jippity) is a testing tool that aims to be a more "realistic" version of Randy, by using OpenAI to mimic Neuro.
- [Gary](https://github.com/Govorunb/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.

#### Server SDKs
Useful if you're building a simulator server for testing purposes.

- [JavaScript/TypeScript SDK](https://github.com/KTrain5169/typescript-neuro-game-api)
- [Python SDK](https://github.com/CoolCat467/Neuro-API) (import from `neuro_api.server`)

</details>

## Information 

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

Games that require a non-low APM will generally not work well without Neuro only controlling the high-level actions and letting another system decide how to handle the low-level actions.

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. Other games often require more complex solutions.
<details>
<summary>Examples of games that work well</summary>
  
- Inscryption
- Liar's Bar
- Buckshot Roulette
- Keep Talking and Nobody Explodes
- Uno
- Monopoly
- Most visual novels
- Most turn based card games
</details>