Jahshaka Studio 开发者指南

1. 项目目录结构及介绍

Jahshaka Studio 是一个开源的虚拟现实内容创作工具，它的目录结构如下：

Jahshaka Studio/
├── app/                   # 应用程序核心代码
├── build/                 # 构建相关文件
├── cmake/                 # CMake 构建配置文件
├── extras/                # 额外工具和资源
├── irisgl/                # IrisGL 渲染引擎相关代码
├── scenes/                # 场景和示例
├── src/                   # 源代码目录
├── thirdparty/            # 第三方库和依赖
├── .gitignore             # Git 忽略文件
├── .gitmodules            # Git 子模块配置
├── CMakeLists.txt         # CMake 主配置文件
├── LICENSE                # 项目许可证信息
└── README.md              # 项目介绍和说明

• app/: 包含应用程序的主要逻辑和界面代码。
• build/: 构建过程中生成的中间文件和最终的可执行文件。
• cmake/: 存放与CMake相关的配置文件，用于构建项目。
• extras/: 提供了一些额外的工具和资源，可能用于开发或调试。
• irisgl/: IrisGL 是一个开源的渲染引擎，Jahshaka Studio 使用它来进行图形渲染。
• scenes/: 存放一些示例场景和项目。
• src/: 源代码目录，包含了所有自定义的类和函数。
• thirdparty/: 存放第三方库和依赖的源代码。
• .gitignore: 指示Git哪些文件和目录应该被忽略。
• .gitmodules: 配置Git子模块的相关信息。
• CMakeLists.txt: 这是CMake的主配置文件，定义了如何构建项目。
• LICENSE: 项目的许可证文件，通常是GPL-3.0。
• README.md: 包含项目的描述、用法和安装说明。

2. 项目的启动文件介绍

在 Jahshaka Studio 中，启动文件通常是 app/ 目录下的主程序文件。具体文件名可能会根据项目而有所不同，但通常会有一个名为 main.cpp 或类似的文件。这个文件包含了程序的入口点，通常看起来像这样：

#include <irisgl/irisgl.h>

int main(int argc, char** argv)
{
    // 初始化 IrisGL
    IrisApplication app(argc, argv);
    app.init();

    // 运行应用程序主循环
    app.run();

    // 清理资源
    app.shutdown();

    return 0;
}

这个文件会初始化IrisGL引擎，启动应用程序的主循环，并在退出前清理资源。

3. 项目的配置文件介绍

Jahshaka Studio 使用 CMake 作为构建系统，因此主要的配置文件是 CMakeLists.txt。这个文件定义了如何找到依赖项，如何编译源代码，以及如何生成可执行文件。

以下是一些 CMakeLists.txt 文件中的关键部分：

cmake_minimum_required(VERSION 3.10)
project(Jahshaka_Studio)

# 设置C++标准
set(CMAKE_CXX_STANDARD 11)

# 寻找Qt库
find_package(Qt5 COMPONENTS Widgets REQUIRED)

# 添加子目录
add_subdirectory(thirdparty/irisgl)

# 定义源文件
set(SOURCE_FILES
    src/main.cpp
    # ... 其他源文件 ...
)

# 创建可执行文件
add_executable(Jahshaka_Studio ${SOURCE_FILES})

# 链接Qt库
target_link_libraries(Jahshaka_Studio Qt5::Widgets)

# 链接IrisGL库
target_link_libraries(Jahshaka_Studio irisgl)

这个文件首先设置了项目名称和所需的CMake版本，然后定义了C++标准，寻找Qt库，添加了第三方库的子目录，指定了源文件，创建了可执行文件，并链接了所需的库。开发者可以通过编辑这个文件来调整构建选项和添加新的源文件。