/E2E-E-icons

Collections for Minecraft item icons to use in MD files. Moved to Krutoy242/mc-icons

⚠️

This repository moved to https://github.com/Krutoy242/mc-icons

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.

This string Turns into this
[Iron Ingot] [Anvil] [Triple Battery]

Other examples

Note that we can mark different mods or metas for same names

Before iconification: After iconification:

[Amber] (Biomes O' Plenty)
[Lens] (AA)
[Futura Block] (5)

[Basalt] (advancedrocketry)
[Basalt] (Chisel)
[Basalt] (EM)





Usage

  1. Install latest NodeJS for Windows or Unix

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

  3. Run mc-icons with input file path

    > npx mc-icons --input=README.md

  4. Input file would be changed in place

Options

> npx mc-icons --help output:

-i, --input     Input file path
-t, --treshold  Levenshtein name mistake treshold
-s, --silent    Do not any prompt
    --help      Show help

-r, --repo      Repository to make short links to
                default "https://github.com/Krutoy242/E2E-E-icons/raw/main/x32/"

Contributing

Some 1.12 Minecraft modpacks in addition to E2E-E have items that are not on the list.
You need to add these icons in the folder ./x32/ and update the .json files.

  1. Fork this repo on local machine, install dependensies > npm install
  2. Launch your Minecraft with IconExporter mod. Join world, run command to generate all icons:
/iconexporter export 32
  1. Move all created icons to folder ./x32/ without replacing
  2. Run > npm run preparse to generate .json mapping files
  3. Add, commit, push.
  4. Create PullRequest to main repo, to enlarge item dictionary. If you dont want to wait before PR would be accepted, use --repo= option to your fork.

Author