forked from datawhale/whale-town-front
docs：添加完整的项目文档体系
- 添加Web部署完整指南和更新日志 - 创建网络管理器配置文档 - 完善项目设置和测试指南 - 添加API更新日志和清理总结 - 更新脚本使用说明文档
This commit is contained in:
164
scripts/README.md
Normal file
164
scripts/README.md
Normal file
@@ -0,0 +1,164 @@
|
||||
# 鲸鱼镇 Web导出脚本
|
||||
|
||||
这个目录包含了将鲸鱼镇项目导出为Web版本的完整脚本集合。
|
||||
|
||||
## 📁 文件说明
|
||||
|
||||
### Windows脚本
|
||||
- `build_web.bat` - Web版本导出脚本
|
||||
- `serve_web.bat` - 本地测试服务器脚本
|
||||
|
||||
### Linux/macOS脚本
|
||||
- `build_web.sh` - Web版本导出脚本
|
||||
- `serve_web.sh` - 本地测试服务器脚本
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### Windows用户
|
||||
|
||||
1. **导出Web版本**
|
||||
```cmd
|
||||
scripts\build_web.bat
|
||||
```
|
||||
|
||||
2. **启动本地测试服务器**
|
||||
```cmd
|
||||
scripts\serve_web.bat
|
||||
```
|
||||
|
||||
### Linux/macOS用户
|
||||
|
||||
1. **添加执行权限**（首次使用）
|
||||
```bash
|
||||
chmod +x scripts/build_web.sh scripts/serve_web.sh
|
||||
```
|
||||
|
||||
2. **导出Web版本**
|
||||
```bash
|
||||
./scripts/build_web.sh
|
||||
```
|
||||
|
||||
3. **启动本地测试服务器**
|
||||
```bash
|
||||
./scripts/serve_web.sh
|
||||
```
|
||||
|
||||
## ⚙️ 配置要求
|
||||
|
||||
### 系统要求
|
||||
- **Godot Engine**: 4.5+
|
||||
- **Python**: 3.6+（用于本地测试服务器）
|
||||
- **磁盘空间**: 至少100MB
|
||||
|
||||
### Godot配置
|
||||
在使用脚本前，请确保：
|
||||
1. 已安装Godot 4.5或更高版本
|
||||
2. 已下载Web导出模板
|
||||
3. 已创建名为"Web"的导出预设
|
||||
|
||||
## 🔧 脚本配置
|
||||
|
||||
### 修改Godot路径
|
||||
如果Godot安装在非默认位置，请修改脚本中的路径：
|
||||
|
||||
**Windows** (`build_web.bat`):
|
||||
```batch
|
||||
set "GODOT_PATH=C:\Program Files\Godot\Godot.exe"
|
||||
```
|
||||
|
||||
**Linux/macOS** (`build_web.sh`):
|
||||
```bash
|
||||
GODOT_PATH="/usr/local/bin/godot"
|
||||
```
|
||||
|
||||
### 修改端口设置
|
||||
默认使用端口8000，如需修改请编辑服务器脚本：
|
||||
|
||||
**Windows** (`serve_web.bat`):
|
||||
```batch
|
||||
set "PORT=8000"
|
||||
```
|
||||
|
||||
**Linux/macOS** (`serve_web.sh`):
|
||||
```bash
|
||||
PORT=8000
|
||||
```
|
||||
|
||||
## 📋 使用流程
|
||||
|
||||
1. **准备阶段**
|
||||
- 确保Godot已正确安装
|
||||
- 在Godot编辑器中创建Web导出预设
|
||||
- 下载对应版本的导出模板
|
||||
|
||||
2. **导出阶段**
|
||||
- 运行导出脚本
|
||||
- 等待导出完成
|
||||
- 检查生成的文件
|
||||
|
||||
3. **测试阶段**
|
||||
- 运行本地服务器脚本
|
||||
- 在浏览器中测试功能
|
||||
- 检查控制台错误
|
||||
|
||||
4. **部署阶段**
|
||||
- 将`build/web/`目录上传到服务器
|
||||
- 配置服务器MIME类型和CORS
|
||||
- 测试线上版本
|
||||
|
||||
## 🐛 常见问题
|
||||
|
||||
### Godot未找到
|
||||
**错误**: `未找到Godot可执行文件`
|
||||
**解决**: 修改脚本中的`GODOT_PATH`变量为正确路径
|
||||
|
||||
### 导出预设不存在
|
||||
**错误**: `导出预设 "Web" 不存在`
|
||||
**解决**: 在Godot编辑器中创建Web导出预设
|
||||
|
||||
### Python未安装
|
||||
**错误**: `未找到Python`
|
||||
**解决**: 安装Python 3.6+并确保添加到PATH
|
||||
|
||||
### 端口被占用
|
||||
**错误**: `端口 8000 已被占用`
|
||||
**解决**: 脚本会自动尝试8080端口，或手动修改端口设置
|
||||
|
||||
### 文件缺失
|
||||
**错误**: `缺少必要文件`
|
||||
**解决**: 重新运行导出脚本，检查Godot配置
|
||||
|
||||
## 📊 输出文件
|
||||
|
||||
导出成功后，`build/web/`目录将包含：
|
||||
|
||||
```
|
||||
build/web/
|
||||
├── index.html # 主HTML文件
|
||||
├── index.js # JavaScript引导文件
|
||||
├── index.wasm # WebAssembly主文件
|
||||
├── index.pck # Godot资源包
|
||||
├── index.worker.js # Web Worker文件
|
||||
├── .htaccess # Apache配置文件
|
||||
├── deploy_info.json # 部署信息
|
||||
└── server.log # 服务器日志（测试时生成）
|
||||
```
|
||||
|
||||
## 🔗 相关文档
|
||||
|
||||
- [完整部署指南](../docs/web_deployment_guide.md)
|
||||
- [更新日志](../docs/web_deployment_changelog.md)
|
||||
- [API文档](../docs/api-documentation.md)
|
||||
|
||||
## 💡 提示
|
||||
|
||||
1. **首次导出**可能需要较长时间下载模板
|
||||
2. **文件较大**时建议启用服务器压缩
|
||||
3. **移动端测试**请使用真机而非模拟器
|
||||
4. **网络问题**可能影响API调用，注意CORS配置
|
||||
|
||||
---
|
||||
|
||||
**维护**: 鲸鱼镇开发团队
|
||||
**版本**: 1.0.0
|
||||
**更新**: 2025-12-25
|
||||
Reference in New Issue
Block a user