From 51d3e0a23e3788223c6ae6f9140ba916ffd7698a Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Wed, 18 Sep 2024 00:37:03 +0100 Subject: [PATCH] CONTRIBUTING.md: add Lua API link; minor update ...we need to overhaul this with a *bunch* more detail --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e70f4d..791815c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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:** ## 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.