zen-flow 2.2.0 → 2.3.0

package/README.md

@@ -23,7 +23,7 @@ $ npm i zen-flow -D
 
  - Easy to use API, written in <b>TypeScript</b>.
  - <b>Polymorphic</b> and <b>variadic</b>; do more with less code.
- - Supports both [MineTweaker3](http://minetweaker3.powerofbytes.com/) and [ModTweaker](http://minetweaker3.powerofbytes.com/wiki/ModTweaker).
+ - Supports both [MineTweaker3](http://minetweaker3.powerofbytes.com/) and [ModTweaker](https://web.archive.org/web/20200219174745/http://minetweaker3.powerofbytes.com/wiki/ModTweaker#Currently_Supported_Mods_1.7.10).
  - <b>Formatted output</b>; makes debugging easier.
 
 ## Getting started
@@ -87,84 +87,20 @@ Array.from({ length: 11 })
 
 ## API
 
- - [Types](#types)
- - MineCraft
-   - [Vanilla](#vanilla)
-      - [Crafting patterns](#crafting-patterns)
-   - [Items](#items)
-      - [Formatting](#formatting)
- - Mods
-    - [Avaritia](#avaritia)
-    - [ExNihilo](#exnihilo)
-    - [ExtraUtilities](#extrautilities)
-    - [MineFactoryReloaded](#minefactoryreloaded)
-    - [NEI](#nei)
-    - [ThermalExpansion](#thermalexpansion)
-
-## Types
-
-```TS
-type Stack = {
-  id: string,
-  n: number
-};
-
-type Ingredient = string | Stack;
-
-type RecipeShaped = Partial<{
-  1: string
-  2: string
-  3: string
-  4: string
-  5: string
-  6: string
-  7: string
-  8: string
-  9: string
-  corner: string
-  edge: string
-  ring: string
-  square: string
-  center: string
-}>;
-
-type RecipeShapeless = string[];
-
-type Recipe = RecipeShaped | RecipeShapeless;
-
-type Enchantment = {
-  type: keyof typeof ENCHANTMENTS
-  level?: number | string
-  short?: boolean
-};
-
-type TextRich = {
-  text: string
-  color?: typeof COLORS[number],
-  format?: typeof FORMATS[number]
-};
-
-type Text = string | TextRich;
-```
-
-## Vanilla
-
- - `add` - Add a crafting table recipe.
-    - Shaped recipe: `object`
-    - Shapeless recipe: `Array`
- - `addMirror` - Adds a shaped crafting table recipe with mirrored variant.
- - `remove` - Removes both shaped and shapeless recipes
- - `removeShaped` - Removes only shaped recipes
- - `removeShapeless` - Removes only shaped recipes
- - `replace` - Replaced crafting recipe
-    - Shaped recipe: `object`
-    - Shapeless recipe: `Array`
- - `replaceAll` - Replace all recipes
- - `replaceMany` - Remove all recipes and add multiple recipes
- - `addFurnace` - Adds furnace recipe
- - `removeFurnace` - Removes furnace recipe
-
-### Crafting patterns
+- [Patterns](#crafting-patterns)
+- [Recipes](#recipes)
+  - [Items](#items)
+    - [Formatting](#formatting)
+  - [Vanilla](#vanilla)
+  - [Applied Energistics 2](#appliedenergistics2)
+  - [Avaritia](#avaritia)
+  - [ExNihilo](#exnihilo)
+  - [ExtraUtilities](#extrautilities)
+  - [MineFactoryReloaded](#minefactoryreloaded)
+  - [NEI](#nei)
+  - [ThermalExpansion](#thermalexpansion)
+
+### Patterns
 
 Shaped crafting recipes support the following shorthand patterns, in order:
 
@@ -207,8 +143,9 @@ Shaped crafting recipes support the following shorthand patterns, in order:
   [7, 8, 9]
 ]
 ```
+### Recipes
 
-## Items
+#### Items
  
  - `addDict` - Add ingredients to ore dictionary
  - `removeDict` - Remove ingredients from ore dictionary
@@ -223,7 +160,7 @@ Shaped crafting recipes support the following shorthand patterns, in order:
 
 <i>* It is currently not possible to remove item tooltips.</i>
 
-### Formatting
+##### Formatting
 
 `withName`, `withTooltip` and `withTooltipShift` accept formatting strings:
 
@@ -243,15 +180,38 @@ withName('<minecraft:bread>', [
   { text: 'with butter', colour: 'yellow', format: 'italic' }
 ]);
 ```
+#### Vanilla
+
+ - `add` - Add a crafting table recipe.
+    - Shaped recipe: `object`
+    - Shapeless recipe: `Array`
+ - `addMirror` - Adds a shaped crafting table recipe with mirrored variant.
+ - `remove` - Removes both shaped and shapeless recipes
+ - `removeShaped` - Removes only shaped recipes
+ - `removeShapeless` - Removes only shaped recipes
+ - `replace` - Replaced crafting recipe
+    - Shaped recipe: `object`
+    - Shapeless recipe: `Array`
+ - `replaceAll` - Replace all recipes
+ - `replaceMany` - Remove all recipes and add multiple recipes
+ - `addFurnace` - Adds furnace recipe
+ - `removeFurnace` - Removes furnace recipe
+
+#### Applied Energistics 2
+
+ - `addGrinder` - Add Quartz Grindstone recipe
+ - `removeGrinder` - Remove Quartz Grindstone recipe
+ - `addInscriber` - Add Inscriber recipe
+ - `removeInscriber` - Remove Inscriber recipe
 
-## Avaritia
+#### Avaritia
 
  - `addCompressor` - Add Neutronium Compressor recipe
  - `removeCompressor` - Remove Neutronium Compressor recipe
  - `addExtreme` - Add Extreme Crafting recipe
  - `removeExtreme` - Remove Extreme Crafting recipe
 
-## ExNihilo
+#### ExNihilo
 
  - `addComposter` - Add item that can be composted to dirt
     - `fill` must be a value between `0` and `1`
@@ -269,7 +229,7 @@ withName('<minecraft:bread>', [
         - `0.13 => 1 / 0.13 => ~7.69 => 8 (12.5%)`
  - `removeSieve` - Remove sieve recipe
 
-### Examples
+###### Examples
 
 ```TypeScript
 import { exnihilo } from 'zen-flow';
@@ -287,26 +247,26 @@ exnihilo.addSieve('<minecraft:cobblestone>', {
 });
 ```
 
-## ExtraUtilities
+#### ExtraUtilities
 
  - `addQED` - Add QED recipe
     - QED only accepts <b>shaped</b> recipes
  - `removeQED` - Remove QED recipe
  - `replaceQED` - Replace QED recipe
 
-## MineFactoryReloaded
+#### MineFactoryReloaded
 
  - `addLaser` - Add ore to the Mining Laser ore table
  - `removeLaser` - Remove ore from the Mining Laser ore table
  - `addFoci` - Add ores to the Laser Focus ore table
  - `removeFoci` - Remove ores from the Laser Focus ore table
 
-## NEI
+#### NEI
 
  - `hide` - Hide item from NEI
  - `addNEI` - Add item to NEI
 
-## ThermalExpansion
+#### ThermalExpansion
 
  - `addCrucibleThermal` - Add Magma Crucible recipe
  - `removeCrucibleThermal` - Remove Magma Crucible recipe

package/dist/zenflow.cjs

@@ -102,6 +102,7 @@ const clamp = (min, max, n) => Math.max(min, Math.min(max, n));
 const fill = (n, x) => Array.from({ length: n }).map((_, i) => x ?? i);
 const toArray = (x) => Array.isArray(x) ? x : [x];
 const isObject = (x) => typeof x === "object" && !Array.isArray(x);
+const capitalize = (x) => `${x[0].toUpperCase()}${x.slice(1)}`;
 
 const formatLiteral = (x) => `"${x}"`;
 const formatId = (id) => id ?? "null";
@@ -162,6 +163,17 @@ const formatArgs = (...args) => {
 ` : list.join(", ");
 };
 
+const addGrinder = (recipe) => {
+  const out = formatArgs(formatIngredient(recipe.in), formatIngredient(recipe.out), recipe.turns, recipe.bonus && formatStack(recipe.bonus.primary), recipe.bonus?.secondary && formatStack(recipe.bonus.secondary));
+  return `mods.appeng.Grinder.addRecipe(${out});`;
+};
+const removeGrinder = (id) => `mods.appeng.Grinder.removeRecipe(${id})`;
+const addInscriber = (recipe) => {
+  const out = formatArgs([formatIngredient(recipe.in)], recipe.plate.top, recipe.plate.bottom, formatIngredient(recipe.out), capitalize(recipe.type));
+  return `mods.appeng.Inscriber.addRecipe(${out});`;
+};
+const removeInscriber = (id) => `mods.appeng.Inscriber.removeRecipe(${id});`;
+
 const addCompressor = (recipe) => `mods.avaritia.Compressor.add(${formatArgs(recipe.out, recipe.in.n, recipe.in.id)});`;
 const removeCompressor = (id) => `mods.avaritia.Compressor.remove(${id});`;
 const addExtreme = (ingredient, recipe) => {
@@ -268,7 +280,7 @@ const removeSmelter = (left, right) => {
   return `mods.thermalexpansion.Smelter.removeRecipe(${out});`;
 };
 const addTransposerFill = (recipe) => {
-  const out = formatArgs(recipe.rf, recipe.in, recipe.out, formatStack(recipe.liquid));
+  const out = formatArgs(recipe.rf, formatIngredient(recipe.in), formatIngredient(recipe.out), formatStack(recipe.liquid));
   return `mods.thermalexpansion.Transposer.addFillRecipe(${out});`;
 };
 const removeTransposerFill = (id, liquid) => `mods.thermalexpansion.Transposer.removeFillRecipe(${formatArgs(id, liquid)});`;
@@ -326,7 +338,9 @@ exports.addExtreme = addExtreme;
 exports.addFoci = addFoci;
 exports.addFurnace = addFurnace;
 exports.addFurnaceThermal = addFurnace$1;
+exports.addGrinder = addGrinder;
 exports.addHammer = addHammer;
+exports.addInscriber = addInscriber;
 exports.addInsolator = addInsolator;
 exports.addLaser = addLaser;
 exports.addMirror = addMirror;
@@ -350,7 +364,9 @@ exports.removeExtreme = removeExtreme;
 exports.removeFoci = removeFoci;
 exports.removeFurnace = removeFurnace;
 exports.removeFurnaceThermal = removeFurnace$1;
+exports.removeGrinder = removeGrinder;
 exports.removeHammer = removeHammer;
+exports.removeInscriber = removeInscriber;
 exports.removeInsolator = removeInsolator;
 exports.removeLaser = removeLaser;
 exports.removePulverizer = removePulverizer;

package/dist/zenflow.d.ts

@@ -78,6 +78,29 @@ declare type TextRich = {
 };
 declare type Text = string | TextRich;
 
+declare type RecipeGrinder = {
+    in: Ingredient;
+    out: Ingredient;
+    turns: number;
+    bonus?: {
+        primary: Stack;
+        secondary?: Stack;
+    };
+};
+declare type RecipeInscriber = {
+    in: Ingredient;
+    plate: {
+        top: string;
+        bottom?: string;
+    };
+    out: Ingredient;
+    type: 'inscribe' | 'press';
+};
+declare const addGrinder: (recipe: RecipeGrinder) => string;
+declare const removeGrinder: (id: string) => string;
+declare const addInscriber: (recipe: RecipeInscriber) => string;
+declare const removeInscriber: (id: string) => string;
+
 declare type RecipeCompressor = {
     in: Stack;
     out: string;
@@ -229,8 +252,8 @@ declare type RecipeSmelter = {
 };
 declare type RecipeTransposerFill = {
     rf: number;
-    in: string;
-    out: string;
+    in: Ingredient;
+    out: Ingredient;
     liquid: Stack;
 };
 declare type RecipeTransposerExtract = {
@@ -376,4 +399,4 @@ declare const replace: (ingredient: Ingredient, recipe: Recipe) => string;
 declare const replaceAll: (ingredient: Ingredient, recipe: Recipe) => string;
 declare const replaceMany: (ingredient: Ingredient, recipes: Recipe[]) => string;
 
-export { Enchantment, Ingredient, Recipe, RecipeShaped, RecipeShapeless, Stack, Text, TextRich, add, addComposter, addCompressor, addCrucible$1 as addCrucibleNihilo, addCrucibleSource, addCrucible as addCrucibleThermal, addDict, addExtreme, addFoci, addFurnace, addFurnace$1 as addFurnaceThermal, addHammer, addInsolator, addLaser, addMirror, addNEI, addPulverizer, addQED, addSawmill, addSieve, addSmelter, addTransposerExtract, addTransposerFill, hide, remove, removeComposter, removeCompressor, removeCrucible$1 as removeCrucibleNihilo, removeCrucibleSource, removeCrucible as removeCrucibleThermal, removeDict, removeExtreme, removeFoci, removeFurnace, removeFurnace$1 as removeFurnaceThermal, removeHammer, removeInsolator, removeLaser, removePulverizer, removeQED, removeSawmill, removeShaped, removeShapeless, removeSieve, removeSmelter, removeTransposerExtract, removeTransposerFill, replace, replaceAll, replaceMany, replaceQED, withEnchantment, withName, withTag, withTooltip, withTooltipShift };
+export { Enchantment, Ingredient, Recipe, RecipeShaped, RecipeShapeless, Stack, Text, TextRich, add, addComposter, addCompressor, addCrucible$1 as addCrucibleNihilo, addCrucibleSource, addCrucible as addCrucibleThermal, addDict, addExtreme, addFoci, addFurnace, addFurnace$1 as addFurnaceThermal, addGrinder, addHammer, addInscriber, addInsolator, addLaser, addMirror, addNEI, addPulverizer, addQED, addSawmill, addSieve, addSmelter, addTransposerExtract, addTransposerFill, hide, remove, removeComposter, removeCompressor, removeCrucible$1 as removeCrucibleNihilo, removeCrucibleSource, removeCrucible as removeCrucibleThermal, removeDict, removeExtreme, removeFoci, removeFurnace, removeFurnace$1 as removeFurnaceThermal, removeGrinder, removeHammer, removeInscriber, removeInsolator, removeLaser, removePulverizer, removeQED, removeSawmill, removeShaped, removeShapeless, removeSieve, removeSmelter, removeTransposerExtract, removeTransposerFill, replace, replaceAll, replaceMany, replaceQED, withEnchantment, withName, withTag, withTooltip, withTooltipShift };

package/dist/zenflow.mjs

@@ -98,6 +98,7 @@ const clamp = (min, max, n) => Math.max(min, Math.min(max, n));
 const fill = (n, x) => Array.from({ length: n }).map((_, i) => x ?? i);
 const toArray = (x) => Array.isArray(x) ? x : [x];
 const isObject = (x) => typeof x === "object" && !Array.isArray(x);
+const capitalize = (x) => `${x[0].toUpperCase()}${x.slice(1)}`;
 
 const formatLiteral = (x) => `"${x}"`;
 const formatId = (id) => id ?? "null";
@@ -158,6 +159,17 @@ const formatArgs = (...args) => {
 ` : list.join(", ");
 };
 
+const addGrinder = (recipe) => {
+  const out = formatArgs(formatIngredient(recipe.in), formatIngredient(recipe.out), recipe.turns, recipe.bonus && formatStack(recipe.bonus.primary), recipe.bonus?.secondary && formatStack(recipe.bonus.secondary));
+  return `mods.appeng.Grinder.addRecipe(${out});`;
+};
+const removeGrinder = (id) => `mods.appeng.Grinder.removeRecipe(${id})`;
+const addInscriber = (recipe) => {
+  const out = formatArgs([formatIngredient(recipe.in)], recipe.plate.top, recipe.plate.bottom, formatIngredient(recipe.out), capitalize(recipe.type));
+  return `mods.appeng.Inscriber.addRecipe(${out});`;
+};
+const removeInscriber = (id) => `mods.appeng.Inscriber.removeRecipe(${id});`;
+
 const addCompressor = (recipe) => `mods.avaritia.Compressor.add(${formatArgs(recipe.out, recipe.in.n, recipe.in.id)});`;
 const removeCompressor = (id) => `mods.avaritia.Compressor.remove(${id});`;
 const addExtreme = (ingredient, recipe) => {
@@ -264,7 +276,7 @@ const removeSmelter = (left, right) => {
   return `mods.thermalexpansion.Smelter.removeRecipe(${out});`;
 };
 const addTransposerFill = (recipe) => {
-  const out = formatArgs(recipe.rf, recipe.in, recipe.out, formatStack(recipe.liquid));
+  const out = formatArgs(recipe.rf, formatIngredient(recipe.in), formatIngredient(recipe.out), formatStack(recipe.liquid));
   return `mods.thermalexpansion.Transposer.addFillRecipe(${out});`;
 };
 const removeTransposerFill = (id, liquid) => `mods.thermalexpansion.Transposer.removeFillRecipe(${formatArgs(id, liquid)});`;
@@ -311,4 +323,4 @@ const replaceMany = (ingredient, recipes) => [
   ...recipes.map((recipe) => add(ingredient, recipe))
 ].join("\n");
 
-export { add, addComposter, addCompressor, addCrucible$1 as addCrucibleNihilo, addCrucibleSource, addCrucible as addCrucibleThermal, addDict, addExtreme, addFoci, addFurnace, addFurnace$1 as addFurnaceThermal, addHammer, addInsolator, addLaser, addMirror, addNEI, addPulverizer, addQED, addSawmill, addSieve, addSmelter, addTransposerExtract, addTransposerFill, hide, remove, removeComposter, removeCompressor, removeCrucible$1 as removeCrucibleNihilo, removeCrucibleSource, removeCrucible as removeCrucibleThermal, removeDict, removeExtreme, removeFoci, removeFurnace, removeFurnace$1 as removeFurnaceThermal, removeHammer, removeInsolator, removeLaser, removePulverizer, removeQED, removeSawmill, removeShaped, removeShapeless, removeSieve, removeSmelter, removeTransposerExtract, removeTransposerFill, replace, replaceAll, replaceMany, replaceQED, withEnchantment, withName, withTag, withTooltip, withTooltipShift };
+export { add, addComposter, addCompressor, addCrucible$1 as addCrucibleNihilo, addCrucibleSource, addCrucible as addCrucibleThermal, addDict, addExtreme, addFoci, addFurnace, addFurnace$1 as addFurnaceThermal, addGrinder, addHammer, addInscriber, addInsolator, addLaser, addMirror, addNEI, addPulverizer, addQED, addSawmill, addSieve, addSmelter, addTransposerExtract, addTransposerFill, hide, remove, removeComposter, removeCompressor, removeCrucible$1 as removeCrucibleNihilo, removeCrucibleSource, removeCrucible as removeCrucibleThermal, removeDict, removeExtreme, removeFoci, removeFurnace, removeFurnace$1 as removeFurnaceThermal, removeGrinder, removeHammer, removeInscriber, removeInsolator, removeLaser, removePulverizer, removeQED, removeSawmill, removeShaped, removeShapeless, removeSieve, removeSmelter, removeTransposerExtract, removeTransposerFill, replace, replaceAll, replaceMany, replaceQED, withEnchantment, withName, withTag, withTooltip, withTooltipShift };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zen-flow",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "MineTweaker ZenScript made easy.",
   "main": "dist/zenflow.cjs",
   "module": "dist/zenflow.mjs",