mirror of
https://github.com/mt-mods/xcompat.git
synced 2025-10-29 23:45:22 +01:00
27 lines
1011 B
Markdown
27 lines
1011 B
Markdown
# Materials API
|
|
|
|
## Usage
|
|
|
|
The materials can be accessed anywhere in your mod with `xcompat.materials.material_name`.
|
|
|
|
Behind the scenes, xcompat automatically changes the `xcompat.materials`
|
|
variable to contain the correct materials for whichever game the mod is
|
|
launched in.
|
|
|
|
## Game support
|
|
|
|
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.
|
|
|
|
## Examples
|
|
|
|
Writing `xcompat.materials.steel_ingot` returns the string of whichever item
|
|
would closest represent the `steel_ingot` material in the current game.
|
|
|
|
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.
|