https://github.com/opyate/godot-llm-experiment
Getting an LLM to work with Godot.
https://github.com/opyate/godot-llm-experiment
gdextension godot-engine godot4 llamacpp
Last synced: 5 months ago
JSON representation
Getting an LLM to work with Godot.
- Host: GitHub
- URL: https://github.com/opyate/godot-llm-experiment
- Owner: opyate
- License: mit
- Created: 2023-05-16T13:33:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T11:11:15.000Z (over 2 years ago)
- Last Synced: 2023-10-11T17:03:08.492Z (over 2 years ago)
- Topics: gdextension, godot-engine, godot4, llamacpp
- Language: C++
- Homepage:
- Size: 7.05 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
Trying to integrate an LLM into Godot.
First use-case: for spicing up NPC chatter.
[Video](https://www.youtube.com/watch?v=qHVFi8tws7Q):
[](https://www.youtube.com/watch?v=qHVFi8tws7Q)
Screenshot:
# Work log
See [docs/worklog.md](docs/worklog.md).
Linux-only for now. (Mac and Windows folks, please send PRs!)
# Quickstart
```
mkdir -p models
cd models
wget https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GGUF/resolve/main/mistral-7b-instruct-v0.1.Q5_K_M.gguf
cd ..
git clone https://github.com/ggerganov/llama.cpp.git llama_dot_cpp
git clone https://github.com/godotengine/godot-cpp.git
cp SConstruct-llamacpp llama_dot_cpp/SConstruct
cd llama_dot_cpp
scons -j31
cd ..
cd godot-cpp
git checkout godot-4.1.1-stable
cp gdextension/extension_api.json ../the-game/extension_api.json
scons platform=linux -j31 custom_api_file=$(pwd)/../the-game/extension_api.json
cd ..
cp llama_dot_cpp/libllama.so the-game/bin
# build my gdextension here:
scons platform=linux -j31
cp models/mistral-7b-instruct-v0.1.Q5_K_M.gguf the-game/bin/
# load the game in Godot
```
Note that if you run `scons -c` in the root, it will remove the built dependencies in `llama_dot_cpp`, so scons have to be run for the latter again for building the extension.
So, any future iterations look like this:
```
rm the-game/bin/*.so; scons -c
# make changes to the extension code
cd llama_dot_cpp
scons -j31
cd ..
cp llama_dot_cpp/libllama.so the-game/bin
scons platform=linux -j31
```
Or
```
rm the-game/bin/libgdllm.linux.template_debug.x86_64.so
rm src/*.os
scons platform=linux -j31
```
If any experts in scons/c++ reads this, I think the `SConstruct-llamacpp` step is probably unnecessary, and that I can get away with building llama.cpp using its own Makefile, and then just linking to the resulting `.a` file in the extension's `SConstruct` file. But I'm not sure how to do that.
# Export
```
cd the-game
godot --export-debug "Linux/X11" godot-llm-experiment.x86_64
cd ..
```
(I see [this](docs/export-log.txt) when I run the above command.)
It will run from here with `./godot-llm-experiment.x86_64`, because it's alongside the bin/ folder.
To run it standalone, outside of the context of the source/project files:
```
TMP=$(mktemp -d)
cp the-game/godot-llm-experiment.x86_64 $TMP
cp -R the-game/bin $TMP
cd $TMP
./godot-llm-experiment.x86_64
```
You can now publish $TMP as a ZIP file.
# Credits
- Godot engine - https://godotengine.org/
- image used in game is from https://growngaming.com/awesome/1st-gen-pokemon-sprites/
- llama.cpp - https://github.com/ggerganov/llama.cpp
- Mistral 7B LLM - https://mistral.ai/news/announcing-mistral-7b/