Fallen Lib

模组

· 作者 rtxyd

一个提供运行时扩展实用程序库

0 本站下载 0 关注 更新于 3 个月前

最新 fallen_lib-1.4.6.jar · 1.20.1 · Forge

一键开服(送7天)

Fallen Lib 是一个小型的开发者工具库。
它目前用于开发 Fallen Gems & Affixes。

该模组提供了一些与 ASM 相关的 API 以及运行时工具,用于模组开发。
它不包含任何游戏内容,也不面向普通玩家。

开发环境

Gradle

repositories {
    maven { url "" }
}
dependencies {
    implementation fg.deobf("io.github.rtxyd:fallen-lib:1.4.6:core")
    implementation fg.deobf("io.github.rtxyd:fallen-lib:1.4.6:runtime")
}

或者你也可以在“附加文件”部分下载它们。

对于正常游玩或分发,请使用普通的 JAR 文件。

功能

FallenPatch

一个用于修补模组类的委托 API。

它可以挂钩特定类或所有子类,
从而在扩展模组行为时减少重复的补丁代码。

要使用该 API,你必须实现 `IFallenPatch` 接口,然后该类必须带有 `@FallenPatch` 注解并提供正确的参数。

例如:

@FallenPatch(
        priority = 1000,
        targets = @Targets(
                exact = {SomeClass.class},
                subclass = {SuperClass.class}),
        inserters = {FallenInserters.class})
public class FallenPatch implements IFallenPatch {
    private final IPatchDescriptor desc;
    // 这里你必须提供如下形式的构造函数。
    public FallenPatch(IFallenPatchCtorContext iFallenPatchCtorContext) {
        desc = iFallenPatchCtorContext.currentPatch();
    }
@Override
    public void apply(ClassNode cn, IFallenPatchContext iFallenPatchContext) {
        MethodInsnNode hook = iFallenPatchContext.getFallenInserter(
                InserterKey.of("xxx.xxx.FallenInserters",
                        "hook",
                        InserterType.STANDARD_VOID));
        for (MethodNode method : cn.methods) {
            InsnList insns = method.instructions;
            if (insns == null) continue;
            PatchUtil.insertMethodHook(cn,
                    method,
                    m -> m instanceof MethodInsnNode mn
                            && mn.owner.equals("xxx.xxx.ClassName")
                            && mn.name.equals("methodName")
                            && mn.desc.startsWith("(Ljava/lang/Object;")
                            && Type.getReturnType(mn.desc).getSort() != Type.VOID,
                    InserterType.STANDARD_VOID,
                    hook,
                    false,
                    false);
        }
    }
}</code></pre>
<p>`inserters` 指向一个至少包含 1 个带有 `@FallenInserter` 注解的方法的类。<br>例如 `FallenInserters.class`:</p>
<pre><code>public class FallenInserters {
    @FallenInserter(type = InserterType.STANDARD_VOID)
    public static void hook(IInserterContext&lt;Object, Object&gt; ctx, Object... args) {<br>        Object rec = ctx.receiver();
    }
}</code></pre>
<div>然后在你的资源根目录中应该有一个 `<strong>xxx.fallen.json</strong>` 文件。<br>格式如下:&nbsp;</div>
<div>
<pre><code>{
  "required": true,
  "min_version": "1.2.0",
  "package": "xxx.package.name",
  "fallen_patches": [
    "FallenPatch",
    "PatchClassName"
  ]
}</code></pre>
</div>
<p>目前,FallenPatch 仅支持对模组类进行补丁处理。<br>未来可能会添加更多支持。</p>
</div>
<p><strong>FallenInserter</strong></p>
<div class="spoiler">
<p>配合 FallenPatch 使用,在具有正确参数类型和返回类型的方法上使用 `@FallenInserter`,</p>
<p>目前有 2 种 <strong>InserterType</strong>:</p>
<p>`<strong>InserterType.STANDARD`</strong>&nbsp;</p>
<p>`<strong>InserterType.STANDARD_VOID`</strong></p>
<p>默认值为 standard,格式应如下所示:&nbsp;</p>
<pre><code>@FallenInserter(type = InserterType.STANDARD)
public static Object hook(IInserterContext&lt;Object, Object&gt; ctx, Object... args) {
    return ctx.ret();
}</code></pre>
<pre><code>@FallenInserter(type = InserterType.STANDARD_VOID)
public static void hook(IInserterContext&lt;Object, Object&gt; ctx, Object... args) {
}</code></pre>
<p><br>`<strong>ctx`</strong> 拥有 `<strong>ctx.receiver()`</strong> 和 `<strong>ctx.ret()`</strong> 方法,分别提供你插入位置的 `<strong>this(可能为 null)</strong>` 和该方法的返回值对象。如果该方法有返回值且方法中的 `replaceReturn` 标志为 `true`,则返回值将替换原始方法的返回值。你可以尝试使用工具类 `<strong>ObjectModifierFactory`</strong>` 来修改此对象的数值字段并返回。</p>
<p>`<strong>args`</strong> 是一个 `<strong>Object[]`</strong>`,包含你插入位置所在方法的所有参数。`InserterType.STANDARD` 在方法执行后调用,因此它们只是视图,请勿更改它们。</p>
<p>如果你正确配置并实现了带有正确注解的 IFallenPatch 接口,则可以</p>
<pre><code> MehtodInsnNode hookMethod = iFallenPatchContext.getFallenInserter(
                InserterKey.of("your.class.name", 
                               "methodName", 
                               InserterType));</code></pre>
