ShadowEditor 项目教程

1. 项目的目录结构及介绍

ShadowEditor 是一个跨平台的 3D 场景编辑器，基于 three.js、golang 和 mongodb。项目的目录结构如下：

ShadowEditor/
├── docs/               # 文档目录
│   ├── images/         # 文档中的图片
│   └── ...
├── scripts/            # 脚本目录
│   └── ...
├── server/             # 服务器端代码
│   ├── utils/          # 服务器端工具
│   └── ...
├── web/                # 前端代码
│   ├── assets/         # 前端资源
│   ├── components/     # 前端组件
│   └── ...
├── .gitattributes      # Git 属性配置
├── .gitignore          # Git 忽略文件配置
├── LICENSE             # 项目许可证
├── README.md           # 项目介绍
├── README_new.md       # 新版项目介绍
├── README_zh.md        # 中文项目介绍
├── package-lock.json   # npm 锁定文件
├── package.json        # npm 配置文件
└── ...

主要目录介绍

• docs/: 包含项目的文档，如 README 文件和相关图片。
• scripts/: 包含项目的脚本文件，用于自动化任务等。
• server/: 包含服务器端代码，主要使用 golang 编写。
• web/: 包含前端代码，主要使用 three.js 和相关前端技术。

2. 项目的启动文件介绍

ShadowEditor 的启动文件主要位于 server/ 目录下。以下是主要的启动文件：

• server/start.bat: Windows 系统下的启动脚本。
• server/start.sh: Linux 系统下的启动脚本。

启动步骤

1. Windows:

   • 打开命令行工具，导航到 server/ 目录。
   • 运行 start.bat 脚本：

     start.bat
     

2. Linux:

   • 打开终端，导航到 server/ 目录。
   • 运行 start.sh 脚本：

     ./start.sh
     

启动后，访问 http://localhost:2020 即可进入 ShadowEditor 的 Web 界面。

3. 项目的配置文件介绍

ShadowEditor 的配置文件主要位于 build/ 目录下，主要的配置文件是 config.toml。

config.toml 配置文件

# MongoDB 配置
[mongodb]
host = "localhost"
port = 27017

# 其他配置项
[server]
port = 2020
enable_https = false

配置项说明

• mongodb.host: MongoDB 数据库的主机地址，默认为 localhost。
• mongodb.port: MongoDB 数据库的端口号，默认为 27017。
• server.port: 服务器监听的端口号，默认为 2020。
• server.enable_https: 是否启用 HTTPS，默认为 false。

通过修改 config.toml 文件，可以自定义 ShadowEditor 的运行配置。

---

以上是 ShadowEditor 项目的目录结构、启动文件和配置文件的介绍。希望这篇教程能帮助你更好地理解和使用 ShadowEditor 项目。