Skip to content

Mind Game is a C# plugin for Godot 4.3 to run LLMs locally in games

License

Notifications You must be signed in to change notification settings

adammikulis/MindGame

Repository files navigation

This is a plugin for the Godot game engine that allows the user to load and run a local Large Language Model (LLM) in-engine using the LLamaSharp (v0.12.0) C# library.

Current Mind Game features

Fast, local chat models in your games

mindgame_inference

Easy configuration

mindgame_config

Run Mind Game stand-alone

  1. Install CUDA Toolkit 12.x if you haven't already (CPU inference support coming soon)
  2. Download the latest Mind Game release for your platform and run the executable
  3. Download a .gguf model of the Llama, Phi, or Mistral families
  4. Load your model and have fun!

Recommended model: Llama3-8B-Instruct

Smaller model for those with less VRAM: Phi-3

Another 7B model: Mistral-7B-Instruct-v0.2

Run Mind Game as a Godot plug-in

  1. Install CUDA Toolkit 12.x if you haven't already (CPU inference support coming soon)
  2. Download and extract Godot 4.3 dev6 (.NET version)
  3. Download/install .NET8
  4. Clone/download this repo (or the most recent dev branch to have the most current features), open it with Godot 4.3 .NET, click Project > Project Settings > Plugins > Enabled (Mind Game).
  5. Load a .gguf file of the Llama, Mistral, Mixtral, or Phi families to get going!

The lower quantization (q), the smaller the model is to run but at the cost of accuracy. Llama-3-8B-Instruct.Q4_K_M is a great middle-ground for those with 8GB of VRAM. The absolute smallest model Phi-3-mini-128k-instruct.IQ1_S.gguf can run on less than 1GB of VRAM.

Future steps

  • Implement LLaVa support (including viewport analysis)
  • Make Download Manager functional
  • Make a singleton to be able to access currently loaded model in-game Complete 0.2.0
  • Transition to BatchedExecutor and add conversation forking/rewinding
  • Add network graph generation
  • Add project script crawling
  • Expose LLamaSharp methods like quantization
  • Integrate Kernel Memory for document ingestion

Version History

0.2.0:

  • MindManager is now an autoload
  • Model configurations can be saved/loaded
  • MindAgent nodes can be added in the inspector
  • 3D chat example with MindAgent3D

0.1.3:

  • First release, model loading and chat enabled in engine bottom bar

About

Mind Game is a C# plugin for Godot 4.3 to run LLMs locally in games

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages