PolyMc-Extra

PolyMc-Extra

自动修补模组,使普通玩家无需安装模组即可加入你的服务器!

基础库

PolyMc-Extra

这是一个服务端库,也是一个为 PolyMc 提供自动修补模组的工具。它的功能与 PolyMc 类似,但更加强大。它可以实现对某些模组的自动修补,并且其修补功能可以通过修改配置文件来控制。

以下注册表条目已被补丁处理

列表:Attribute、EntityType、SoundEvent、ComponentType、EnchantmentEffectComponentType、EnchantmentLocationBaseEffectType、EnchantmentEntityEffectType、StatusEffect、Potion、ScreenHandlers、ConsumeEffectType、StatType、CustomStat、PoiType、ItemGroup、Item、Block、BlockEntityType、Profession

运行时生命周期:

  1. 注册内置的 ExtraModelType
  2. 注册特殊实体映射
  3. 扫描并执行所有模块的 "polymc-extra" 入口点(PolyMcExtraEntrypoint.class)
  4. 在所有静态注册表条目冻结之前:读取配置文件,遍历注册表,并修补每个缺失的条目(仅服务端)
  5. 验证物品组件完整性
  6. 扫描 JAR 文件中的所需资源并生成资源包

面向玩家/服务器所有者/整合包制作者:

它可以为大多数模组自动修复对应聚合物方块的状态,使原版客户端能够加入装有模组的服务器。

面向模组开发者:

它为开发者提供了若干 API 和工具,用于修补复杂的模组;其他问题可以在 Discord 上提问。

所需知识

你应当先学习如何使用一些库。

开发环境

  1. 在你的模块项目目录中创建一个 libs 文件夹。
  2. 下载 JAR 文件并将其放入你的模块项目目录中的 libs 文件夹。
  3. 将以下内容添加到 build.gradle:
repositories {
    maven { url "https://maven.nucleoid.xyz" }
    maven { url "https://maven.tomalbrc.de" }
    maven { url "https://api.modrinth.com/maven" }
    maven { url "https://maven.architectury.dev/" }
    maven {
        url "https://maven.theepicblock.nl"
        content { includeGroup("nl.theepicblock") }
    }
    flatDir {
        dirs 'libs'
    }
}
dependencies {
    modImplementation("eu.pb4:polymer-core:[${polymer_version}]")
    modImplementation("eu.pb4:polymer-blocks:[${polymer_version}]")
    modImplementation("eu.pb4:polymer-resource-pack:[${polymer_version}]")
    modImplementation("eu.pb4:polymer-resource-pack-extras:[${polymer_version}]")
    modImplementation("eu.pb4:polymer-virtual-entity:[${polymer_version}]")
    modImplementation("eu.pb4:polymer-autohost:${polymer_version}")
    modImplementation("eu.pb4:polymer-networking:[${polymer_version}]")
    modImplementation("nl.theepicblock:resource-locator-api:${project.resource_locator_version}")
    modImplementation("eu.pb4:factorytools:[${factorytools_version}]")
    modImplementation("eu.pb4:sgui:[${sgui_version}]")
    modImplementation("xyz.nucleoid:server-translations-api:${server_translation_api_version}")
    
    modImplementation files('libs/PolyMc-Extra-XXXXXXX.jar')
    modCompileOnly 'maven.modrinth:polydex:XXXXXX'
}

补丁代码示例

public class PolymerifyRegistry implements PolyMcExtraEntrypoint {

    @Override
    public void onInitialize() {
        PolymerifyRegistry.initialize();
        PolyMcExtraPacks.NAMESPACES.add(getNamespace());
    }
    
    public static void initialize() {
        registerPolymerBlock(BlockRegistry.XXX, XXXPolymerBlock.INSTANCE);
        registerPolymerItem(BlockRegistry.XXX, new PolymerItemImpl(BlockRegistry.XXX.asItem()));
    }

    public static void registerPolymerBlock(Block block, PolymerBlock polymerBlock) {
        ResourceLocation key = BuiltInRegistries.BLOCK.getKey(block);
        PolymerBlock.registerOverlay(block, polymerBlock);
        if (polymerBlock instanceof BlockWithElementHolder elementHolder) {
            BlockWithElementHolder.registerOverlay(block, elementHolder);
        }
        PolyMcExtra.LATE_INIT.add(new Runnable() {
            @Override
            public void run() {
                if (PolymerBlockHelper.testJsonExist(block)) {
                    BlockStateModelManager.addBlock(key, block);
                }
            }
        });
    }

    public static void registerPolymerItem(ItemLike item, PolymerItem polymerItem) {
        PolymerItem.registerOverlay(item.asItem(), polymerItem);
    }
    
    @Override
    public String getNamespace() {
        return MOD_ID;
    }
}

