An Unreal focused API wrapper for llama.cpp to support embedding LLMs into your games locally. Forked from upstream to focus on improved API with wider support for builds (CPU, CUDA, Android, Mac).
Early releases, api still pretty unstable YMMV.
NB: currently has #7 issue which may require you to do your own static llama.cpp build until resolved.
- Download Latest Release Ensure to use the
Llama-Unreal-UEx.x-vx.x.x.7z
link which contains compiled binaries, not the Source Code (zip) link. - Create new or choose desired unreal project.
- Browse to your project folder (project root)
- Copy Plugins folder from .7z release into your project root.
- Plugin should now be ready to use.
If you want to do builds for your own use case or replace the llama.cpp backend. Note that these build instructions should be run from the cloned llama.cpp root directory, not the plugin root.
Forked Plugin Llama.cpp was built from git hash: b7e7982953f80a656e03feb5cfb17a17a173eb26
With the following build commands for windows (cpu build only, CUDA ignored, see upstream for GPU version):
mkdir build
cd build/
cmake ..
cmake --build . --config Release -j --verbose
ATM built for CUDA 12.2 runtime
- Use
cuda
branch if you want cuda enabled. - We build statically due to dll runtime load bug so you need to copy
cudart.lib
cublas.lib
andcuda.lib
into your libraries/win64 path. These are ignored atm. - You also need to update
bUseCuda = true;
in .build.cs to add CUDA libs to build. - Ideally this needs a variant that build with
-DBUILD_SHARED_LIBS=ON
mkdir build
cd build
cmake .. -DLLAMA_CUBLAS=ON -DLLAMA_CUDA_DMMV_X=64 -DLLAMA_CUDA_MMV_Y=2 -DLLAMA_CUDA_F16=true
cmake --build . --config Release -j --verbose
mkdir build
cd build/
cmake .. -DBUILD_SHARED_LIBS=ON
cmake --build . --config Release -j --verbose
For Android build see: https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#android
mkdir build-android
cd build-android
export NDK=<your_ndk_directory>
cmake -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake -DANDROID_ABI=arm64-v8a -DANDROID_PLATFORM=android-23 -DCMAKE_C_FLAGS=-march=armv8.4a+dotprod ..
$ make
Then the .so or .lib file was copied into the Libraries
directory and all the .h files were copied to the Includes
directory.