LLM for Unity  v2.0.3
Create characters in Unity with LLMs!
Loading...
Searching...
No Matches
Overview

Create characters in Unity with LLMs!

License: MIT Reddit LinkedIn Asset Store GitHub Repo stars Documentation

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 leaves the game!
  • โšก Blazing fast inference on CPU and GPU (Nvidia, AMD, Apple Metal)
  • ๐Ÿค— Supports all 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, leave us a review 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

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:

How to use

First you will setup the LLM for your game ๐ŸŽ:

  • 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).

Then you can setup each of your characters as follows ๐Ÿ™‹โ€โ™€๏ธ:

  • Create an empty GameObject for the character.
    In the GameObject Inspector click Add Component and select the LLMCharacter script.
  • Select the LLM constructed above in the LLM field.
  • 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).

You can also adjust the LLM and character settings according to your preference (see Options).

In your script you can then use it as follows ๐Ÿฆ„:

using LLMUnity;
public class MyScript {
public LLMCharacter llmCharacter;
void HandleReply(string reply){
// do something with the reply from the model
Debug.Log(reply);
}
void Game(){
// your game function
...
string message = "Hello bot!";
_ = llmCharacter.Chat(message, HandleReply);
...
}
}
Class implementing the LLM characters.
async Task< string > Chat(string query, Callback< string > callback=null, EmptyCallback completionCallback=null, bool addToHistory=true)
Chat functionality of the LLM. It calls the LLM completion based on the provided query including the ...

You can also specify a function to call when the model reply has been completed.
This is useful if the Stream option is enabled 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!";
_ = llmCharacter.Chat(message, HandleReply, ReplyCompleted);
...
}

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

llmCharacter.CancelRequests();
void CancelRequests()
Cancel the ongoing requests e.g. Chat, Complete.
  • Finally, in the Inspector of the GameObject of your script, select the LLMCharacter GameObject created above as the llmCharacter property.

That's all โœจ!

You can also:

Save / Load your chat history

To automatically save / load your chat history, you can specify the Save parameter of the LLMCharacter to the filename (or relative path) of your choice. The file is saved in the persistentDataPath folder of Unity. This also saves the state of the LLM which means that the previously cached prompt does not need to be recomputed.

To manually save your chat history, you can use:

llmCharacter.Save("filename");
async Task< string > Save(string filename)
Saves the chat history and cache to the provided filename / relative path.

and to load the history:

llmCharacter.Load("filename");
async Task< string > Load(string filename)
Load the chat history and cache from the provided filename / relative path.

where filename the filename or relative path of your choice.

Process the prompt at the beginning of your app for faster initial processing time

