letters-cd2025/Readme.md

40 lines
1.8 KiB
Markdown

## Letters: A mod for Minetest!
The majority of this code was taken (and altered significantly) from Calinou's [Moreblocks mod](https://forum.minetest.net/viewtopic.php?t=509). It is designed to add letters in all different materials. Code is licensed under the zlib license, textures under the CC BY-SA license.
The Letter Cutter textures use parts of the default wood and tree textures made by Blockmen and Cisoun respectively.
####Allowing letters to be made from nodes:
Use this code to allow blocks to have letters registered from them:
```lua
letters.register_letters(modname, subname, from_node, description, tiles)
```
Modname is the mod that the node belongs to.
Subname is the actual name of the node.
From_nobe is the node that the letters will be crafted from (Usually modname:subname).
Description is the description of the node.
Tiles defines the image that will be used with the node.
For example, if I wanted to register marble, from the mod darkage, this is the code I would use:
```lua
letters.register_letters("darkage", "marble", "darkage:marble", "Marble", "darkage_marble.png")
```
You will need to add letters as a dependency to your mod, or include the registrations is the code:
```lua
if minetest.get_modpath("letters") then
letters.register_letters("darkage", "marble", "darkage:marble", "Marble", "darkage_marble.png")
--ect ect...
end
```
Most of the default nodes have already been registered, and I have added/will add mods I like, as an optional dependancy.
*This mod is fairly stable, and shouldn't crash, but be warned that it is in its early stages of development, and so things may change considerably*
**Screenshots!**
![Screenshot](https://cdn.mediacru.sh/4/4BvHPHl70F9F.png)
![Another screenshot!](https://cdn.mediacru.sh/t/tuOkRXixvFHY.png)