en_README.md

AITuberKit Server Side

Japanese version

Note

• There are currently no plans for future maintenance.
• All library versions, including OpenInterpreter, are fixed (the latest as of 20/08/24 is 0.3.7)

Relation

• Front-side repository -> tegnike/aituber-kit
• Explanatory article -> Let's develop with a beautiful girl!! [Open Interpreter]

Features

1. You can receive messages via WebSocket and obtain responses from the Open Interpreter (supports stream mode).
2. You can send files to be saved on the server side. You can also issue commands to the Open Interpreter for these files.

Prerequisites

1. This repository assumes operation via WebSocket, so please prepare a connection destination suitable for your environment.
2. The default connection URL is ws://127.0.0.1:8000/ws.

Execution Steps

1. Set the OPENAI_API_KEY in .env.
2. Execute docker-compose up -d --build.

Debugging

1. When using VSCode as the execution environment, launch in debug mode with DEBUG_MODE=1.
2. Set breakpoints and enjoy comfortable debugging.

Reference: VS Code Editor Introduction

Code Explanation

It's lengthy, so I've detailed it in the link below:

• Code Explanation: Simple Version of Beautiful Girl OPInterpreter

Miscellaneous

1. The license conforms to KillianLucas/open-interpreter.
2. Instructions on using the Open Interpreter are consolidated in the link below:

• For Developers: Explaining How to Use Open Interpreter with Code (Python Edition)