sbrl-github/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-11-01 05:43:01 +00:00
Code Issues Releases Wiki Activity

CONTRIBUTING.md: add Lua API link; minor update

Browse source 
...we need to overhaul this with a *bunch* more detail
This commit is contained in:
Starbeamrainbowlabs 2024-09-18 00:37:03 +01:00
parent d787309127
commit 51d3e0a23e
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CONTRIBUTING.md
View file

@ -2,13 +2,14 @@
Hey there! So you like WorldEditAdditions enough to consider helping out? That's awesome! This guide should get you up and running in no time.
**Lua API documentation:** <https://worldeditadditions.mooncarrot.space/api/>
## Code structure
The WorldEditAdditions codebase is split into 3 main submods:
Name | Description
--------------------------------|------------------------
`worldeditadditions` | The main mod. Core world manipulation implementations should go in here.
`worldeditadditions` | The main mod. Core world manipulation implementations (backed by the `*_core` mod ref core and utility functions) should go in here.
`worldeditadditions_commands` | Chat commands. These interact with the core manipulators in `worldeditadditions` mod.
`worldeditadditions_farwand` | Everything to do with the far wand tool, and now other tools like the cloud wand, multi-point wand, etc. It's different enough to everything else that it warrants it's own separate mod to avoid muddling things.
`worldeditadditions_core` | Core components such as the positioning system (`worldeditadditions_core.pos`), the command registration function, and utility functions go in here.