Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 5.62 KB

README.md

File metadata and controls

66 lines (49 loc) · 5.62 KB

img E2E-E Icons

This TS-Node CLI app designed to automatically turn text in Markdown files into Minecraft's item icons, parsing their names or brackets.

Cli program demonstartion

Examples

Modpack Enigmatica 2: Expert - Extended using this tool for changelogs.

Description Capture Result
Items with exact match [Beacon]
Item from Minecraft picked first [Glass]
Add (every) inside get all items [Mossy Wall (every)]
Add (any) inside to pick only one [Mossy Wall (any)]
Specify mod in parenth [Green wall] (Actually Additions)
You can use mod shortand
or abbreviature		 [Green wall] (actual)
[Green wall] (EM)
Use (fluid) postfix to get fluid [Enriched Lava] (fluid)
Use numbers (4) as metadata [Futura Block] (4)
[Futura Block] (5)
Capture by id [<mod:name:meta:{tag}>] [tconstruct:large_plate:0:{Material:"fierymetal"}]
Output first items if all have same icon [Advanced Pocket] (CC)
With mod defined only subset will be picked (if no exact match) [Basalt Sla (every)] (Quark)
Big lists (not all names available) [Molten Bucket (every)]
Predefined placeholders [placeholder:pickaxe:3][placeholder:jackhammer:15][placeholder:null]

Usage

  1. Install latest NodeJS for Windows or Unix

  2. Create Markdown file with strings of form [Item Name] (options)

  3. Run mc-icons with input file path

    > npx mc-icons README.md

  4. Input file would be changed in place

Options

> npx mc-icons --help output:

-t, --treshold    Levenshtein name mistake treshold  [number] [default: 0]
-x, --max         Maximum amount of icons in multiple results  [number] [default: 64]
-r, --repo        Repository to make short links to  [string] [default: "https://github.com/Krutoy242/mc-icons/raw/master/i/"]
-m, --modpack     Modpack shortand to filter icons, "e2ee" for example  [string]
-s, --silent      Do not any prompt  [boolean]
-o, --short       Shorten long links with is.gd  [boolean] [default: true]

Developing

To generate icons into repo:

  1. Install mods IconExporter and JEIExporter.
  2. Run from game /iconexporter export 64. Note this issue and the fact that when MC window resized, it could output icons in 32x32 format despite 64 in argument.
  3. Export JEI data (default ctrl+J hotkey, see controls).
  4. Run
ts-node src/tool/preparse.ts --mc=path/to/modpack --icons=icon-exports-x64 --modpack=modpack_shortand

Author