void WarmupCompleted(){
// do something when the warmup is complete
Debug.Log("The AI is warm");
}
void Game(){
// your game function
...
_ = llmCharacter.Warmup(WarmupCompleted);
...
}
async Task< string > Warmup(EmptyCallback completionCallback=null, string query="hi")
Allow to warm-up a model by processing the prompt. The prompt processing will be cached (if cacheProm...

Decide whether or not to add the message to the chat/prompt history

The last argument of the Chat function is a boolean that specifies whether to add the message to the history (default: true):

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

Use pure text completion

void Game(){
// your game function
...
string message = "The cat is away";
_ = llmCharacter.Complete(message, HandleReply, ReplyCompleted);
...
}
async Task< string > Complete(string prompt, Callback< string > callback=null, EmptyCallback completionCallback=null)
Pure completion functionality of the LLM. It calls the LLM completion based solely on the provided pr...

Wait for the reply before proceeding to the next lines of code

For this you can use the async/await functionality:

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

Add a LLM / LLMCharacter component programmatically

using UnityEngine;
using LLMUnity;
public class MyScript : MonoBehaviour
{
LLM llm;
LLMCharacter llmCharacter;
async void Start()
{
// disable gameObject so that Awake is not called immediately
gameObject.SetActive(false);
// Add an LLM object
llm = gameObject.AddComponent<LLM>();
// set the model with a path relative to StreamingAssets folder
await llm.SetModel("Phi-3-mini-4k-instruct-q4.gguf");
// you can also set a lora in a similar fashion
// await llm.SetLora("my-lora.bin");
// optional: set number of threads
llm.numThreads = -1;
// optional: enable GPU by setting the number of model layers to offload to it
llm.numGPULayers = 10;
// Add an LLMCharacter object
llmCharacter = gameObject.AddComponent<LLMCharacter>();
// set the LLM object that handles the model
llmCharacter.llm = llm;
// set the character prompt
llmCharacter.SetPrompt("A chat between a curious human and an artificial intelligence assistant.");
// set the AI and player name
llmCharacter.AIName = "AI";
llmCharacter.playerName = "Human";
// optional: set streaming to false to get the complete result in one go
// llmCharacter.stream = true;
// optional: set a save path
// llmCharacter.save = "AICharacter1";
// optional: set a grammar
// llmCharacter.SetGrammar("json.gbnf");
// re-enable gameObject
gameObject.SetActive(true);
}
}
void SetPrompt(string newPrompt, bool clearChat=true)
Set the system prompt for the LLMCharacter.
Class implementing the LLM server.
Definition LLM.cs:31
async Task SetModel(string path)
Allows to set the model used by the LLM. The model provided is copied to the Assets/StreamingAssets f...
Definition LLM.cs:131

Use a remote server

You can also use a remote server that does the processing and implement Characters that interact with it. To do that:

  • Create a project with a GameObject using the LLM script as described above. Enable the Remote option and optionally configure the port.
  • Create a second project with the game characters using the LLMCharacter script as described above. Enable the Remote option and configure the host and port with the IP address (starting with "http://") and port of the server.

A detailed documentation on function level can be found here:

Examples

The Samples~ folder contains several examples of interaction ๐Ÿค–:

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.
HuggingFace models can be converted to gguf with this online converter.

โ• Before using any model make sure you check their license โ•

Options

LLM Settings

  • Show/Hide Advanced Options Toggle to show/hide advanced options from below
  • Log Level select how verbose the log messages are

๐Ÿ’ป Setup Settings

  • Remote select to provide remote access to the LLM
  • Port port to run the LLM server (if Remote is set)
  • 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. Note that higher values of context size will use more VRAM. If the user's GPU is not supported, the LLM will fall back to the CPU
  • Debug select to log the output of the model in the Unity Editor
  • Advanced options
    • Parallel Prompts number of prompts that can happen in parallel (default: -1 = number of LLMCharacter objects)
    • Dont Destroy On Load select to not destroy the LLM GameObject when loading a new Scene

๐Ÿค— 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" template works with most of the models.

  • Advanced options
    • Load lora click to load a LoRA model in .bin format
    • Lora the path of the LoRA 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. Higher values use more RAM or VRAM (if using GPU).

    • Batch Size batch size for prompt processing (default: 512)

๐Ÿ—จ๏ธ Chat Settings

  • Advanced options

  • Base Prompt a common base prompt to use across all LLMCharacter objects using the LLM

LLMCharacter Settings

  • Show/Hide Advanced Options Toggle to show/hide advanced options from below
  • Log Level select how verbose the log messages are

๐Ÿ’ป Setup Settings

  • Remote whether the LLM used is remote or local
  • LLM the LLM GameObject (if Remote is not set)
  • Hort ip of the LLM (if Remote is set)
  • Port port of the LLM (if Remote is set)
  • Save save filename or relative path

    If set, the chat history and LLM state (if save cache is enabled) is automatically saved to file specified.
    The chat history is saved with a json suffix and the LLM state with a cache suffix.
    Both files are saved in the persistentDataPath folder of Unity.

  • Save Cache select to save the LLM state along with the chat history. The LLM state is typically around 100MB+.
  • Debug Prompt select to log the constructed prompts in the Unity Editor

๐Ÿ—จ๏ธ Chat Settings

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

๐Ÿค— Model Settings

  • 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
    • Load grammar click to load a grammar in .gbnf format
    • Grammar the path of the grammar being used (relative to the Assets/StreamingAssets folder)
    • Cache Prompt save the ongoing prompt from the chat (default: true)

      Saves the prompt while it is being created by the chat to avoid reprocessing the entire prompt every time

    • Seed seed for reproducibility. For random results every time use -1
    • Num Predict maximum number of tokens to predict (default: 256, -1 = infinity, -2 = until context filled)

      This is the maximum amount of tokens the model will maximum predict. When N tokens are 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 outputs.

    • 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.

    • 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: enable to ignore end of stream tokens and continue generating (default: false).

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).