From 8dc7ba0a44df54b23a84ea5035a512daa768d7a9 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 13 Jun 2025 06:55:23 +0000 Subject: [PATCH] Update README.md --- README.en.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 146 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..e9d36c1 --- /dev/null +++ b/README.en.md @@ -0,0 +1,73 @@ +# Xiuxian Simulator + +## Introduction +This is a text-based cultivation-themed role-playing game simulator integrating AI-generated storylines, character development, and combat strategy mechanics. Players assume the role of a cultivator exploring secret realms, breaking through cultivation realms, refining techniques, and experiencing unique cultivation journeys through AI-generated narrative events. + +## Core Features +- 🧘 **Multi-dimensional Cultivation System**: Includes meditation, alchemy, combat, and secret realm exploration +- 🤖 **AI Story Engine**: Dynamically generates exploration events, combat scenarios, and cultivation guidance via AI API +- 🌍 **Open World Mechanism**: Randomly generates cultivation world maps and event nodes +- 📈 **Character Progression System**: Features innate spiritual roots, realm breakthroughs, and technique acquisition +- 💾 **Save System**: Supports game progress saving and loading + +## Directory Structure +``` +game/ # Core modules +├── ai_interface.py # AI storyline generation interface +├── player.py # Player character logic +├── world.py # World generation & event management +├── utils.py # Utility function library +main.py # Game entry point +config.json # Configuration file (contains AI API parameters) +requirements.txt # Dependency list +run.sh # Launch script +``` + +## Installation Guide +1. Install Python 3.13+ +2. Install dependencies: + ```bash + pip install -r requirements.txt + ``` +3. Configure AI service: + ```json + # config.json + { + "api_key": "your_api_key", + "api_url": "https://api.example.com/ai", + "model": "gpt-4" + } + ``` + +## Quick Start +```bash +# Launch game +python start.py +# Or use launch script +./run.sh +``` + +## Core Gameplay +1. **Character Creation**: Customize cultivation title and spiritual root attributes (affects cultivation efficiency) +2. **Realm Breakthrough**: Accumulate spiritual energy through meditation to advance from Qi Condensation → Foundation Building → Golden Core stages +3. **Secret Realm Exploration**: Encounter AI-generated random events (fortuitous encounters/combat/treasure acquisition) +4. **Combat System**: Strategic choices between attack/defense/item usage +5. **Alchemy Practice**: Synthesize pills to enhance attributes and learn cultivation techniques + +## Developer Guide +- Expand plot types: Inherit `AIInterface` class and implement new scenario generation methods +- Add cultivation elements: Modify attribute calculation logic in `Player` class +- Customize world rules: Adjust map generation algorithm in `GameWorld` + +## Contribution +Welcome PR submissions to improve: +- New cultivation features (e.g., artifact system) +- AI prompt engineering optimization +- Multi-language localization support + +## License +MIT License - See LICENSE file + +--- + +Combine AI-driven dynamic storylines with traditional cultivation elements to forge your unique cultivation path! 🚀 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..43e393a --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# 修仙模拟器 (Xiuxian Simulator) + +## 简介 +这是一个基于文本的修仙题材角色扮演游戏模拟器,融合了AI生成剧情、角色养成、战斗策略等核心玩法。玩家将扮演修仙者,在随机生成的世界中探索秘境、突破境界、修炼功法,并通过AI生成的剧情事件体验独特的修仙之旅。 + +## 核心功能 +- 🧘 **多维修炼系统**:包含打坐、炼丹、战斗、秘境探索等多种修炼方式 +- 🤖 **AI剧情引擎**:通过AI接口动态生成探索事件、战斗场景和修炼指导 +- 🌍 **开放世界机制**:随机生成修仙世界地图与事件节点 +- 📈 **角色成长体系**:包含灵根属性、境界突破、功法学习等修仙特色要素 +- 💾 **存档系统**:支持游戏进度保存与读取 + +## 目录结构 +``` +game/ # 核心模块 +├── ai_interface.py # AI剧情生成接口 +├── player.py # 玩家角色逻辑 +├── world.py # 世界生成与事件管理 +├── utils.py # 工具函数库 +main.py # 游戏主程序入口 +config.json # 配置文件(含AI API参数) +requirements.txt # 依赖列表 +run.sh # 启动脚本 +``` + +## 安装指南 +1. 安装Python 3.13+环境 +2. 安装依赖: + ```bash + pip install -r requirements.txt + ``` +3. 配置AI服务: + ```json + # config.json + { + "api_key": "your_api_key", + "api_url": "https://api.example.com/ai", + "model": "gpt-4" + } + ``` + +## 快速开始 +```bash +# 启动游戏 +python start.py +# 或使用启动脚本 +./run.sh +``` + +## 核心玩法 +1. **角色创建**:自定义道号与灵根属性(影响修炼效率) +2. **境界突破**:通过打坐积累灵气,冲击炼气→筑基→金丹等境界 +3. **秘境探索**:遭遇AI生成的随机事件(奇遇/战斗/宝物获取) +4. **战斗系统**:策略选择攻击/防御/使用道具等行动 +5. **炼丹修炼**:合成丹药提升属性,学习各类修仙功法 + +## 开发者指南 +- 扩展剧情类型:继承`AIInterface`类并实现新的场景生成方法 +- 添加修炼要素:修改`Player`类中的属性计算逻辑 +- 自定义世界规则:调整`GameWorld`的地图生成算法 + +## 贡献代码 +欢迎提交PR完善以下方向: +- 新增修仙特色系统(如法宝系统) +- 优化AI提示词工程 +- 本地化多语言支持 + +## 许可证 +本项目采用MIT License,详情见LICENSE文件 + +--- + +通过AI驱动的动态剧情与传统修仙元素的结合,打造属于你的独特修仙之路!🚀 \ No newline at end of file -- Gitee