mtcontrib/xcompat
1
0
Fork 0
mirror of https://github.com/mt-mods/xcompat.git synced 2025-10-29 15:35:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add explanation and example of material usage (#54)

Browse Source
This commit is contained in:
Medley
2025-10-06 23:44:36 +02:00
committed by GitHub
parent 8d6e82cfdb
commit c024d0b6c8
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/materials.md
View File

@@ -1,3 +1,11 @@
# Materials API
consult `/src/materials/minetest.lua` at this time
The materials can be accessed anywhere in your mod with `xcompat.materials.material_name`.
**Example**: `xcompat.materials.steel_ingot` returns the string of whichever item would closest represent the steel_ingot material in the current game.
Behind the scenes, the xcompat mod automatically changes the `xcompat.materials` variable to contain the correct materials for whichever game the mod is launched in.
See the [the support table in the readme](https://github.com/mt-mods/xcompat/tree/master?tab=readme-ov-file#directly-supported-games-and-mods) for an overview of supported games, and see the contents of `/src/materials/` for the supported materials and their names.
**Example**: the `/src/materials/mineclonia.lua` file shows what the keys of `xcompat.materials` resolve to when playing Mineclonia, such as `xcompat.materials.steel_ingot` resolving to `mcl_core:iron_ingot`, and `xcompat.materials.mesa_crystal` resolving to `mcl_redstone:redstone` if supported.