本文翻译整理自:https://github.com/FlaxEngine/FlaxEngine
一、关于 Flax Engine
Flax Engine 是一款采用 C++ 和 C# 编写的高品质现代 3D 游戏引擎。从惊艳的图形渲染到强大的脚本系统,它专为高效工作流设计,提供大量开箱即用的功能。了解更多请访问官网:https://flaxengine.com
本仓库包含 Flax Engine 的完整源代码(不包含受 NDA 保护的平台支持)。欢迎任何人贡献代码或在基于 Flax 的游戏中修改使用这些源代码。
相关链接资源
- 官网:https://flaxengine.com
- 开发博客:https://flaxengine.com/blog
- 文档:https://docs.flaxengine.com
- 论坛:https://forum.flaxengine.com
- 路线图:https://trello.com/b/NQjLXRCP/flax-roadmap
- Discord:https://flaxengine.com/discord
- VS 扩展:https://marketplace.visualstudio.com/items?itemName=Flax.FlaxVS
- 许可证:https://flaxengine.com/licensing/
关键功能特性
- 基于物理的渲染 (PBR) 和全局光照
- 跨平台支持(Windows/Linux/Mac)
- 高性能 C++ 核心引擎
- C# 脚本系统
- 可视化编辑器工具链
- Vulkan 图形后端支持
二、安装与编译
1、Windows 平台
系统要求
- Visual Studio 2022 或更新版本
- Windows 8.1 SDK 或更新版本
- Microsoft Visual C++ 2015 v140 工具集或更新版本
- .NET 8/9 SDK(Windows x64)
- Git with LFS
编译步骤
# 克隆仓库(需启用LFS)
git clone https://github.com/FlaxEngine/FlaxEngine.git
cd FlaxEngine
# 生成项目文件
GenerateProjectFiles.bat
# 使用VS打开Flax.sln
# 配置为 Editor.Development | Win64
# 编译Flax项目(F7)
# 运行Flax(F5)
2、Linux 平台
系统要求
- Visual Studio Code
- .NET 8/9 SDK
- Vulkan SDK
- Git with LFS
- Clang 6+ 编译器
安装依赖(Ubuntu示例)
sudo apt install dotnet-sdk-8.0 vulkan-sdk git git-lfs \
libx11-dev libxcursor-dev libxinerama-dev zlib1g-dev \
clang lldb lld
git-lfs install
编译步骤
./GenerateProjectFiles.sh
# 使用VS Code打开工作区
# 执行 Flax|Editor.Linux.Development|x64 配置任务
3、Mac 平台
系统要求
- XCode
- .NET 8/9 SDK
- Vulkan SDK
编译步骤
./GenerateProjectFiles.command
# 使用XCode或VS Code打开工作区
# 执行 Editor.Mac.Development 配置
常见问题排查
1、无法执行命令或找不到文件
- 重启电脑,确保DotNet已添加到PATH环境变量
2、.NET SDK不支持目标框架8.0
- 必须使用Visual Studio 2022,旧版本不支持.NET 8 SDK
3、缺少Vulkan渲染后端
- 安装Vulkan SDK后设置环境变量:
set VULKAN_SDK=%sdk_path%
4、NuGet解析失败
- 在VS组件中安装
.NET SDK
、NuGet包管理器
和NuGet构建任务
三、项目目录结构
***
Binaries/ # 可执行文件
├── Editor/ # 编辑器二进制文件
└── Tools/ # 工具二进制文件
Cache/ # 引擎本地数据缓存
├── Intermediate/ # 构建中间文件
│ ├── ProjectName/ # 项目构建缓存
│ └── Deps/ # 依赖构建缓存
└── Projects/ # 项目文件存储位置
Content/ # 资源资产文件
Development/ # 开发文件
├── Scripts/ # 实用脚本
Source/ # 源代码
├── Editor/ # 编辑器源码
├── Engine/ # 引擎核心源码
├── Platforms/ # 平台相关代码
│ ├── DotNet/ # C#依赖
│ └── PlatformName/ # 各平台文件
│ └── Binaries/ # 平台二进制文件
├── Shaders/ # 着色器代码
├── ThirdParty/ # 第三方代码
└── Tools/ # 开发工具源码
四、许可证与贡献
使用Flax源代码必须遵守《Flax Engine终端用户许可协议》。所有贡献需通过GitHub Pull Request提交,主分支(master)是主要开发分支。新代码需符合Flax编码规范,所有贡献受EULA条款约束。查看详情:https://flaxengine.com/licensing/
静态分析工具
- PVS-Studio:C/C++/C#/Java代码静态分析器
查看详情:https://pvs-studio.com/en/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source
伊织 xAI 2025-04-27(日)