libultraship 开源项目教程

libultraship 开源项目教程

libultraship Porting games to the PC 项目地址: https://gitcode.com/gh_mirrors/li/libultraship

1. 项目介绍

libultraship（简称 LUS）是一个旨在为现代硬件重新实现 libultra（N64 SDK）功能的库。LUS 使用了一种资产加载系统，其中数据与可执行文件分开存储在一个以 .otr 结尾的归档文件中，该文件与 mpq 兼容。这种将数据与可执行文件分离的设计遵循了现代设计实践，并且更加便于模块化。只需提供一个补丁 .otr 文件，系统就会自动替换数据。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的系统已安装以下工具：

• CMake
• 编译器（如 GCC 或 Clang）

2.2 克隆项目

首先，克隆 libultraship 项目到本地：

git clone https://github.com/Kenix3/libultraship.git
cd libultraship

2.3 构建项目

2.3.1 Linux/Mac 系统

在 Linux 或 Mac 系统上，使用以下命令进行构建：

cmake -H. -Bbuild
cmake --build build

2.3.2 Windows 系统

在 Windows 系统上，使用以下命令生成 Visual Studio 解决方案文件：

# Visual Studio 2022
'C:\Program Files\CMake\bin\cmake' -DUSE_AUTO_VCPKG=true -S . -B "build/x64" -G "Visual Studio 17 2022" -T v142 -A x64

# Visual Studio 2019
'C:\Program Files\CMake\bin\cmake' -DUSE_AUTO_VCPKG=true -S . -B "build/x64" -G "Visual Studio 16 2019" -T v142 -A x64

然后，使用以下命令进行构建：

'C:\Program Files\CMake\bin\cmake' --build .\build\x64

3. 应用案例和最佳实践

3.1 游戏移植

libultraship 主要用于将 N64 游戏移植到 PC 平台。通过重新实现 libultra 的功能，开发者可以更容易地将 N64 游戏的核心逻辑移植到现代硬件上。

3.2 模块化开发

由于 libultraship 将数据与可执行文件分离，开发者可以更方便地进行模块化开发。例如，可以通过替换 .otr 文件来更新游戏资源，而无需重新编译整个项目。

4. 典型生态项目

4.1 Fast3D

Fast3D 是一个用于渲染显示列表的库，与 libultraship 结合使用，可以实现高效的图形渲染。

4.2 ImGui

ImGui 是一个用于显示 UI 的库，与 libultraship 结合使用，可以为移植的游戏添加现代化的用户界面。

4.3 StormLib

StormLib 是一个用于创建和读取 mpq 兼容归档文件的库，libultraship 使用 StormLib 来管理游戏资源。

通过以上模块的介绍，您可以快速上手并深入了解 libultraship 项目。希望这篇教程对您有所帮助！

libultraship Porting games to the PC 项目地址: https://gitcode.com/gh_mirrors/li/libultraship