From 102d244548b8d238f7f709354b87896638dc2dad Mon Sep 17 00:00:00 2001 From: oier Date: Mon, 21 Aug 2023 21:59:34 +0200 Subject: [PATCH] :doc: Initial readme. --- README.md | 62 ++++++++++++++++++- gradle.properties | 2 +- .../powered/PoweredTradingStationMenu.java | 4 +- .../foundation/gui/RecipeRenderer.java | 4 -- 4 files changed, 64 insertions(+), 8 deletions(-) delete mode 100644 src/main/java/com/oierbravo/trading_station/foundation/gui/RecipeRenderer.java diff --git a/README.md b/README.md index df93bf8..766268d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,62 @@ -# TradingStation +Trading Station +--------------- +Made for modpacks. It doesn't add any recipe. + +Features +======== +- Basic station with no power requirements. +- Powered station with RF power requirements. +- Custom *Trading recipe* +- Indestructible variant for each station. +- Configurable consumption & progress. +- Mechanical station available with companion mod. +- +Trading recipe +============== +- `ingredients` (required). An array/list of 1 or 2 ingredients. +- `result` (required). Single output item/block +- `processingTime` (optional). Ticks required to process. Default to 1. Powered machine has a 5x speed. +- `biome` (optional). Biome requirement for the recipe. Default any. +- `exclusiveTo` (optional). Required station. Defaults any. Possible values: `basic`, `powered`, `mechanical` + +### Example (basic input & output) + +### Example (output item with NBT) + +### Example (biome requirement) + +### Example (exclusiveTo) + + +KubeJS 6.1 Integration +====================== +``` +ServerEvents.recipes(event => { + /** + * event.recipes.tradingStationTrading(Result Item, Input Ingredients[]) + * .processingTime(Int) [optional] + * .biome(Biome|BiomeTag) [optional] + * .exclusiveTo(String) [optional] + * .exclusiveTo(String[]) [optional] + **/ + + // Basic example + event.recipes.tradingStationTrading(Item.of('minecraft:emerald', 5),[Item.of("5x minecraft:diamond")]); + event.recipes.tradingStationTrading(Item.of('minecraft:emerald', 5),[Item.of("5x minecraft:oak_log"),Item.of("10x minecraft:birch_log")]).processingTime(100); + event.recipes.tradingStationTrading(Item.of('minecraft:emerald', 5),[Item.of("5x minecraft:diamond")]).processingTime(100); + event.recipes.tradingStationTrading(Item.of('minecraft:andesite',2),[Item.of("2x minecraft:cobblestone")]).processingTime(100); + + //Enchanted book result + event.recipes.tradingStationTrading(Item.of('minecraft:enchanted_book', '{StoredEnchantments:[{id:"power",lvl:5s}]}').strongNBT(),[Item.of("minecraft:stone")]).processingTime(100) + + // With biome requirement + event.recipes.tradingStationTrading(Item.of('minecraft:diamond_sword', '{Enchantments:[{id:"power",lvl:5s}]}').strongNBT(),[Item.of("5x minecraft:diamond")]).processingTime(100).biome('#minecraft:is_beach'); + event.recipes.tradingStationTrading(Item.of('minecraft:diamond_sword', '{Enchantments:[{id:"mending",lvl:1s}]}').strongNBT(),[Item.of("5x minecraft:diamond")]).processingTime(100).biome('minecraft:plains'); + + //With exclusive to requirement + event.recipes.tradingStationTrading(Item.of('minecraft:diamond_sword', '{Enchantments:[{id:"looting",lvl:1s}]}').strongNBT(),[Item.of("5x minecraft:diamond")]).processingTime(100).exclusiveTo('powered'); + event.recipes.tradingStationTrading(Item.of('minecraft:diamond_sword', '{Enchantments:[{id:"sharpness",lvl:1s}]}').strongNBT(),[Item.of("5x minecraft:diamond")]).processingTime(100).exclusiveTo(['powered','mechanical']); + +}) +``` \ No newline at end of file diff --git a/gradle.properties b/gradle.properties index b6bb04c..02fd419 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,7 +3,7 @@ org.gradle.jvmargs=-Xmx3G org.gradle.daemon=false -mod_version=0.0.2 +mod_version=0.1.0 modid=trading_station author=oierbravo display_name=Trading Station diff --git a/src/main/java/com/oierbravo/trading_station/content/trading_station/powered/PoweredTradingStationMenu.java b/src/main/java/com/oierbravo/trading_station/content/trading_station/powered/PoweredTradingStationMenu.java index 60f75c5..c291d48 100644 --- a/src/main/java/com/oierbravo/trading_station/content/trading_station/powered/PoweredTradingStationMenu.java +++ b/src/main/java/com/oierbravo/trading_station/content/trading_station/powered/PoweredTradingStationMenu.java @@ -43,8 +43,8 @@ public class PoweredTradingStationMenu extends AbstractTradingMenu { @Override public Coords2D[] getInputRecipeCoords() { return new Coords2D[]{ - Coords2D.of(28,20), - Coords2D.of(51,20) + Coords2D.of(28,24), + Coords2D.of(51,24) }; } @Override diff --git a/src/main/java/com/oierbravo/trading_station/foundation/gui/RecipeRenderer.java b/src/main/java/com/oierbravo/trading_station/foundation/gui/RecipeRenderer.java deleted file mode 100644 index 8633606..0000000 --- a/src/main/java/com/oierbravo/trading_station/foundation/gui/RecipeRenderer.java +++ /dev/null @@ -1,4 +0,0 @@ -package com.oierbravo.trading_station.foundation.gui; - -public class RecipeRenderer { -}