LLMUnity

LLMUnity copied to clipboard

Create characters in Unity with LLMs!

LLM for Unity enables seamless integration of Large Language Models (LLMs) within the Unity engine.
It allows to create intelligent characters that your players can interact with for an immersive experience.
LLM for Unity is built on top of the awesome llama.cpp and llamafile libraries.

At a glance

• 💻 Cross-platform! Windows, Linux and macOS
• 🏠 Runs locally without internet access. No data ever leave the game!
• ⚡ Blazing fast inference on CPU and GPU (Nvidia, AMD, Apple Metal)
• 🤗 Support of the major LLM models
• 🔧 Easy to setup, call with a single line of code
• 💰 Free to use for both personal and commercial purposes

🧪 Tested on Unity: 2021 LTS, 2022 LTS, 2023
🚦 Upcoming Releases

How to help

• ⭐ Star the repo and spread the word about the project!
• Join us at Discord and say hi!
• Submit feature requests or bugs as issues or even submit a PR and become a collaborator

Games using LLM for Unity

• Verbal Verdict
• I, Chatbot: AISYLUM
• Nameless Souls of the Void
• Murder in Aisle 4

Setup

Method 1: Install using the asset store

• Open the LLM for Unity asset page and click Add to My Assets
• Open the Package Manager in Unity: Window > Package Manager
• Select the Packages: My Assets option from the drop-down
• Select the LLM for Unity package, click Download and then Import

Method 2: Install using the GitHub repo:

• Open the Package Manager in Unity: Window > Package Manager
• Click the + button and select Add package from git URL
• Use the repository URL https://github.com/undreamai/LLMUnity.git and click Add

On macOS you need the Xcode Command Line Tools:

• From inside a terminal run xcode-select --install

How to use

The first step is to create a GameObject for the LLM ♟️:

• Create an empty GameObject.
  In the GameObject Inspector click Add Component and select the LLM script.
• Download one of the default models with the Download Model button (~GBs).
  Or load your own .gguf model with the Load model button (see Use your own model).
• Define the role of your AI in the Prompt. You can also define the name of the AI (AI Name) and the player (Player Name).
• (Optional) By default you receive the reply from the model as is it is produced in real-time (recommended).
  If you want the full reply in one go, deselect the Stream option.
• (Optional) Adjust the server or model settings to your preference (see Options).

In your script you can then use it as follows 🦄:

using LLMUnity;

public class MyScript {
  public LLM llm;
  
  void HandleReply(string reply){
    // do something with the reply from the model
    Debug.Log(reply);
  }
  
  void Game(){
    // your game function
    ...
    string message = "Hello bot!";
    _ = llm.Chat(message, HandleReply);
    ...
  }
}

You can also specify a function to call when the model reply has been completed.
This is useful if the Stream option is selected for continuous output from the model (default behaviour):

  void ReplyCompleted(){
    // do something when the reply from the model is complete
    Debug.Log("The AI replied");
  }
  
  void Game(){
    // your game function
    ...
    string message = "Hello bot!";
    _ = llm.Chat(message, HandleReply, ReplyCompleted);
    ...
  }

To stop the chat without waiting its completion you can use:

    llm.CancelRequests();

• Finally, in the Inspector of the GameObject of your script, select the LLM GameObject created above as the llm property.

That's all ✨!

You can also:

using LLMUnity;

public class MyScript {
  public LLM cat;
  public LLMClient dog;
  public LLMClient bird;
  
  void HandleCatReply(string reply){
    // do something with the reply from the cat character
    Debug.Log(reply);
  }

  void HandleDogReply(string reply){
    // do something with the reply from the dog character
    Debug.Log(reply);
  }

  void HandleBirdReply(string reply){
    // do something with the reply from the bird character
    Debug.Log(reply);
  }
  
  void Game(){
    // your game function
    ...
    _ = cat.Chat("Hi cat!", HandleCatReply);
    _ = dog.Chat("Hello dog!", HandleDogReply);
    _ = bird.Chat("Hiya bird!", HandleBirdReply);
    ...
  }
}

  void WarmupCompleted(){
    // do something when the warmup is complete
    Debug.Log("The AI is warm");
  }

  void Game(){
    // your game function
    ...
    _ = llm.Warmup(WarmupCompleted);
    ...
  }

  void Game(){
    // your game function
    ...
    string message = "Hello bot!";
    _ = llm.Chat(message, HandleReply, ReplyCompleted, false);
    ...
  }

  void Game(){
    // your game function
    ...
    string message = "The cat is away";
    _ = llm.Complete(message, HandleReply, ReplyCompleted);
    ...
  }

  async void Game(){
    // your game function
    ...
    string message = "Hello bot!";
    string reply = await llm.Chat(message, HandleReply, ReplyCompleted);
    Debug.Log(reply);
    ...
  }

using UnityEngine;
using LLMUnity;

public class MyScript : MonoBehaviour
{
    LLM llm;
    LLMClient llmclient;

    async void Start()
    {
        // Add and setup a LLM object
        gameObject.SetActive(false);
        llm = gameObject.AddComponent<LLM>();
        await llm.SetModel("mistral-7b-instruct-v0.2.Q4_K_M.gguf");
        llm.prompt = "A chat between a curious human and an artificial intelligence assistant.";
        gameObject.SetActive(true);

        // or a LLMClient object
        gameObject.SetActive(false);
        llmclient = gameObject.AddComponent<LLMClient>();
        llmclient.prompt = "A chat between a curious human and an artificial intelligence assistant.";
        gameObject.SetActive(true);
    }
}

A detailed documentation on function level can be found here:

Examples

The Samples~ folder contains several examples of interaction 🤖:

