https://github.com/hectorpulido/unityandllama2

This is a binding between a Llama2 LLM and Unity for Gamedev
https://github.com/hectorpulido/unityandllama2

ai gamedev unity

Last synced: 12 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/hectorpulido/unityandllama2
Owner: HectorPulido
License: mit
Created: 2023-08-27T21:25:33.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-12-13T04:48:47.000Z (over 2 years ago)
Last Synced: 2023-12-13T05:33:16.803Z (over 2 years ago)
Topics: ai, gamedev, unity
Language: ShaderLab
Homepage: https://pequesoft.net
Size: 4.39 MB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# UnityAndLLama2
This is an open-source project meant to connect Unity with the Meta LLama2 Large language model using Python websockets. It's a client-server architecture, useful for online or offline games
![Banner](/img/LlamaUnity.gif)
## Table of Contents

- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Running the Server](#running-the-server)
- [Running the Unity Client](#running-the-unity-client)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Getting Started

### Prerequisites

- Python 3.6+
- Unity 2020.3+

### Installation

1. Create a new project in Unity
2. Clone this repository
```
git clone https://github.com/HectorPulido/UnityAndLLama2.git
```
3. Drag and drop the "clientSource" content into the project
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 `UnityProject` folder with the Unity 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