OpenTGX 项目使用教程

OpenTGX 项目使用教程

OpenTGX A game development solution using typescript, can make 2d&3d games for all platforms easily. Based on Cocos Creator( support WebGL|WebGPU|Metal|Vulkan|OpenGLES ), can work with all server side solutions(such as Go, NodeJS, Java, C#, etc). 项目地址: https://gitcode.com/gh_mirrors/ope/OpenTGX

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

OpenTGX 是一个基于 TypeScript 的游戏开发解决方案，它允许开发者轻松创建 2D 和 3D 游戏，并支持所有平台。以下是 OpenTGX 项目的目录结构及其简要介绍：

OpenTGX/
├── docs/              # 项目文档
├── screenshots/       # 项目截图
├── tgx-core-cocos/     # 核心Cocos组件
├── tgx-metaverse-online/ # 虚拟世界在线组件
├── .gitignore         # Git忽略文件
├── LICENSE            # 项目许可证
├── README-CN.md       # 项目中文介绍
├── README.md          # 项目英文介绍
├── image.png          # 项目图片
└── open-tgx-logo-txt.png # 项目Logo文本图片

• docs/: 存放项目的文档资料。
• screenshots/: 存放项目的屏幕截图。
• tgx-core-cocos/: 包含基于 Cocos Creator 的核心组件。
• tgx-metaverse-online/: 包含虚拟世界在线相关的组件。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的 MIT 许可证。
• README-CN.md 和 README.md: 分别是项目的中文和英文介绍。
• image.png 和 open-tgx-logo-txt.png: 项目的图片和Logo文本图片。

2. 项目的启动文件介绍

OpenTGX 项目的启动通常依赖于 Cocos Creator 的环境。主要的启动文件是位于 tgx-core-cocos/ 目录下的入口脚本，通常名为 main.ts 或 app.ts。

// main.ts 或 app.ts 的示例内容
import { QMainWindow } from 'tgx-core-cocos';

// 创建并显示主窗口
const mainWindow = new QMainWindow();
mainWindow.show();

在 Cocos Creator 中，您需要确保已经正确配置了项目，并且在编辑器中设置了启动场景和相应的入口脚本。

3. 项目的配置文件介绍

OpenTGX 项目的配置文件通常包括但不限于以下几种：

• cocos2d.js: Cocos Creator 的核心 JavaScript 文件，包含了游戏引擎的核心功能。
• game.json: 游戏配置文件，用于定义游戏的全局设置，如设计分辨率、资源加载等信息。
• project.json: 项目配置文件，包含项目的基本信息，如项目名、版本号等。

以下是 game.json 的一个示例：

{
    "deviceOrientation": "portrait",
    "showFPS": true,
    "frameRate": 60,
    "debugMode": 0,
    "designWidth": 480,
    "designHeight": 320,
    "startScene": "MainScene"
}

在这个配置文件中：

• deviceOrientation: 设备方向，可以是 portrait（纵向）或 landscape（横向）。
• showFPS: 是否显示帧率。
• frameRate: 设置游戏运行的帧率。
• debugMode: 调试模式，0 为关闭，1 为开启。
• designWidth 和 designHeight: 设计分辨率。
• startScene: 启动场景的名称。

通过编辑这些配置文件，开发者可以调整游戏的行为和外观，以适应不同的需求和平台。

OpenTGX A game development solution using typescript, can make 2d&3d games for all platforms easily. Based on Cocos Creator( support WebGL|WebGPU|Metal|Vulkan|OpenGLES ), can work with all server side solutions(such as Go, NodeJS, Java, C#, etc). 项目地址: https://gitcode.com/gh_mirrors/ope/OpenTGX