PiscesCup 开发库
描述
该库为开发者提供一些便捷的方法,例如:
- 注册:注册物品、方块、物品组以及标签等。你可以在注册时设置配方和简易模型。
- 工具类:一些实用的工具类,例如
Language.java等。 - 数据生成:提供用于获取
DataProvider的工厂方法。 GUI:创建 GUI(正在开发中)
示例代码位于 示例文件夹。
安装
Gradle
在你的 build.gradle 文件的 dependencies 部分添加以下代码:
dependencies {
// 将此添加到依赖项中
include(modImplementation("io.github.piscescup:pc_develop_lib:1.0.0"))
}
为了方便更新版本,你可以使用以下方式:
dependencies {
include(
modImplementation("io.github.piscescup:pc_develop_lib:${pc_dev_lib_version}")
)
}
然后在 gradle.properties 文件中添加属性(属性名称由你决定):
pc_dev_lib_version=1.0.1
Maven
在你的 pom.xml 文件的 dependencies 标记中添加以下代码:
<dependency>
<groupId>io.github.piscescup</groupId>
<artifactId>pc_develop_lib</artifactId>
<version>1.0.0</version>
</dependency>
为了方便更新版本,你可以使用以下方式:
<dependency>
<groupId>io.github.piscescup</groupId>
<artifactId>pc_develop_lib</artifactId>
<version>${pc_dev_lib_version}</version>
</dependency>
然后在你的 pom.xml 文件的 properties 标记中添加一个属性标记(属性标记的名称由你决定):
<properties>
<pc_dev_lib_version>1.0.1</pc_dev_lib_version>
</properties>
用法
注册
如果你想设置翻译、模型或配方, 你应该先使用registerAndBuild() 方法。
否则,将会抛出 IllegalArgumentException 异常。
物品
入口:PCItemRegister
你可以使用 PCItemRegister.java 类和
PCBlockItemRegister.java 类来注册物品和方块物品。
以下是一些示例:
public static final Item ITEM1 = PCItemRegister.create(MOD_ID, "item1") // 使用给定的 Identifier 创建物品
// 注册并构建
.registerAndBuild()
// 为该物品创建配方
.shapedRecipe(PCShapedRecipe.Builder.create()
.pattern("***")
.pattern("***")
.pattern(" # ")
.definition('*', Items.ACACIA_PLANKS)
.definition('#', Items.ACACIA_BUTTON)
.category(RecipeCategory.BUILDING_BLOCKS)
.criterion("has_item", Items.ACACIA_PLANKS)
.count(4)
.build()
)
// 添加翻译。
.translate(Language.EN_US, "Test Item1")
.translate(Language.ZH_CN, "测试物品1")
// 设置物品的模型。
.model(Models.GENERATED)
// 返回待注册的物品。
.get();
public static final Item ITEM2 = PCItemRegister.create(MOD_ID, "item2")
.registerAndBuild()
.shapelessRecipe(PCShapelessRecipe.Builder.create()
.category(RecipeCategory.BUILDING_BLOCKS)
.input(ItemTags.PLANKS)
.input(ItemTags.BUTTONS)
.input(Items.IRON_INGOT)
.count(4)
.criterion("has_planks", Items.IRON_INGOT)
.build()
)
.translate(Language.EN_US, "Test Item2")
.translate(Language.ZH_CN, "测试物品2")
.model(Models.GENERATED)
.get();
public static final Item BLOCK_ITEM = PCBlockItemRegister.create(BLOCK)
.settings(new Item.Settings()
.maxCount(16)
.fireproof()
.rarity(Rarity.COMMON)
)
.registerAndBuild()
.shapelessRecipe(PCShapelessRecipe.Builder.create()
.category(RecipeCategory.BUILDING_BLOCKS)
.input(ItemTags.PLANKS)
.input(ItemTags.BUTTONS)
.input(Items.IRON_INGOT)
.count(4)
.criterion("has_planks", Items.IRON_INGOT)
.build()
)
.get();
方块
入口:PCBlockRegister
你可以使用 PCBlockRegister.java 类来注册方块。
以下是一些示例:
public static final Block BLOCK = PCBlockRegister.create(MOD_ID, "block1")
.settings(AbstractBlock.Settings.create()
.burnable()
.mapColor(DyeColor.BROWN)
.hardness(1.0f)
)
.registerAndBuild()
.translate(Language.EN_US, "Test Block1")
.translate(Language.ZH_CN, "测试方块1")
.simpleCubeAll()
.get();
物品组
入口:PCItemGroupRegister
你可以使用 PCItemGroupRegister.java 类来注册物品组。
以下是一些示例:
public static final ItemGroup ITEM_GROUP1 = PCItemGroupRegister.create(MOD_ID, "item_group1")
.itemGroupBuilder(ItemGroup.create(ItemGroup.Row.BOTTOM, 7)
.icon(() -> new ItemStack(Items.DIAMOND))
.entries(
(text, entries) -> {
entries.add(ModItems.ITEM1);
entries.add(ModBlocks.BLOCK);
}
)
)
.registerAndBuild()
.translate(Language.EN_US, "Test ItemGroup 1")
.translate(Language.ZH_CN, "测试物品组1")
.get();
标签
入口:PCItemTagKeyRegister
模组提供了通过 PCItemTagKeyRegister.java 和 PCBlockTagKeyRegister.java 类来注册 ItemTag 和 BlockTag 的方法。
在使用 registerAndBuild() 方法之前,你应该至少使用一次 add() 方法来添加内容。
以下是注册 ItemTag 的示例:
public static final TagKey<Item> TAG_KEY_1 = PCItemTagKeyRegister.create(MOD_ID, "tag/tag1")
.add(ModItems.ITEM1)
.add(ModItems.ITEM2)
.registerAndBuild()
.get();
以下是注册 BlockTag 的示例:
public static final TagKey<Block> BLOCK_TAG = PCBlockTagKeyRegister.create(MOD_ID, "tag/block_tag")
.add(ModBlocks.BLOCK)
.registerAndBuild()
.get();
PCItemTagKeyRegister 和 PCBlockTagKeyRegister 均提供了 createForVanilla(TagKey vanillaTagKey) 方法,用于从原版标签创建
PCItemTagKeyRegister 和 PCBlockTagKeyRegister。
以下是一些示例:
public static final TagKey<Block> VANILLA_NEED_IRON_TOOLS_TAG =
PCBlockTagKeyRegister.createForVanilla(BlockTags.NEEDS_IRON_TOOL)
.addBlock(ModBlocks.PC_BLOCK)
.registerAndBuild()
.get();
public static final TagKey<Block> VANILLA_PICKAXE_TAG =
PCBlockTagKeyRegister.createForVanilla(BlockTags.PICKAXE_MINEABLE)
.addBlock(ModBlocks.PC_BLOCK)
.registerAndBuild()
.get();
合成表
入口:PCShapedRecipe & PCShapelessRecipe
该模组提供了 PCShapedRecipe.java 和 PCShapelessRecipe.java 来设置物品的合成表。
以下是一些用法:
- 通过
PCShapedRecipe.java创建形状合成表:public static final PCShapedRecipe SHAPED_RECIPE = PCShapedRecipe.Builder.create() .pattern("***") .pattern("***") .pattern(" # ") .definition('*', Items.ACACIA_PLANKS) .definition('#', Items.ACACIA_BUTTON) .category(RecipeCategory.BUILDING_BLOCKS) .criterion("has_item", Items.ACACIA_PLANKS) .count(4) .build(); - 通过
PCShapelessRecipe.java创建无形状合成表:public static final PCShapelessRecipe SHAPELESS_RECIPE = PCShapelessRecipe.Builder.create() .category(RecipeCategory.BUILDING_BLOCKS) .input(ItemTags.PLANKS) .input(ItemTags.BUTTONS) .input(Items.IRON_INGOT) .count(4) .criterion("has_planks", Items.IRON_INGOT) .build();
模型
这些注册类提供了设置物品模型的方法。
对于物品:
你可以使用 PCItemRegister.java 类中的 model(Model model) 方法来设置物品的模型。
对于方块:
该模组仅在 PCBlockRegister.java 类中提供了 simpleCubeAll() 方法,用于设置方块的立方体全材质模型。
数据生成
该模组提供了一些 DataProviderFactory 来获取数据提供者。
语言提供者
入口:PCLanguageProvider & PCLanguageProviderFactory
该模组提供了 PCTranslationProviderFactory.java 类来获取翻译提供者。
使用 PCLanguageProviderFactory.java 获取特定的语言提供者:
languageProvider(Language lang):获取给定语言的FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider>列表。languagesProvider(Language... langs)&languagesProvider(List<Language> langs):获取给定语言列表的FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider>列表。allLanguagesProvider():获取所有语言的FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider>列表。
以下是一些示例:
import java.util.List;
public class PiscesCupDevelopLibDataGenerator
implements DataGeneratorEntrypoint
{
@Override
public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
PCLanguageProviderFactory.languagesProvider(Language.EN_US, Language.ZH_CN)
.forEach(pack::addProvider);
PCLanguageProviderFactory.allLanguagesProvider()
.forEach(pack::addProvider);
PCLanguageProviderFactory.languagesProvider(
List.of(Language.EN_US, Language.ZH_CN)
)
.forEach(pack::addProvider);
}
}
模型提供者
入口:PCModelProvider & PCModelProviderFactory
该模组提供了 PCModelProviderFactory.java 类来获取模型提供者。
使用 PCModelProviderFactory.java 获取特定的模型提供者:
modelProvider():获取提供者的FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider>列表。
以下是一个示例:
public class PiscesCupDevelopLibDataGenerator
implements DataGeneratorEntrypoint
{
@Override
public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
PCModelProviderFactory.modelProvider()
.forEach(pack::addProvider);
}
}
合成表提供者
入口:PCRecipeProvider & PCRecipesProviderFactory
该模组提供了 PCRecipeProviderFactory.java 类来获取合成表提供者。
使用 PCRecipeProviderFactory.java 获取特定的合成表提供者:
recipesProvider():获取提供者的FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider>列表。
以下是示例:
public class PiscesCupDevelopLibDataGenerator implements DataGeneratorEntrypoint {
@Override
public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
PCRecipesProviderFactory.recipesProvider()
.forEach(pack::addProvider);
}
}
标签提供者
入口:PCBlockTagProviderFactory & PCTagProviderFactory
该模组提供了一个枚举类:PCTagProviderFactory.java。其字段即为各个标签提供者。
字段的 factories() 方法可以返回一个由提供者的 FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider> 组成的列表。
随后,你可以使用 forEach() 方法将提供者添加到包中。
该枚举类还提供了一个静态方法 allTagProviderFactories(),它可以返回一个包含所有标签提供者的 List<FabricDataGenerator.Pack.RegistryDependentFactory<DataProvider>>。
以下是字段的示例:
public class PiscesCupDevelopLibDataGenerator implements DataGeneratorEntrypoint {
@Override
public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
PCTagProviderFactory.ITEM_TAG_PROVIDER.getFactories()
.forEach(pack::addProvider);
PCTagProviderFactory.BLOCK_TAG_PROVIDER.getFactories()
.forEach(pack::addProvider);
}
}
以下是静态方法 allTagProviderFactories() 的示例:
public class PiscesCupDevelopLibDataGenerator
implements DataGeneratorEntrypoint
{
@Override
public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
PCTagProviderFactory.allTagProviderFactories()
.forEach(pack::addProvider);
}
}
联系方式
如果你发现了一些问题或有建议,可以通过以下方式联系我:
你是这个资源的作者?登录后可认领此资源。
相似资源
一个用于收集生物掉落物的多区块模组。
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
查看物品与配方
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
适用于 MC 1.18+ 的 Effekseer 加载器
评论 0
登录后参与评分
还没有评论,来抢沙发吧