FishEngine 开源项目安装与使用指南

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

FishEngine是一款采用C++14编写的简单、类似Unity的游戏引擎。它的目录结构设计是为了便于开发者理解和扩展。以下是一些关键的目录及其功能介绍：

• Engine：核心引擎部分，包含了游戏逻辑、渲染、物理等核心组件的实现。

  • assets: 存放游戏资产，例如纹理、模型等。
  • example: 示例项目或示例代码，帮助用户快速理解如何使用FishEngine。
  • script: 引擎使用的脚本文件，可能包括C++源代码或者特定脚本语言的代码。
  • assets, example/Shadertoy/assets/shaders, script等子目录分别存放不同的资产、着色器源码和脚本文件。

• cmake_osx.sh, cmake_win.bat: 分别用于macOS和Windows平台的构建脚本。

• LICENSE, README.md: 包含了许可证信息和项目概述的文件。

• gitignore: 忽略特定文件类型的配置文件。

2. 项目的启动文件介绍

FishEngine的启动过程不直接体现在单个“启动文件”上，而是通过构建系统生成的应用程序来启动。通常，启动过程涉及运行由CMake生成的解决方案或项目文件（比如，在Windows上的.sln文件或macOS上的Xcode项目）。具体启动哪个可执行文件取决于你的构建设置，通常是名为FishEditor的编辑器或是直接编译出的游戏应用。

3. 项目的配置文件介绍

配置过程主要是通过CMakeLists.txt文件来进行的，而非传统的单独配置文件。当准备构建FishEngine时，你需要通过CMake指定各种路径和选项，如Qt5_DIR、PhysX_ROOT_DIR、FBXSDK_DIR等环境依赖的位置。这意味着配置信息分散在CMake命令行参数或CMakeLists.txt中。例如，使用cmake命令时，你可以通过-D标志来设置这些变量，这允许定制化引擎的编译和链接设置。

示例配置步骤（简述）

1. 初始化构建目录:

   git clone https://github.com/yushroom/FishEngine.git
   cd FishEngine/Engine
   mkdir build && cd build
   

2. 运行CMake生成项目文件（以Windows为例）:

   cmake -G "Visual Studio 14 Win64" -DQt5_DIR=your_qt5_dir -DPhysX_ROOT_DIR=your_physx_dir -DFBXSDK_DIR=your_fbx_sdk_dir ..
   

3. 构建与运行: 使用生成的项目文件打开IDE，并构建目标（如FishEditor），或通过CMake命令直接构建：

   cmake --build . --target FishEditor --config Release
   

请注意，实际操作中，你需要替换上述命令中的your_qt5_dir, your_physx_dir, your_fbx_sdk_dir为实际的软件安装路径。

通过以上步骤，你可以完成FishEngine的搭建和初步配置，进一步的学习和开发则需深入阅读引擎提供的API文档和示例代码。