Update README with project intro, story synopsis and document links
- Add Chinese and English sections - Add project overview with key features - Add story synopsis - Add document links to GDD-v2.md and Script.md - Add quick start guide
This commit is contained in:
parent
546ee87dc7
commit
12abb37362
173
README.md
173
README.md
@ -1,49 +1,150 @@
|
|||||||
# Shadow Bamboo (竹影)
|
# Shadow Bamboo (竹影)
|
||||||
|
|
||||||
A Godot 4.6 action RPG set in a mystical bamboo forest world.
|
<div align="center">
|
||||||
|
|
||||||
## Project Structure
|
**一款以竹林江湖为背景的动作 RPG 游戏**
|
||||||
|
|
||||||
|
[English](#english) | [中文](#中文)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 中文
|
||||||
|
|
||||||
|
### 🎮 项目简介
|
||||||
|
|
||||||
|
《竹影》是一款基于 Godot 4.6 引擎开发的动作角色扮演游戏。游戏以神秘的竹林江湖为背景，融合了东方武侠元素与奇幻色彩。
|
||||||
|
|
||||||
|
**核心特色：**
|
||||||
|
- 🗡️ **竹之力系统**：操控不同类型的竹子获得独特能力
|
||||||
|
- 👥 **伙伴系统**：招募各具特色的战斗伙伴
|
||||||
|
- 🔀 **分支剧情**：玩家选择影响故事走向和结局
|
||||||
|
- ⚔️ **装备锻造**：用神秘竹材打造独特武器
|
||||||
|
|
||||||
|
**技术信息：**
|
||||||
|
- 引擎：Godot 4.6
|
||||||
|
- 渲染器：Forward Plus
|
||||||
|
- 物理引擎：Jolt Physics
|
||||||
|
- 目标平台：Windows / Linux / macOS
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 📖 故事简介
|
||||||
|
|
||||||
|
在一个竹子蕴含神秘力量的世界里，年轻的武者发现自己的灵魂与古老的竹灵相连。
|
||||||
|
|
||||||
|
一场名为「枯竹之祸」的灾难正在蔓延——竹林枯萎，黑暗势力蠢蠢欲动。为了追寻真相，你将踏上穿越云雾山岭、繁华水乡、帮派都市和灼热沙漠的旅程。
|
||||||
|
|
||||||
|
**旅程中，你将：**
|
||||||
|
- 继承师父留下的「天竹残片」
|
||||||
|
- 与法师苍耳、刺客青绾结伴同行
|
||||||
|
- 揭开七大封印者的秘密
|
||||||
|
- 面对 6 种截然不同的命运结局
|
||||||
|
|
||||||
|
**你的选择，决定竹洲的未来。**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 📁 项目结构
|
||||||
|
|
||||||
```
|
```
|
||||||
Shadow-Bamboo/
|
Shadow-Bamboo/
|
||||||
├── project.godot # Godot project file
|
├── project.godot # Godot 项目文件
|
||||||
├── icon.svg # Project icon
|
├── icon.svg # 项目图标
|
||||||
├── Resources/ # Game assets
|
├── Resources/ # 游戏资源
|
||||||
│ ├── Sprites/ # Character sprites
|
│ ├── Sprites/ # 精灵图
|
||||||
│ ├── Textures/ # Environment textures
|
│ ├── Textures/ # 纹理材质
|
||||||
│ ├── Audio/ # Sound assets
|
│ ├── Audio/ # 音频文件
|
||||||
│ │ ├── Music/ # BGM tracks
|
│ ├── Fonts/ # 字体
|
||||||
│ │ └── SFX/ # Sound effects
|
│ ├── Animations/ # 动画
|
||||||
│ ├── Fonts/ # Typography
|
│ ├── Shaders/ # 着色器
|
||||||
│ ├── Animations/ # Animation files
|
│ ├── Tilesets/ # 瓦片地图
|
||||||
│ ├── Shaders/ # Custom shaders
|
│ └── UI/ # 界面资源
|
||||||
│ ├── Tilesets/ # Map tilesets
|
├── Scenes/ # Godot 场景文件
|
||||||
│ └── UI/ # Interface assets
|
├── Scripts/ # GDScript 脚本
|
||||||
├── Scenes/ # Godot scene files (.tscn)
|
├── Documents/ # 设计文档
|
||||||
├── Scripts/ # GDScript files (.gd)
|
└── Exports/ # 构建导出
|
||||||
├── Documents/ # Design documentation
|
|
||||||
│ ├── GDD.md # Game Design Document
|
|
||||||
│ └── Story.md # Story script
|
|
||||||
└── Exports/ # Build exports
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Engine Info
|
---
|
||||||
|
|
||||||
- **Engine**: Godot 4.6
|
### 📚 设计文档
|
||||||
- **Renderer**: Forward Plus
|
|
||||||
- **Physics**: Jolt Physics
|
|
||||||
- **Platform**: Windows (Primary)
|
|
||||||
|
|
||||||
## Quick Start
|
| 文档 | 说明 |
|
||||||
|
|------|------|
|
||||||
1. Open `project.godot` in Godot 4.6+
|
| [📖 GDD-v2.md](Documents/GDD-v2.md) | 完整游戏设计文档 v2.0（含竹龙会城章节） |
|
||||||
2. The project is ready to edit
|
| [🎭 Script.md](Documents/Script.md) | 完整分支剧情剧本（6种结局） |
|
||||||
3. Use Godot's built-in Git tools for version control
|
| [📂 Documents/](Documents/) | 文档目录（含详细说明） |
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
- Repository: http://git.skwcf.top/root/Shadow-Bamboo
|
|
||||||
- Game Website: http://skwcf.top/
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### 🚀 快速开始
|
||||||
|
|
||||||
|
1. 安装 [Godot 4.6+](https://godotengine.org/download)
|
||||||
|
2. 克隆仓库：
|
||||||
|
```bash
|
||||||
|
git clone http://git.skwcf.top/root/Shadow-Bamboo.git
|
||||||
|
```
|
||||||
|
3. 用 Godot 打开 `project.godot`
|
||||||
|
4. 开始开发！
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🔗 相关链接
|
||||||
|
|
||||||
|
- 🌐 游戏网站：http://skwcf.top/
|
||||||
|
- 📦 代码仓库：http://git.skwcf.top/root/Shadow-Bamboo
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## English
|
||||||
|
|
||||||
|
### 🎮 Project Overview
|
||||||
|
|
||||||
|
Shadow Bamboo is an action RPG built with Godot 4.6, set in a mystical bamboo forest world blending Eastern martial arts with fantasy elements.
|
||||||
|
|
||||||
|
**Key Features:**
|
||||||
|
- 🗡️ **Bamboo Power System**: Harness different bamboo types for unique abilities
|
||||||
|
- 👥 **Companion System**: Recruit allies with distinct combat styles
|
||||||
|
- 🔀 **Branching Narrative**: Player choices affect story outcomes
|
||||||
|
- ⚔️ **Equipment Crafting**: Forge weapons from mystical bamboo
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 📖 Story Synopsis
|
||||||
|
|
||||||
|
In a world where bamboo holds mystical powers, a young warrior discovers their connection to an ancient bamboo spirit. A plague called "The Withering" spreads across the land, and dark forces stir in the shadows.
|
||||||
|
|
||||||
|
Journey through misty mountains, bustling river towns, gang-controlled cities, and scorching deserts to uncover the truth behind the withering bamboo and face your destiny.
|
||||||
|
|
||||||
|
**Your choices shape the fate of the Bamboo Realm.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
|
||||||
|
| Document | Description |
|
||||||
|
|----------|-------------|
|
||||||
|
| [📖 GDD-v2.md](Documents/GDD-v2.md) | Game Design Document v2.0 |
|
||||||
|
| [🎭 Script.md](Documents/Script.md) | Branching Story Script (6 endings) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🚀 Quick Start
|
||||||
|
|
||||||
|
1. Install [Godot 4.6+](https://godotengine.org/download)
|
||||||
|
2. Clone the repository:
|
||||||
|
```bash
|
||||||
|
git clone http://git.skwcf.top/root/Shadow-Bamboo.git
|
||||||
|
```
|
||||||
|
3. Open `project.godot` in Godot
|
||||||
|
4. Start developing!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
*Shadow Bamboo Team*
|
*Shadow Bamboo Team*
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user