HectorPulido / godot-llama2

This is a binding between a Llama2 LLM and Godot for Gamedev

Godot + Llama2

This is an open-source project meant to connect godot with the Meta LLama2 Large language model using Python websockets. It's a client-server architecture, useful for online or offline games

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Running the Server
  • Running the godot Client
• Contributing
• License
• Contact

Getting Started

Prerequisites

• Python 3.6+
• Godot Mono (C#)

Installation

1. Create a new project in Unity
2. Clone this repository
3. Open the Godot project in the godotClient folder
4. Then enter to the "llamaServer" folder
5. Is very useful to create a virtual enviroment, install the dependencies with pip install -r requirements.txt
6. Copy the .env.test into a .env file and changit as you want

Usage

Running the Server

Start the server python server.py

If working correctly, the server should display Listen in: localhost:8765

Running the Unity Client

1. Open the Godot project folder with the Godot Mono Editor
2. Open the sample scene
3. Press the play button to start the client

Contributing

Your contributions are greatly appreciated! Please follow these steps:

1. Fork the project
2. Create your feature branch git checkout -b feature/MyFeature
3. Commit your changes git commit -m "my cool feature"
4. Push to the branch git push origin feature/MyFeature
5. Open a Pull Request

License

Every basecode made by my is under MIT licence

Let's connect 😋