RSDKv5-Decompilation 项目使用与启动教程

RSDKv5-Decompilation 项目使用与启动教程

RSDKv5-Decompilation A complete decompilation of Retro Engine (v5) 项目地址: https://gitcode.com/gh_mirrors/rs/RSDKv5-Decompilation

1. 项目介绍

RSDKv5-Decompilation 是一个开源项目，目的是对 Retro Engine（v5 和 v5Ultimate）进行完全的反编译。Retro Engine 是一款游戏引擎，被用于开发如 Sonic Mania 等游戏。本项目由社区爱好者维护，不仅为了让开发者更好地理解 Retro Engine 的工作原理，还提供了创建和玩转各种模组（mods）的工具。

2. 项目快速启动

环境准备

• 安装 Git，用于克隆和更新项目代码。
• 安装 CMake，一个支持多种编译器和平台的可扩展构建系统。

克隆项目

git clone --recursive https://github.com/Rubberduckycooly/RSDKv5-Decompilation.git

如果已经克隆了项目，运行以下命令来更新子模块：

git submodule update --init

获取依赖

根据您的操作系统，获取所需的依赖：

Windows

• 安装 Visual Studio Community，确保安装了 "Desktop development with C++" 工具。
• 安装 vcpkg，并运行以下命令来安装依赖：

[vcpkg root]/vcpkg.exe install libtheora libogg glew glfw3 sdl2 --triplet=x64-windows-static

替换 x64-windows-static 为 x86-windows-static 如果您需要编译 32 位版本。

Linux

使用以下命令根据您的发行版安装依赖：

# 对于 Arch
sudo pacman -S base-devel cmake glew glfw libtheora

# 对于 Debian/Ubuntu
sudo apt install build-essential cmake libglew-dev libglfw3-dev libtheora-dev

# 对于 Fedora
sudo dnf install make cmake gcc glew-devel glfw-devel libtheora-devel zlib-devel

# 对于 Void
sudo xbps-install make cmake gcc pkg-config glew-devel glfw-devel libtheora-devel zlib-devel

其他平台

本项目目前官方支持的平台有 Windows、Linux 和 Android。但是社区已经制作了其他平台的分支，如 WebASM、New 3DS、Wii U、Wii、Vita 等。

编译项目

在项目根目录中运行以下命令：

cmake -B build
cmake --build build --config release

编译完成后，可以在 build/ 目录中找到可执行文件。

3. 应用案例和最佳实践

• 模组开发：利用内置的模组加载器和 API，可以轻松创建和测试模组。
• 自定义着色器：对于支持的项目，内置着色器编译器可以让开发者自定义渲染效果。

4. 典型生态项目

RSDKv5-Decompilation 项目的生态中，有一些典型的项目，例如：

• Sonic Mania Decompilation：与 RSDKv5-Decompilation 结合，可以用于开发 Sonic Mania 相关的模组。
• 社区模组：许多社区成员基于 RSDKv5-Decompilation 开发了自己的模组，并在社区中分享。

RSDKv5-Decompilation A complete decompilation of Retro Engine (v5) 项目地址: https://gitcode.com/gh_mirrors/rs/RSDKv5-Decompilation