# RenPyUtil

**Repository Path**: ZYKsslm/RenPyUtil

## Basic Information

- **Project Name**: RenPyUtil
- **Description**: 一个Ren'Py工具包，提供了一系列基于Ren'Py的功能类，以供Ren'Py开发者调用。代码持续更新中。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-26
- **Last Updated**: 2025-02-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: renpy, Python, Package

## README

# RenPyUtil

<p align="center">
  <img src="https://www.renpy.org/static/index-logo.png" alt="Ren'Py logo">
</p>

> 一个Ren'Py工具包，提供了一系列基于Ren'Py的功能类，供Ren'Py开发者调用。

本项目内置文档，符合PEP257规范。

## :cd: 如何使用

1. 将所需的[第三方库](./lib)放置于您的游戏 `game` 目录下。
2. 将[RenPyUtil](./RenPyUtil) 目录放置于您的游戏 `game` 目录下。

## :rocket: 功能概览

- [x] 高级角色类，轻松创建RPG和养成类游戏，具备丰富功能。
- [x] 基于socket的TCP协议多线程网络通信模块，让多个玩家可以在网络中交流。
- [x] ChatGPT接口适配，便于集成智能对话功能。
- [x] Positioner定位工具，更加便捷地定位游戏内的组件位置。
- [x] InteractiveLive2D类，对 `Live2D` 提供更高级的支持。

---

## :bookmark: 使用示范

每个模块都有相应的使用示范，请在 [Demo](./Demo) 中查看。

1. **`advanced_character`**
    - [角色任务示例](./Demo/demo_advanced_character/character_task.rpy)
    - [对话组示例](./Demo/demo_advanced_character/speaking_group.rpy)
2. **`ren_communicator`**
    - [客户端通信示例](./Demo/demo_ren_communicator/client.rpy)
    - [服务端通信示例](./Demo/demo_ren_communicator/server.rpy)
3. **`ren_chatgpt`**
    - [与ChatGPT对话示例](./Demo/demo_ren_chatgpt.rpy)
4. **`InteractiveLive2D`**
    - [Live2D示例](./Demo/demo_InteractiveLive2D.rpy)

## :bar_chart: 已实现模块列表

1. [`advanced_character`](./RenPyUtil/advanced_character_ren.py)
2. [`ren_communicator`](./RenPyUtil/RenCommunicator/)
3. [`ren_chatgpt`](./RenPyUtil/ren_chatgpt_ren.py)
4. [`InteractiveLive2D`](./RenPyUtil/00InteractiveLive2D_ren.py/)

## :bulb: 工具
1. [`Positioner`](./RenPyUtil/Positioner)

## :book: 说明

**`resource_preserver`模块已暂时移除。**

该项目使用MIT协议开源，使用时请在程序中注明。