Thing-Editor 项目安装与使用指南
thing-editorpixi.js based visual game editor项目地址:https://gitcode.com/gh_mirrors/th/thing-editor
1. 项目目录结构及介绍
thing-editor/
├── .eslintrc.json
├── .gitignore
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── run-ubuntu.sh
├── run-win10.bat
├── thing-editor.code-workspace
├── tsconfig.json
├── vite.config.js
└── src/
├── electron-main.js
├── main.ts
├── renderer.ts
└── ...
目录结构说明
- .eslintrc.json: ESLint 配置文件,用于代码风格检查。
- .gitignore: Git 忽略文件配置,指定哪些文件或目录不需要被 Git 管理。
- LICENSE: 项目许可证文件。
- README.md: 项目说明文件,包含项目的基本信息和使用指南。
- package-lock.json: 锁定项目依赖包的版本。
- package.json: 项目配置文件,包含项目的依赖、脚本等信息。
- run-ubuntu.sh: 用于在 Ubuntu 系统上启动项目的脚本。
- run-win10.bat: 用于在 Windows 10 系统上启动项目的批处理文件。
- thing-editor.code-workspace: VSCode 工作区配置文件。
- tsconfig.json: TypeScript 配置文件,用于编译 TypeScript 代码。
- vite.config.js: Vite 配置文件,用于配置前端构建工具 Vite。
- src/: 项目源代码目录,包含主要的业务逻辑代码。
2. 项目启动文件介绍
启动方式一:使用 VSCode 调试配置
- 打开
thing-editor.code-workspace
作为工作区。 - 接受所有推荐的任务和扩展。
- 启动
[Editor]
调试配置。 - 编辑器将以 Electron 应用程序的形式启动,并附加 VSCode 调试器。
启动方式二:使用脚本文件
- Windows: 运行
run-win10.bat
文件。 - Linux 或 Mac: 运行
run-ubuntu.sh
文件。
启动方式三:使用终端命令
在 thing-editor
目录下,运行以下命令:
npx vite & npx electron "./thing-editor/electron-main"
3. 项目配置文件介绍
package.json
package.json
是项目的核心配置文件,包含以下主要内容:
- name: 项目名称。
- version: 项目版本。
- scripts: 定义了项目的启动、构建等脚本命令。
- dependencies: 项目依赖的第三方库。
- devDependencies: 开发环境依赖的第三方库。
tsconfig.json
tsconfig.json
是 TypeScript 的配置文件,用于配置 TypeScript 编译器的行为,包含以下主要内容:
- compilerOptions: 编译选项,如目标版本、模块系统、输出目录等。
- include: 指定需要编译的文件或目录。
- exclude: 指定不需要编译的文件或目录。
vite.config.js
vite.config.js
是 Vite 的配置文件,用于配置前端构建工具 Vite,包含以下主要内容:
- server: 配置开发服务器选项,如端口、代理等。
- build: 配置构建选项,如输出目录、文件名等。
- plugins: 配置使用的 Vite 插件。
通过以上配置文件和启动方式,您可以顺利地安装和使用 Thing-Editor 项目。
thing-editorpixi.js based visual game editor项目地址:https://gitcode.com/gh_mirrors/th/thing-editor