-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' into selection-tools-refactor
- Loading branch information
Showing
27 changed files
with
515 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.