OpenGlobus 项目教程

1. 项目目录结构及介绍

OpenGlobus 是一个用于显示交互式 3D 地图和地理空间数据的 TypeScript/JavaScript 库。以下是项目的目录结构及其介绍：

openglobus/
├── bmfont/
├── css/
├── res/
├── sandbox/
├── src/
├── tests/
├── .editorconfig
├── .gitignore
├── .npmignore
├── .prettierrc.js
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── README_CN.md
├── README_pt-BR.md
├── babel.config.js
├── blender.py
├── eslint.config.mjs
├── jest.config.js
├── jsdoc.conf.json
├── package-lock.json
├── package.json
├── planet.og.drawio.svg
├── renderer.og.drawio.svg
├── rollup.config.js
├── shaders.og.drawio.svg
├── simple.og.drawio.svg
├── tsconfig.json

目录介绍

• bmfont/: 包含与字体相关的文件。
• css/: 包含项目的样式文件。
• res/: 包含项目的资源文件。
• sandbox/: 包含项目的示例和测试文件。
• src/: 包含项目的主要源代码。
• tests/: 包含项目的测试代码。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .prettierrc.js: Prettier 代码格式化配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 项目许可证。
• README.md: 项目介绍和使用说明。
• README_CN.md: 中文项目介绍和使用说明。
• README_pt-BR.md: 葡萄牙语项目介绍和使用说明。
• babel.config.js: Babel 配置文件。
• blender.py: Blender 相关脚本。
• eslint.config.mjs: ESLint 配置文件。
• jest.config.js: Jest 测试配置文件。
• jsdoc.conf.json: JSDoc 文档生成配置。
• package-lock.json: npm 锁定文件。
• package.json: npm 项目配置文件。
• planet.og.drawio.svg: 项目相关图表。
• renderer.og.drawio.svg: 渲染器相关图表。
• rollup.config.js: Rollup 打包配置文件。
• shaders.og.drawio.svg: 着色器相关图表。
• simple.og.drawio.svg: 简单示例相关图表。
• tsconfig.json: TypeScript 配置文件。

2. 项目启动文件介绍

OpenGlobus 项目的启动文件主要集中在 src/ 目录下。以下是一些关键的启动文件：

• src/index.ts: 项目的入口文件，负责初始化 OpenGlobus 的核心功能。
• src/main.ts: 主逻辑文件，负责处理地图的加载和渲染。
• src/config.ts: 配置文件，包含项目的默认配置选项。

3. 项目配置文件介绍

OpenGlobus 项目的配置文件主要包括以下几个：

• package.json: 包含了项目的依赖、脚本命令、版本信息等。
• tsconfig.json: TypeScript 编译配置文件，定义了 TypeScript 编译器的选项。
• rollup.config.js: Rollup 打包配置文件，定义了如何将 TypeScript 代码打包成 JavaScript 文件。
• babel.config.js: Babel 配置文件，用于将 ES6+ 代码转换为兼容性更好的 JavaScript 代码。
• eslint.config.mjs: ESLint 配置文件，用于代码风格检查和错误检测。
• jest.config.js: Jest 测试配置文件，定义了测试框架的选项。

这些配置文件共同作用，确保项目能够正确编译、打包、测试和运行。