Zen-flow NPM | npm.io

Install

$ npm i zen-flow -D

Note: This package requires Node >10.12.0 and Minecraft 1.7.10.

Features

Easy to use API, written in TypeScript.
Polymorphic and variadic; do more with less code.
Supports both MineTweaker3 and ModTweaker.
Formatted output; makes debugging easier.

Getting started

Crafting Table Add crafting recipe

import { vanilla } from 'zen-flow';

vanilla.add('<minecraft:saddle>', {
  1: '<minecraft:leather>', 2: '<minecraft:leather>', 3: '<minecraft:leather>',
  4: '<ore:ingotIron', 5: '<minecraft:string>', 6: '<ore:ingotIron>'
});

/**
 * recipes.addShaped(<minecraft:saddle>, [
 * 	[<minecraft:leather>, <minecraft:leather>, <minecraft:leather>],
 * 	[<ore:ingotIron>, <minecraft:string>, <ore:ingotIron>],
 * 	[null, null, null]
 * ]);
 **/

vanilla.add('<minecraft:saddle>', { edge: '<minecraft:leather>' });

/**
 * recipes.addShaped(<minecraft:saddle>, [
 * 	[null, <minecraft:leather>, null],
 * 	[<minecraft:leather>, null, <minecraft:leather>],
 * 	[null, <minecraft:leather>, null]
 * ]);
 **/

Extra Utilities generators Remove & hide generators

import { nei, vanilla } from 'zen-flow';

Array.from({ length: 11 })
  .map((_, i) => [
    `<ExtraUtilities:generator${i === 0 ? '' : `:${i}`}>`,
    `<ExtraUtilities:generator.8${i === 0 ? '' : `:${i}`}>`,
    `<ExtraUtilities:generator.64${i === 0 ? '' : `:${i}`}>`
  ])
  .flat()
  .map(generator => [
    vanilla.remove(generator),
    nei.hide(generator)
  ].join('\n'));

/**
 * recipes.remove(<ExtraUtilities:generator>);
 * NEI.hide(<ExtraUtilities:generator>);
 * [...]
 * recipes.remove(<ExtraUtilities:generator.64:10>);
 * NEI.hide(<ExtraUtilities:generator.64:10>);
 **/

API

Patterns

Shaped crafting recipes support the following shorthand patterns, in order:

Square

[
  [square, square, null],
  [square, square, null],
  [null, null, null]
]

Ring

[
  [ring, ring, ring],
  [ring, center, ring],
  [ring, ring, ring]
]

Edge / Corner

[
  [corner, edge, corner],
  [edge, center, edge],
  [corner, edge, corner]
]

Default

[
  [1, 2, 3],
  [4, 5, 6],
  [7, 8, 9]
]

Recipes

Items

addDict - Add ingredients to ore dictionary
removeDict - Remove ingredients from ore dictionary
withName - Change item name
withTooltip - Add item tooltip*
- Colours / formats
withTooltipShift - Add shift item tooltip*
- Colours / formats
withTag - Add item NBT tag data
- Display properties
withEnchantment - Add item enchantment(s)

* It is currently not possible to remove item tooltips.

Formatting

withName, withTooltip and withTooltipShift accept formatting strings:

// Bread
withName('<minecraft:bread>', 'Bread');

// Bread (with red text)
withName('<minecraft:bread>', { text: 'Bread', colour: 'red' });

// Bread (bold red text)
withName('<minecraft:bread>', { text: 'Bread', colour: 'red', format: 'bold' });

// Bread (normal text) with butter (yellow italic text)
withName('<minecraft:bread>', [
  '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
addFurnaceFuel - Add furnace fuel (excluding vanilla fuels)
removeFurnaceFuel - Removes furnace fuel (excluding vanilla fuels)

Forestry

addCarpenter - Add Carpenter recipe
removeCarpenter - Remove Carpenter recipe
addCentrifuge - Add Centrifuge recipe
removeCentrifuge - Remove Centrifuge recipe
addFermenter - Add Fermenter recipe
removeFermenter - Remove Fermenter recipe
addFermenterFuel - Add Fermenter fuel
removeFermenterFuel - Remove Fermenter fuel
addMoistener - Add Moistener recipe
removeMoistener - Remove Moistener recipe
addSqueezer - Add Squeezer recipe
removeSqueezer - Remove Squeezer recipe
addStill - Add Still recipe
removeStill - Remove Still recipe
addFabricator - Add Thermionic Fabricator recipe
removeFabricator - Remove Thermionic Fabricator recipe
addFabricatorFuel - Add Thermionic Fabricator glass source
removeFabricatorFuel - Remove Thermionic Fabricator glass source

Applied Energistics 2

addGrinder - Add Quartz Grindstone recipe
- bonus must be a value between 0 and 1
removeGrinder - Remove Quartz Grindstone recipe
addInscriber - Add Inscriber recipe
removeInscriber - Remove Inscriber recipe

Avaritia

addCompressor - Add Neutronium Compressor recipe
removeCompressor - Remove Neutronium Compressor recipe
addExtreme - Add Extreme Crafting recipe
removeExtreme - Remove Extreme Crafting recipe

ExNihilo

addComposter - Add item that can be composted to dirt
- fill must be a value between 0 and 1
removeComposter - Remove item that can be composted to dirt
addCrucibleNihilo - Add crucible recipe
removeCrucibleNihilo - Remove crucible recipe
addCrucibleSource - Add crucible heat source
- heat must be a value between 0 and 1
removeCrucibleSource - Remove crucible heat source
addHammer - Add hammer recipe
removeHammer - Remove hammer recipe
addSieve - Add sieve recipe
- Some percentages are impossible, such as
  - 0.7 => 1 / 0.7 => ~1.42 => 1 (100%)
  - 0.13 => 1 / 0.13 => ~7.69 => 8 (12.5%)
removeSieve - Remove sieve recipe

Examples

import { exnihilo } from 'zen-flow';

exnilo.addHammer('<minecraft:cobblestone>', {
  '<minecraft:stick>': 0.5, // 50%
  '<minecraft:bread>': [1, 1, 0.5] // 100%, 100%, 50%
  '<minecraft:stone>': [{ chance: 1, modifier: 2 }, { chance: 0.5, modifier: 1 }] // 100% with 2x modifier, 50% with 1x modifier
  '<minecraft:coal>': [{ chance: 1, modifier: 2 }, 1] // 100% with 2x modifier, 100% 
});

exnihilo.addSieve('<minecraft:cobblestone>', {
  '<minecraft:stick': 2.5 // 250%
  '<minecraft:bread>': 0.33 // 33%
});