<div>
<p>获取你的 hookMethod(如果它们具有正确的参数类型和返回类型,fallen lib 将会构建它们)</p>
<p>然后使用</p>
<pre><code>PatchUtil.insertMethodHook()</code></pre>
</div>
<p>以简化补丁编写(虽然不如 mixin 那样容易)。</p>
</div>
<hr>
<h4>RuntimeUtility</h4>
<p>一些运行时实用工具。</p>
<p>`<strong>ObjectModifierFactory`</strong>&nbsp;:</p>
<div class="spoiler">
<p>复制对象</p>
<p>修改数值字段</p>
<p>使用缓存和字段名过滤器</p>
<p>例如:&nbsp;</p>
<div>
<pre><code>public class FallenInserters {<br>    // 这需要一个 Predicate&lt;String&gt;<br> &nbsp; private static final ObjectModifierFactory FACTORY = new ObjectModifierFactory(s -&gt; {<br>            String filedName = s.toLowerCase();<br>            if (name.contains("xxx")) return true;<br>            return false;});
&nbsp;  @FallenInserter(type = InserterType.STANDARD)
    public static Object hook(IInserterContext&lt;Object, Object&gt; ctx, Object... args) {<br>        Object ret = ctx.ret()<br>        return FACTORY.doSomething(ret);
    }
}</code></pre>
</div>
<p>这主要用于在不修改原始对象的情况下进行运行时调整。</p>
</div>
<p><strong>`Delegated Mixin Connector Registry`</strong>:(高于版本 1.3.2)</p>
<div class="spoiler">
<p>一种类似注册表的服务,这使得你能够在 IDEA 中测试通过条件加载的 mixin 配置,只需在你的模组中实现官方的 IMixinConnector 类即可。</p>
<p>用法如下,目标是一个实现 IMixinConnector 的类,然后在<strong>资源根目录</strong>中使用以下格式配置 json:</p>
<pre><code>{
  "required": true,
  "min_version": "1.3.2",
  "mixin_connector": "net.kayn.apotheotic_hostility.FGAMixinConnector"
}</code></pre>
<p>键 "mixin_connector" 应该是你的类引用。</p>
</div>
<hr>
<h3>Apotheosis Addon (仅安装 Apotheosis 时)</h3>
<p>额外宝石加成</p>
<div class="spoiler">
<p>你现在可以在 apotheosis 1.20.1 中像 1.21.1 一样通过数据包注册额外的宝石加成</p>
<p>结构应为 `<strong>resources/namespace/extra_gem_bonuses/somegembonus.json</strong>`&nbsp;</p>
</div>
<hr>
<h3>注意事项</h3>

<p>该项目已可投入使用,<br>但随着开发的继续,API 仍可能发生变化。</p>

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源