The Minecraft Property Encyclopedia

A comprehensive repository of information about blocks, entities and items, compiled in a powerful and easy-to-use online tool.
The website can be found at https://JoakimThorsen.github.io/MCPropertyEncyclopedia.

Discord!

There exists a public discord server (mostly) dedicated to this project at https://discord.gg/RUEVmTahYg, which is the main place to go for updates, discussion, suggestions, corrections and questions :)

Additions, corrections and suggestions via pull requests and reports on the issue tracker are also welcome.

A Note of caution

This project is in-development by a small group of volunteers. Some properties are either not yet automated, or are virtually impossible to automate, and are therefore manually curated. This means that some of the information may be incomplete, or even incorrect, despite the efforts of our contributors. Again, corrections and suggestions are welcome :)

For the full list of contributors, make sure to check out the About Page.

How to use

Property selection: You can select from a long list of properties for each page by expanding this dropdown. It also has a basic case-insensitive search feature.
Filtering: The values of properties can be used to filter and narrow down the list of entries that will be displayed. If a given entry has multiple values for this property (i.e. a stair block has both a full- and a half-block height), then only the values that match your filter are shown; if none match, the entry will be hidden.
Sorting: You can sort the list by any property, including both number and text values. If an entry has multiple values, then it will attempt to split up into individual entries for each value, and can therefore show up in multiple places where applicable.
Search: The main search bar lets you search through the entry names, as well as anything listed under "variants", given that that property is selected. Spaces (" ") in the search function as AND operators: typing "ca vi" will match "Cave Vines", despite not matching a continuous string. Pipe symbols ("|") also function as OR operators: "honey|slime" will show results for both honey and slime blocks. The search function is case-insensitive.
Settings: Various other actions and options are available under the collapsing "settings", including reset buttons, size conversions, and exporting options.

Joa mama

In order to effectivize the compiling of different properties, ensure accuracy, and speed up the updating process of the website's information for new game versions, a mod named Joa mama (heh) is being developed in order to extract the properties from the game code directly. It works by checking every block in the registry against a check for each property, and compiles a list of the results. This is then converted to the format described below via an external tool. Originally developed by bldhf, later forked by Joa

Technical details

The project is hosted through GitHub Pages. It operates entirely clientside and written in vanilla js, with jQuery 3.6 and Bootstrap 3.3.7 being used for the interface. Most icons used are from Font Awesome.

The data is currently being stored in JSON files under data/<thing>_data.json which all follow this current format:

*the root tag* {Obj}
│   
├─"conditional_formatting": {Obj}
│   └─ <*value>: (Str): The CSS formatting class to apply to the cell with this value.
│
├─"key_list": [Arr]
│   └─ <*entry key>: a list of every block/entity/item, depending on the page.
│
├─"sprites": {Obj} 
│   └─ <*entry key>: [Arr]
│       ├─ 0: (Str): a "sprite type" that specifies which sprite sheet to use for this sprite icon. Options are: "block-sprite", "entity-sprite", "item-sprite".
│       ├─ 1: (Int): x-offset of the sprite on the sprite sheet.
│       └─ 2: (Int): y-offset of the sprite on the sprite sheet.
│
├─"property_structure": [Arr]
│   ├─ <*property_id>
│   └─ {*Obj}
│       ├─ "category": (Str): the name of the category/folder that shows up in the selection dropdown.
│       └─ "contents": [Arr]
│           └─ ... more IDs and categories, nested recursively.
│
└─"properties": {Obj}
    └─ <*property_id>: {Obj}
        ├─ "property_name": (Str): the name that shows up on headers and in the selection menu. 
        ├─ "property_description": (Str): the description that shows up under the table header's "Description..." section.
        ├─ "default_value": (Str)|(Int)|null: the value to use if a block/entity/item is not listed in "entries".
        ├─ (optional) "default_selection": true|false: whether this shows up in the default selection when you first visit the page.
        ├─ (optional) "relative_gradient": true|false: used to enable relative gradient coloring, where values are colored relative to their position in the value/filter list.
        ├─ (optional) "size_type": (Str): determines the unit used, in order to allow for unit conversion. Options are: "block", "pixel".
        ├─ (optional) "max": (Int): The highest value to use as the "cap" for number colors.
        └─ "entries": [Arr]
            ├─ <*entry key>: (Int)|(Float)|(String): A standard value.
            ├─ <*entry key>: {Obj}
            │   └─ <*state/variant/other>: (Any): An object is used when different variants or states of any one entry have different values. Objects and arrays can be nested for further specificity.
            └─ <*entry key>: [Arr]
                └─ (Any): An array of values is used when there are multiple correct values for a given property. Value Arrays seldom contain objects or other arrays.

JoakimThorsen / MCPropertyEncyclopedia