public class XXXPolymerBlock {
    public static final BlockState OVERLAY_0 = PolymerBlockResourceUtils.requestEmpty(BlockModelType.ACTIVE_PRESSURE_PLATE);
    public static final BlockState OVERLAY_1 = PolymerBlockResourceUtils.requestEmpty(BlockModelType.KELP_BLOCK);
    public static final BaseFactoryBlock INSTANCE = new BaseFactoryBlock(OVERLAY_0, false, BlockStateModel::midRange) {
        @Override
        public BlockState getPolymerBlockState(BlockState state, PacketContext context) {
            if (state.hasProperty(BlockStateProperties.WATERLOGGED) && state.getValue(BlockStateProperties.WATERLOGGED)) {
                return OVERLAY_1;
            }
            return super.getPolymerBlockState(state, context);
        }
    };
}

配置示例:

配置文件位于 /config/polymc-extra.json

{
	"DisabledOpaqueBlocks": [],
	"CustomBlockModelTypeMappings": {
		"citymod:stone_table": "BLOCK_DISPLAY_ENTITY",
		"citymod:road_block": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_yellow": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_yellow_connect": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_white_connect": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_yellow_double": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_zebra_crossing": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:roadblock_oblique": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:roadblock_yellow_oblique": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:roadblock_double_oblique": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:zebracrossing_oblique": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_straight": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"citymod:road_diamond": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:modern_light": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:computer_mouse": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:black_mirror": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:laptop": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:modern_clock": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:led_floor_lamp": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:shower": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:portable_laptop_stand": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:laptop_closed_portable_laptop_stand": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:cooktop": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:keyboard": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:monitor_setup": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:shower": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:socket": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:modern_chair": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"js_furniture_mod:wood_chair": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"^js_furniture_mod:midi_.+$": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"^js_furniture_mod:.*": "BLOCK_DISPLAY_ENTITY",
		"^skniro_furniture:.*_(drawer|cabinet|fridge|kitchen_sink|oven|tv_stand)$": "BLOCK_DISPLAY_ENTITY",
		"^skniro_furniture:.*_(bed|cushion|sofa|window(?:_style.*)?|plate|chair(?:_.*)?|lamp)$": "BLOCK_DISPLAY_ENTITY_NO_COLLISION",
		"^skniro_furniture:.*_window(_.*)?$": "CLOSEABLE_BLOCK",
		"^skniro_furniture:.*_(door)$": "CLOSEABLE_BLOCK",
		"^skniro_furniture:.*_glass_table": "BLOCK_DISPLAY_ENTITY",
		"terrestria:cattail": "WATER_PLANT",
		"terrestria:andisol_grass_block": "POLYMER:BIOME_TRANSPARENT_BLOCK",
		"^storagedelight:.*$": "BLOCK_DISPLAY_ENTITY",
		"^terrestria:.*_log$": "BLOCK_DISPLAY_ENTITY"
	},
	"CustomEntityModelMappings": {
		"js_furniture_mod:chair_entity": "polymc-extra:chair",
		"js_furniture_mod:sofa_entity": "polymc-extra:chair",
		"skniro_furniture:chair_entity": "polymc-extra:chair",
		"skniro_furniture:sofa_entity": "polymc-extra:chair",
		"skniro_furniture:cushion_entity": "polymc-extra:chair",
		"citymod:explode_bow_projectile": "minecraft:arrow",
		"citymod:rifle_legacy_projectile": "minecraft:arrow"
	},
	"CustomModelExpansionMappings": {
		"js_furniture_mod:sofa": 0.0,
		"js_furniture_mod:wood_light_table": 0.0,
		"js_furniture_mod:led_floor_lamp_rgb_off": 0.0,
		"js_furniture_mod:led_floor_lamp_rgb_off_2": 0.0,
		"js_furniture_mod:studio_light": 0.0,
		"citymod:road_block": 0.0,
		"citymod:road_yellow": 0.0,
		"citymod:road_yellow_connect": 0.0,
		"citymod:road_white_connect": 0.0,
		"citymod:road_yellow_double": 0.0,
		"citymod:road_zebra_crossing": 0.0
	}
}

命令

  • /polymc-extra:
    • export-extra-block-models-mappings:将 PolyMc 处理过的方块映射导出到 ExtraBlockMapping.txt
    • get-all-model-types:显示所有方块映射类型
    • get-client-state:显示准星所指方块的真正映射和叠加映射。
    • get-item-info:显示你手中物品的真实 ID 及其组件信息。

此库/模组不做的内容

它不支持客户端渲染。

如果模块使用 ASM 修改某些枚举或替换原版的注册表条目,会导致一些异常错误。

许可证

本模组部分基于 enderscape-patch 和 PolyMc 的代码,二者分别以 GNU Lesser General Public License v3.0 和 GNU Lesser General Public License 3.0 许可。