This repository provides an API and SDKs for integrating AI, specifically "Neuro," into games. It targets game developers and researchers interested in AI-driven gameplay, enabling AI agents to perceive game states and execute actions via a text-based interface.

How It Works

The core of the system is a WebSocket API that facilitates communication between the AI and the game. Developers must describe the game state as text and receive actions as text. This approach is optimized for turn-based games where a textual representation of the game state is feasible, abstracting away complex real-time rendering and input handling.

Quick Start & Requirements

• Install: Official SDKs for Unity and Godot are available within the repository. Community SDKs for Rust, JavaScript/TypeScript, Java, Lua, Gamemaker, C, and Python are also listed.
• Prerequisites: Requires implementing the WebSocket protocol if not using official/community SDKs.
• Resources: No specific hardware or software requirements are detailed beyond standard game development environments.
• Links: API Documentation is available within the repository.

Highlighted Details

• Optimized for turn-based games like Inscryption, Liar's Bar, and Buckshot Roulette.
• Supports official SDKs for Unity and Godot, plus numerous community-maintained SDKs.
• Includes testing tools like Randy (random actions), Tony (manual input), Jippity (OpenAI-mimicking), and Gary (local LLM support).

Maintenance & Community

• The project is maintained by Alex, with community contributions welcomed via pull requests.
• Links to community Discord/Slack are not provided in the README.

Licensing & Compatibility

• The README does not explicitly state a license.
• Compatibility is primarily for turn-based games; real-time games are not recommended.

Limitations & Caveats

The API is not recommended for real-time games due to the requirement of describing the entire game state in text. Complex or fast-paced games may not be suitable.