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.
Significant API and SDK changes will be documented in the CHANGELOG.md file.
Last update: 26th of December 2024, 19:00 GMT
Please familiarize yourself with the API documentation before using the SDKs.
SDKs created and maintained by Alex, which are located in this repository. Pull requests are welcome.
- Randy is a simple bot that mimics the Neuro API. It makes random actions and can be used to test your integration.
Third-party SDKs created and maintained by the community.
- 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.
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
- Inscryption? yes
- Liar's Bar? yes
- Buckshot Roulette? yes
- Among Us? not easily
- Skyrim? no
- League of Legends? no (ew)
- Celeste? no
- KTANE? yes
- Uno? YES
- Monopoly? YES
- Euro Truck Sim? no
- CSGO? no
- Almost any visual novel ====> YES
- Almost any card game ====> YES
- Any RTS ====> not easily
- Most FPP ====> NO
- Shooters ====> NO
- Platformers ====> NO
- Tic tac toe? yes
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 you lot probably wouldn't get it either.