• SimpleInteraction: Demonstrates simple interaction between a player and a AI
• AsyncStartup: Demonstrates how to use the async functionality for a loading screen
• ServerClient: Demonstrates simple interaction between a player and multiple AIs using a LLM and a LLMClient
• ChatBot: Demonstrates interaction between a player and a AI with a UI similar to a messaging app (see image below)

To install a sample:

• Open the Package Manager: Window > Package Manager
• Select the LLM for Unity Package. From the Samples Tab, click Import next to the sample you want to install.

The samples can be run with the Scene.unity scene they contain inside their folder.
In the scene, select the LLM GameObject and click the Download Model button to download the default model.
You can also load your own model in .gguf format with the Load model button (see Use your own model).
Save the scene, run and enjoy!

Use your own model

LLM for Unity uses the Mistral 7B Instruct, OpenHermes 2.5 or Microsoft Phi-3 model by default, quantised with the Q4 method.

Alternative models can be downloaded from HuggingFace.
The required model format is .gguf as defined by the llama.cpp.
Other model formats can be converted to gguf with the convert.py script of the llama.cpp as described here.

❕ Before using any model make sure you check their license ❕

Options

• Show/Hide Advanced Options Toggle to show/hide advanced options from below
• Show/Hide Expert Options Toggle to show/hide expert options from below

💻 Server Settings

• Num Threads number of threads to use (default: -1 = all)

• Num GPU Layers number of model layers to offload to the GPU. If set to 0 the GPU is not used. Use a large number i.e. >30 to utilise the GPU as much as possible. If the user's GPU is not supported, the LLM will fall back to the CPU

• Stream select to receive the reply from the model as it is produced (recommended!).
  If it is not selected, the full reply from the model is received in one go

• Advanced options

  • Parallel Prompts number of prompts that can happen in parallel (default: -1 = number of LLM/LLMClient objects)
  • Debug select to log the output of the model in the Unity Editor
  • Asynchronous Startup allows to start the server asynchronously
  • Remote select to allow remote access to the server
  • Port port to run the server
  • Kill Existing Servers On Start kills existing servers by the Unity project on startup to handle Unity crashes

🤗 Model Settings

• Download model click to download one of the default models

• Load model click to load your own model in .gguf format

• Model the path of the model being used (relative to the Assets/StreamingAssets folder)

• Chat Template the chat template to use for constructing the prompts

  The chat template is determined automatically by the chat template of the model (if it exists) or the model name. The "chatml" and "alpaca" templates work with most of the models.
• Advanced options

  • Load lora click to load a LORA model in .bin format
  • Load grammar click to load a grammar in .gbnf format
  • Lora the path of the Lora being used (relative to the Assets/StreamingAssets folder)
  • Grammar the path of the Grammar being used (relative to the Assets/StreamingAssets folder)
  • Context Size size of the prompt context (0 = context size of the model)

    This is the number of tokens the model can take as input when generating responses.
  • Batch Size batch size for prompt processing (default: 512)
  • Seed seed for reproducibility. For random results every time select -1
  • Cache Prompt save the ongoing prompt from the chat (default: true)

    Saves the prompt as it is being created by the chat to avoid reprocessing the entire prompt every time
  • Num Predict number of tokens to predict (default: 256, -1 = infinity, -2 = until context filled)

    This is the amount of tokens the model will maximum predict. When N predict is reached the model will stop generating. This means words / sentences might not get finished if this is too low.
  • Temperature LLM temperature, lower values give more deterministic answers (default: 0.2)

    The temperature setting adjusts how random the generated responses are. Turning it up makes the generated choices more varied and unpredictable. Turning it down makes the generated responses more predictable and focused on the most likely options.
  • Top K top-k sampling (default: 40, 0 = disabled)

    The top k value controls the top k most probable tokens at each step of generation. This value can help fine tune the output and make this adhere to specific patterns or constraints.
  • Top P top-p sampling (default: 0.9, 1.0 = disabled)

    The top p value controls the cumulative probability of generated tokens. The model will generate tokens until this theshold (p) is reached. By lowering this value you can shorten output & encourage / discourage more diverse output.
  • Min P minimum probability for a token to be used (default: 0.05)

    The probability is defined relative to the probability of the most likely token.
  • Repeat Penalty control the repetition of token sequences in the generated text (default: 1.1)

    The penalty is applied to repeated tokens.
  • Presence Penalty repeated token presence penalty (default: 0.0, 0.0 = disabled)

    Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
  • Frequency Penalty repeated token frequency penalty (default: 0.0, 0.0 = disabled)

    Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
• Expert options

  • Tfs_z: enable tail free sampling with parameter z (default: 1.0, 1.0 = disabled).

  • Typical P: enable locally typical sampling with parameter p (default: 1.0, 1.0 = disabled).

  • Repeat Last N: last n tokens to consider for penalizing repetition (default: 64, 0 = disabled, -1 = ctx-size).

  • Penalize Nl: penalize newline tokens when applying the repeat penalty (default: true).

  • Penalty Prompt: prompt for the purpose of the penalty evaluation. Can be either null, a string or an array of numbers representing tokens (default: null = use original prompt).

  • Mirostat: enable Mirostat sampling, controlling perplexity during text generation (default: 0, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0).

  • Mirostat Tau: set the Mirostat target entropy, parameter tau (default: 5.0).

  • Mirostat Eta: set the Mirostat learning rate, parameter eta (default: 0.1).

  • N Probs: if greater than 0, the response also contains the probabilities of top N tokens for each generated token (default: 0)

  • Ignore Eos: ignore end of stream token and continue generating (default: false).

🗨️ Chat Settings

• Player Name the name of the player
• AI Name the name of the AI
• Prompt description of the AI role

License

The license of LLM for Unity is MIT (LICENSE.md) and uses third-party software with MIT and Apache licenses (Third Party Notices.md).