Skip to content

Commit

Permalink
Merge branch 'dev' into selection-tools-refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
VorTechnix committed Oct 1, 2024
2 parents 7a0d24f + 5fd0c3d commit b319baa
Show file tree
Hide file tree
Showing 27 changed files with 515 additions and 46 deletions.
36 changes: 36 additions & 0 deletions API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# API Reference
This file exists to give people looking for it convenient access to the various types of documentation WorldEditAdditions (WEA) provides.


## I'm a user of WorldEditAdditions
If you're using WEA in-game, you probably want the chat command reference:

- [Interactive Chat Command Reference](https://worldeditadditions.mooncarrot.space/Reference/)
- [Source file for the above in the git repository](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md)

Remember: *Documentation, not code, defines what a program does.*

In other words, if the documentation ain't right, [open an issue](https://github.com/sbrl/Minetest-WorldEditAdditions/issues/new)!


## I'm a mod developer and I want to hook into WorldEditAdditions
That's awesome! WEA provides an extensive library of node and region manipulation functions. It also provides a significantly extensive library of utility functions - many of which Lua should provide built-in like Javascript.

- [Lua API Reference](https://worldeditadditions.mooncarrot.space/api/)

The Lua API reference is built automatically from code comments using [moondoc](https://github.com/sbrl/moondoc). These code comments have been curated and written to ensure the docs are as detailed as possible. This is an ongoing process however, so if there are any issues with these docs, please get in touch.

## I want to hack on WorldEditAdditions!
Yay, we always love new people around here! Do see our Lua API docs and our contributing guide:

- [Lua API Reference](https://worldeditadditions.mooncarrot.space/api/)
- [Contributing Guide](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/dev/CONTRIBUTING.md)
- [Discord server](https://discord.gg/FzD73kuhsk)

We also have a dedicated channel to development questions and chatter in our Discord server.

## I want to do something else!
Interesting! Do get in touch, as we'd love to hear about it:

- [GitHub discussion board](https://github.com/sbrl/Minetest-WorldEditAdditions/discussions)
- [Discord server](https://discord.gg/FzD73kuhsk)
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Note to self: See the bottom of this file for the release template text.
- Added [`//nodeapply`](https://worldeditadditions.mooncarrot.space/Reference/#nodeapply), a generalisation of [`//airapply`](https://worldeditadditions.mooncarrot.space/Reference/#airapply) that works with a defined list of nodes. Check out [the reference](https://worldeditadditions.mooncarrot.space/Reference/#nodeapply) - it has some cool tricks to it! (thanks for suggesting, @kliv91 from the Discord server!)
- Added [`//ngroups`](https://worldeditadditions.mooncarrot.space/Reference/#ngroups), which lists the groups that a given node is a member of. Useful when paired with [`//nodeapply`](https://worldeditadditions.mooncarrot.space/Reference/#nodeapply)!
- Added [`//rotate+`](https://worldeditadditions.mooncarrot.space/Reference/#rotate) to rotate regions through arbitrary series of potentially non-axis-aligned rotations. **Does not support slabs/stairs yet,** but this is on the todo list!
- Added [`//speed`](https://worldeditadditions.mooncarrot.space/Reference/#rotate) to adjust your own movement speed
- Added [`//speed`](https://worldeditadditions.mooncarrot.space/Reference/#speed) to adjust your own movement speed
- Also added an associated [movement speed adjustment tool](https://worldeditadditions.mooncarrot.space/Reference/#movement), which looks like this: ![A picture of the move speed adjustment tool. It looks like a monarch butterfly.](https://raw.githubusercontent.com/sbrl/Minetest-WorldEditAdditions/dev/worldeditadditions_farwand/textures/worldeditadditions_movement.png)
- Added [`//set+`](https://worldeditadditions.mooncarrot.space/Reference/#set) for setting nodes and param2/light levels quickly.
- NOTE TO SELF: Setting light values doesn't appear to be working very well for some reason
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit b319baa

Please sign in to comment.