Skip to content

Latest commit

 

History

History
64 lines (52 loc) · 4.73 KB

README-ZH.md

File metadata and controls

64 lines (52 loc) · 4.73 KB

Language:English|简体中文

logo

以撒MOD的新时代来临了。

REPENTOGON是用于《以撒的结合：忏悔》版本v1.7.9b.J835(其它版本未测试且大概率不可用)的MOD。它通过修复重要bug、添加额外功能以及增强性能的方式，扩展了Lua API。

REPENTOGON通常被社区称为“代码扩展MOD”，它的工作方式与传统的mod有显著差异。它由 LibZHL 驱动，这也是 抗生（Antibirth） 使用的框架。REPENTOGON直接挂钩（HOOK）至游戏，允许直接管理过去无法在mod中改造的内容，或管理那些需要高性能开销的技巧或重新实现才能改造的内容。

LUA API文档

REPENTOGON对Lua API进行了添加和修改，并增加了大量新功能。你可以在这里查看文档:https://repentogon.com/docs.html

安装

  1. 从GitHub Actions下载构建。
  2. 将压缩文件中的内容解压至你的游戏目录。你可以通过Steam找到目录，在Steam库中右击The Binding of Isaac: Rebirth，点击属性，然后在弹出的窗口中点击已安装文件、浏览（位于右上角）。
    • 如果你通过Proton在Linux中游玩, 你需要点击属性，在通用中的启动选项中输入WINEDLLOVERRIDES="dsound=n,b" %command%。REPENTOGON无法在缺少启动选项的情况下启动。
  3. 启动游戏。如果REPENTOGON成功加载，你能够在游戏目录中看到zhl.log和repentogon.log，并且标题栏应显示Binding of Isaac: Repentance (+ REPENTOGON vX.X.X)。

卸载

技术上来说，在启动选项中输入-repentogonoff或删除dsound.dll即可禁用REPENTOGON，如果想要完全卸载：

  1. 从游戏目录中删除dsound.dll、freetype.dll、libzhl.dll、Lua5.4.dll、resources-repentogon和zhlREPENTOGON.dll.
  2. 可选，删除日志文件dsound.log、repentogon.log和zhl.log。
  3. 删除resources\rooms（其中的26.The Void_ex.stb）和resources\shaders （其中的coloroffset_gold_mesafix）。
  4. 打开resources\scripts文件夹，删除main_ex.lua和enums_ex.lua。
  5. 在User\Documents\My Games\Binding of Isaac Repentance（或者是savedatapath.txt中的存档路径）文件夹中删除Repentogon文件夹。注意这会完全清除所有自定义的成就和标记！

构建

（如果您并非开发者，我们建议您从GitHub Actions获取构建。）

需求

这个项目的性质要求我们使用与游戏相同的编译器。因此，明确需求Windows系统，以及以下内容:

  • CMake 3.13 或更高
  • Git
  • Visual Studio 2019 或更高

步骤

我们假设在本教程期间使用Git Bash以及CMake GUI。

  1. 递归克隆仓库：git clone --recursive https://github.com/TeamREPENTOGON/REPENTOGON
  2. 启动CMake。
  3. 在"Where is the source code"中将文件定位为克隆仓库的根目录（通常命名为REPENTOGON）。
  4. 在"Where to put the binaries"中选择任意文件夹。这里是生成文件的目录。 cmake1
  5. 在CMake GUI的底部，点击"Configure"。
    • 如果这是第一次构建，将提示您输入更多信息。
    • 编译器必须与您的Visual Studio版本匹配。
    • platform必须为Win32。
    • 其他选项保持默认，然后点击Finish。 cmake2
  6. 配置完成后点击“Generate”。会在您上文选定的文件夹中生成.sln文件。
  7. 在Visual Studio中打开生成的.sln文件。
  8. 构建项目。除非您是开发者，否则我们推荐您使用Release模式以获得更好的性能。
  9. 构建完成后将resources、resources-repentogon、dsound.dll、freetype.dll、libzhl.dll、Lua5.4.dll和zhlREPENTOGON.dll复制至游戏目录。
  • 可选，将ISAAC_DIRECTORY设置为游戏根目录以在构建结束后自动复制文件。

许可证

REPENTOGON使用GNU通用公共许可证第2版。

LibZHL使用MIT许可协议。因此，libzhl和libzhlgen文件夹中的所有内容都是MIT授权的，但以下文件和文件夹除外，它们是REPENTOGON的组件:

  • libzhl/functions与其中的内容
  • libzhl/IsaacRepentance_static.cpp

libs文件夹中的文件夹是外部依赖项，并且有自己的许可信息。检查这些文件夹(及其子模块的依赖项)以获取更多信息。

隐私保护声明

REPENTOGON不会收集或发送任何未经明确同意的用户信息。我们拥有可选的更新机制，该机制将在启动时将用户的IP地址传输到GitHub以确定是否有可用的新版本。但除此之外，我们不会处理或存储任何数据。