Create characters in Unity with LLMs!

[![LinkedIn](https://camo.githubusercontent.com/845676b3fe4e123995055ec3fb1da6403c3126f65c1aa5dee0c27ea67bf41c0b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c696e6b6564496e2d626c75653f7374796c653d666c6174266c6f676f3d6c696e6b6564696e266c6162656c436f6c6f723d626c7565)](https://www.linkedin.com/company/undreamai) [![GitHub Repo stars](https://camo.githubusercontent.com/a30c3a778cc19407c758622e795ff559004708242311a0a88f1d3f41c68ade8a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f756e647265616d61692f4c4c4d556e6974793f7374796c653d666c6174266c6f676f3d67697468756226636f6c6f723d663566356635)](https://github.com/undreamai/LLMUnity) 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.
The package also features a Retrieval-Augmented Generation (RAG) system that allows to performs semantic search across your data, which can be used to enhance the character's knowledge. LLM for Unity is built on top of the awesome [llama.cpp](https://github.com/ggerganov/llama.cpp) library. _{At a glance  •
How to help  •
Games / Projects using LLM for Unity  •
Setup  •
How to use  •
RAG  •
LLM model management  •
Examples  •
Options  •
License} ## At a glance - 💻 Runs anywhere: PC, mobile or VR! - 🏠 Runs locally without internet access. No data ever leave 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, Unity 6
🚦 [Upcoming Releases](https://github.com/orgs/undreamai/projects/2/views/10) ## How to help - [⭐ Star](https://github.com/undreamai/LLMUnity) the repo, leave us a [review](https://assetstore.unity.com/packages/slug/273604) and spread the word about the project! - Join us at [Discord](https://discord.gg/RwXKQb6zdv) and say hi. - [Contribute](https://github.com/undreamai/LLMUnity/blob/main/CONTRIBUTING.md) by submitting feature requests, bugs or even your own PR. - [![](https://camo.githubusercontent.com/6d24ad1fc18fa9d263cacee4c5d9aa8e15128bd5f3f3184f6f54d20e6a4ab63b/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d53706f6e736f72266d6573736167653d254532253944254134266c6f676f3d47697448756226636f6c6f723d253233666538653836)](https://github.com/sponsors/amakropoulos) this work to allow even cooler features! ## Games / Projects using LLM for Unity - [Verbal Verdict](https://store.steampowered.com/app/2778780/Verbal_Verdict/) - [I, Chatbot: AISYLUM](https://store.epicgames.com/de/p/i-chatbot-aisylum-83b2b5) - [Nameless Souls of the Void](https://unicorninteractive.itch.io/nameless-souls-of-the-void) - [Murder in Aisle 4](https://roadedlich.itch.io/murder-in-aisle-4) - [Finicky Food Delivery AI](https://helixngc7293.itch.io/finicky-food-delivery-ai) - [AI Emotional Girlfriend](https://whynames.itch.io/aiemotionalgirlfriend) - [Case Closed](https://store.steampowered.com/app/2532160/Case_Closed) - [MaiMai AI Agent System](https://github.com/IhateCreatingUserNames2/MaiMai) - [Claria Chat](https://play.google.com/store/apps/details?id=com.ProLink.ClariaChat) - [Endless Casual Drive](https://store.steampowered.com/app/2928500/Endless_Casual_Drive/) - [Dating App Simulator](https://store.steampowered.com/app/3415680/Dating_App_Simulator/) - [Virtual Reality Mock Interview](https://vrmi.vercel.app/) - [Velesio AI server](https://github.com/Velesio/Velesio-AIServer) - [Dungeon Chat](https://www.meta.com/experiences/dungeonchat/8527310950709276/) - [Tomonaka Desk](https://joycatdev.itch.io/tomonaka-desk) - [Digital Humans](https://store.steampowered.com/app/3089280/Digital_Humans/) Contact us to add your project! ## Setup _Method 1: Install using the asset store_ - Open the [LLM for Unity](https://assetstore.unity.com/packages/slug/273604) 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` ## 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 [LLM model management](https://github.com/undreamai/LLMUnity/raw/main/#llm-model-management)). 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. - Define the role of your AI in the `Prompt`. You can define the name of the AI (`AI Name`) and the player (`Player Name`). - (Optional) Select the LLM constructed above in the `LLM` field if you have more than one LLM GameObjects. You can also adjust the LLM and character settings according to your preference (see [Options](https://github.com/undreamai/LLMUnity/raw/main/#options)). In your script you can then use it as follows 🦄: ``` c# 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); ... } } ``` 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): ``` c# 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: ``` c# llmCharacter.CancelRequests(); ``` - 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:

Build a mobile app

For mobile apps you can use models with up to 1-2 billion parameters ("Tiny models" in the LLM model manager).
Larger models will typically not work due to the limited mobile hardware. **iOS** iOS can be built with the default player settings. **Android** On Android you need to specify the `IL2CPP` scripting backend and the `ARM64` as the target architecture in the player settings.
These settings can be accessed from the `Edit > Project Settings` menu within the `Player > Other Settings` section.

Since mobile app sizes are typically small, you can download the LLM models the first time the app launches. This functionality can be enabled with the `Download on Build` option. In your project you can wait until the model download is complete with: ``` c# await LLM.WaitUntilModelSetup(); ``` You can also receive calls during the download with the download progress: ``` c# await LLM.WaitUntilModelSetup(SetProgress); void SetProgress(float progress){ string progressPercent = ((int)(progress * 100)).ToString() + "%"; Debug.Log($"Download progress: {progressPercent}"); } ``` This is useful to present a progress bar or something similar. The [MobileDemo](https://github.com/undreamai/LLMUnity/raw/main/Samples~/MobileDemo) is an example application for Android / iOS.

Restrict the output of the LLM / Function calling

To restrict the output of the LLM you can use a grammar, read more [here](https://github.com/ggerganov/llama.cpp/tree/master/grammars).
The grammar can be saved in a .gbnf file and loaded at the LLMCharacter with the `Load Grammar` button (Advanced options).
For instance to receive replies in json format you can use the [json.gbnf](https://github.com/ggerganov/llama.cpp/raw/b4218/grammars/json.gbnf) grammar.
Graamars in JSON schema format are also supported and can be loaded with the `Load JSON Grammar` button (Advanced options).
Alternatively you can set the grammar directly with code: ``` c# // GBNF grammar llmCharacter.grammarString = "your GBNF grammar here"; // or JSON schema grammar llmCharacter.grammarJSONString = "your JSON schema grammar here"; ``` For function calling you can define similarly a grammar that allows only the function names as output, and then call the respective function.
You can look into the [FunctionCalling](https://github.com/undreamai/LLMUnity/raw/main/Samples~/FunctionCalling) sample for an example implementation.

Access / Save / Load your chat history

The chat history of a `LLMCharacter` is retained in the `chat` variable that is a list of `ChatMessage` objects.
The ChatMessage is a struct that defines the `role` of the message and the `content`.
The first element of the list is always the system prompt and then alternating messages with the player prompt and the AI reply.
You can modify the chat history directly in this list.
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](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html). 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: ``` c# llmCharacter.Save("filename"); ``` and to load the history: ``` c# llmCharacter.Load("filename"); ``` where filename the filename or relative path of your choice.

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

``` c# void WarmupCompleted(){ // do something when the warmup is complete Debug.Log("The AI is nice and ready"); } void Game(){ // your game function ... _ = llmCharacter.Warmup(WarmupCompleted); ... } ```

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): ``` c# void Game(){ // your game function ... string message = "Hello bot!"; _ = llmCharacter.Chat(message, HandleReply, ReplyCompleted, false); ... } ```

Use pure text completion

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

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

For this you can use the `async`/`await` functionality: ``` c# 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

``` c# using UnityEngine; using LLMUnity; public class MyScript : MonoBehaviour { LLM llm; LLMCharacter llmCharacter; async void Start() { // disable gameObject so that theAwake is not called immediately gameObject.SetActive(false); // Add an LLM object llm = gameObject.AddComponent(); // set the model using the filename of the model. // The model needs to be added to the LLM model manager (see LLM model management) by loading or downloading it. // Otherwise the model file can be copied directly inside the StreamingAssets folder. llm.SetModel("Phi-3-mini-4k-instruct-q4.gguf"); // optional: you can also set loras in a similar fashion and set their weights (if needed) llm.AddLora("my-lora.gguf"); llm.SetLoraWeight(0.5f); // optional: you can set the chat template of the model if it is not correctly identified // You can find a list of chat templates in the ChatTemplate.templates.Keys llm.SetTemplate("phi-3"); // 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(); // 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: enable the save cache to avoid recomputation when loading a save file (requires ~100 MB) // llmCharacter.saveCache = true; // optional: set a grammar // await llmCharacter.SetGrammar("json.gbnf"); // re-enable gameObject gameObject.SetActive(true); } } ```

Use a remote server

You can use a remote server to carry out the processing and implement characters that interact with it. **Create the server**
To create the server: - Create a project with a GameObject using the `LLM` script as described above - Enable the `Remote` option of the `LLM` and optionally configure the server parameters: port, API key, SSL certificate, SSL key - Build and run to start the server Alternatively you can use a server binary for easier deployment: - Run the above scene from the Editor and copy the command from the Debug messages (starting with "Server command:") - Download the [server binaries](https://github.com/undreamai/LlamaLib/releases/download/v1.2.6/undreamai-v1.2.6-server.zip) and [DLLs](https://github.com/undreamai/LlamaLib/releases/download/v1.2.6/undreamai-v1.2.6-llamacpp-full.zip) and extract them into the same folder - Find the architecture you are interested in from the folder above e.g. for Windows and CUDA use the `windows-cuda-cu12.2.0`.
You can also check the architecture that works for your system from the Debug messages (starting with "Using architecture"). - From command line change directory to the architecture folder selected and start the server by running the command copied from above. In both cases you'll need to enable 'Allow Downloads Over HTTP' in the project settings. **Create the characters**
Create a second project with the game characters using the `LLMCharacter` script as described above. Enable the `Remote` option and configure the host with the IP address (starting with "http://") and port of the server.

Compute embeddings using a LLM

The `Embeddings` function can be used to obtain the emdeddings of a phrase: ``` c# List embeddings = await llmCharacter.Embeddings("hi, how are you?"); ```

A detailed documentation on function level can be found here:

## Semantic search with a Retrieval-Augmented Generation (RAG) system LLM for Unity implements a super-fast similarity search functionality with a Retrieval-Augmented Generation (RAG) system.
It is based on the LLM functionality, and the Approximate Nearest Neighbors (ANN) search from the [usearch](https://github.com/unum-cloud/usearch) library.
Semantic search works as follows. **Building the data** You provide text inputs (a phrase, paragraph, document) to add to the data.
Each input is split into chunks (optional) and encoded into embeddings with a LLM. **Searching** You can then search for a query text input.
The input is again encoded and the most similar text inputs or chunks in the data are retrieved. To use semantic serch: - create a GameObject for the LLM as described above. Download one of the provided RAG models or load your own (good options can be found at the [MTEB leaderboard](https://huggingface.co/spaces/mteb/leaderboard)). - create an empty GameObject. In the GameObject Inspector click `Add Component` and select the `RAG` script. - In the Search Type dropdown of the RAG select your preferred search method. `SimpleSearch` is a simple brute-force search, while`DBSearch` is a fast ANN method that should be preferred in most cases. - In the Chunking Type dropdown of the RAG you can select a method for splitting the inputs into chunks. This is useful to have a more consistent meaning within each data part. Chunking methods for splitting according to tokens, words and sentences are provided. Alternatively, you can create the RAG from code (where llm is your LLM): ``` c# RAG rag = gameObject.AddComponent(); rag.Init(SearchMethods.DBSearch, ChunkingMethods.SentenceSplitter, llm); ``` In your script you can then use it as follows :unicorn:: ``` c# using LLMUnity; public class MyScript : MonoBehaviour { RAG rag; async void Game(){ ... string[] inputs = new string[]{ "Hi! I'm a search system.", "the weather is nice. I like it.", "I'm a RAG system" }; // add the inputs to the RAG foreach (string input in inputs) await rag.Add(input); // get the 2 most similar inputs and their distance (dissimilarity) to the search query (string[] results, float[] distances) = await rag.Search("hello!", 2); // to get the most similar text parts (chnuks) you can enable the returnChunks option rag.ReturnChunks(true); (results, distances) = await rag.Search("hello!", 2); ... } } ``` You can also add / search text inputs for groups of data e.g. for a specific character or scene: ``` c# // add the inputs to the RAG for a group of data e.g. an orc character foreach (string input in inputs) await rag.Add(input, "orc"); // get the 2 most similar inputs for the group of data e.g. the orc character (string[] results, float[] distances) = await rag.Search("how do you feel?", 2, "orc"); ... You can save the RAG state (stored in the `Assets/StreamingAssets` folder): ``` c# rag.Save("rag.zip"); ``` and load it from disk: ``` c# await rag.Load("rag.zip"); ``` You can use the RAG to feed relevant data to the LLM based on a user message: ``` c# string message = "How is the weather?"; (string[] similarPhrases, float[] distances) = await rag.Search(message, 3); string prompt = "Answer the user query based on the provided data.\n\n"; prompt += $"User query: {message}\n\n"; prompt += $"Data:\n"; foreach (string similarPhrase in similarPhrases) prompt += $"\n- {similarPhrase}"; _ = llmCharacter.Chat(prompt, HandleReply, ReplyCompleted); ``` The `RAG` sample includes an example RAG implementation as well as an example RAG-LLM integration. That's all :sparkles:! ## LLM model management LLM for Unity uses a model manager that allows to load or download LLMs and ship them directly in your game.
The model manager can be found as part of the LLM GameObject:

You can download models with the `Download model` button.
LLM for Unity includes different state of the art models built-in for different model sizes, quantised with the Q4_K_M method.
Alternative models can be downloaded from [HuggingFace](https://huggingface.co/models?library=gguf&sort=downloads) in the .gguf format.
You can download a model locally and load it with the `Load model` button, or copy the URL in the `Download model > Custom URL` field to directly download it.
If a HuggingFace model does not provide a gguf file, it can be converted to gguf with this [online converter](https://huggingface.co/spaces/ggml-org/gguf-my-repo).
The chat template used for constructing the prompts is determined automatically from the model (if a relevant entry exists) or the model name.
If incorrecly identified, you can select another template from the chat template dropdown.

Models added in the model manager are copied to the game during the building process.
You can omit a model from being built in by deselecting the "Build" checkbox.
To remove the model (but not delete it from disk) you can click the bin button.
The the path and URL (if downloaded) of each added model is diplayed in the expanded view of the model manager access with the `>>` button:

You can create lighter builds by selecting the `Download on Build` option.
Using this option the models will be downloaded the first time the game starts instead of copied in the build.
If you have loaded a model locally you need to set its URL through the expanded view, otherwise it will be copied in the build.
❕ Before using any model make sure you **check their license** ❕ ## Examples The [Samples~](https://github.com/undreamai/LLMUnity/raw/main/Samples~) folder contains several examples of interaction 🤖: - [SimpleInteraction](https://github.com/undreamai/LLMUnity/raw/main/Samples~/SimpleInteraction): Simple interaction with an AI character - [MultipleCharacters](https://github.com/undreamai/LLMUnity/raw/main/Samples~/MultipleCharacters): Simple interaction using multiple AI characters - [FunctionCalling](https://github.com/undreamai/LLMUnity/raw/main/Samples~/FunctionCalling): Function calling sample with structured output from the LLM - [RAG](https://github.com/undreamai/LLMUnity/raw/main/Samples~/RAG): Semantic search using a Retrieval Augmented Generation (RAG) system. Includes example using a RAG to feed information to a LLM - [MobileDemo](https://github.com/undreamai/LLMUnity/raw/main/Samples~/MobileDemo): Example mobile app for Android / iOS with an initial screen displaying the model download progress - [ChatBot](https://github.com/undreamai/LLMUnity/raw/main/Samples~/ChatBot): Interaction between a player and a AI with a UI similar to a messaging app (see image below) - [KnowledgeBaseGame](https://github.com/undreamai/LLMUnity/raw/main/Samples~/KnowledgeBaseGame): Simple detective game using a knowledge base to provide information to the LLM based on [google/mysteryofthreebots](https://github.com/google/mysteryofthreebots)

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 a default model or `Load model` to load your own model (see [LLM model management](https://github.com/undreamai/LLMUnity/raw/main/#llm-model-management)).
Save the scene, run and enjoy! ## Options Details on the different parameters are provided as Unity Tooltips. Previous documentation can be found [here](https://github.com/undreamai/LLMUnity/blob/main/Options.md) (deprecated). ## License The license of LLM for Unity is MIT ([LICENSE.md](https://github.com/undreamai/LLMUnity/blob/main/LICENSE.md)) and uses third-party software with MIT and Apache licenses. Some models included in the asset define their own license terms, please review them before using each model. Third-party licenses can be found in the ([Third Party Notices.md](https://github.com/undreamai/LLMUnity/blob/main/)).