https://github.com/sofianedjerbi/pixelpal

GPT as your game companion - Rust & Bevy powered!
https://github.com/sofianedjerbi/pixelpal

bevy chatgpt game gpt rust

Last synced: 2 days ago
JSON representation

GPT as your game companion - Rust & Bevy powered!

• Host: GitHub
• URL: https://github.com/sofianedjerbi/pixelpal
• Owner: sofianedjerbi
• License: agpl-3.0
• Created: 2023-12-17T23:33:40.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-27T14:46:05.000Z (11 months ago)
• Last Synced: 2024-10-28T16:56:42.258Z (about 2 months ago)
• Topics: bevy, chatgpt, game, gpt, rust
• Language: Rust
• Homepage: https://chaoxel.dev/PixelPal/
• Size: 24.8 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
PixelPal

  
Play with ChatGPT!


  [![License](https://img.shields.io/github/license/chaoxel/PixelPal?style=for-the-badge&logo=github)](LICENSE)

  [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/chaoxel/PixelPal/ci.yml?style=for-the-badge)](https://github.com/chaoxel/PixelPal/actions)

  [![Discord](https://img.shields.io/discord/1195177036210253864?color=5865F2&label=discord&style=for-the-badge)](https://discord.gg/jwb26Xy5M7)



## Description

This project, currently in progress, integrates ChatGPT into a game, where it serves as a dynamic and helpful in-game companion.  

Powered by Rust and Bevy, it's a modern and exciting adventure waiting to unfold.

## Setup & Running

### Prerequisites

- [ChatGPT API Key](https://platform.openai.com/)

- [Rust](https://www.rust-lang.org/) (building)

- [Cargo](https://www.rust-lang.org/) (building)

### Step 1: Clone the Repository

Clone this repository to your local machine using Git.

```bash

git clone https://github.com/chaoxel/PixelPal.git

```

### Step 2: Setup Your API Key

Navigate to the project directory and open the `.env.example` file.  

Add your API key as shown below:

```bash

# YOUR KEY HERE

GPT_KEY=sk-aaSWdEOk...

```

After adding the key, rename the file from `.env.example` to `.env`. 

### Step 3: Compile & Run

You can now compile and run the project.

```bash

cargo run --release

```

## Credits

### Contributors

- [@chaoxel](https://github.com/chaoxel)

### Assets

- [@cup_nooble_](https://twitter.com/Cup_Nooble_)

- [@tapeanimation](https://www.fiverr.com/tapeanimation)

- [@lunatel](https://www.fiverr.com/lunatel)

- [@chaoxel](https://github.com/chaoxel)

## License

Licensed under AGPL (Affero General Public License).  

All assets and resources are copyrighted and reserved by their respective creators.