New Documentation #1369
New Documentation #1369
Conversation
| I would highly recommend using [Visual Studio Code](https://code.visualstudio.com/download), for cloning the project, creating patches, etc. | ||
|
|
||
| ### Fork Project | ||
| - You can create a clone of the project by using git from the CLI or with the use of a tool like the one recommended above. |
There was a problem hiding this comment.
You can clone with Visual Studio?
There was a problem hiding this comment.
I meant using the GUI interface VSCode offers, after installing git. Like Ctrl+Shift+P and then Git: Clone.
There was a problem hiding this comment.
I would probably move the recommendation to CLI git but mention that VSCode offers a GUI for it
There was a problem hiding this comment.
If it's your first time programming or using Github/Git I'd recommend VSCode with those extensions, but I personally prefer CLI git, and a competent contributor could use whatever editor they want, probably paired with CLI luacheck unless there's an extension for their editor
| A ranged weapon framework for Minetest. See the API reference [here](https://github.com/LoneWolfHT/rawf/blob/main/API.md) | ||
|
|
||
| # mtg | ||
| This folder contains the Minetest Game, along with redefinitions and overrides for the CTF Game. This folder doesnt expose any new APIs on its own. Please follow the Minetest Game API Reference for the same [here](https://github.com/minetest/minetest_game/blob/master/game_api.txt). |
There was a problem hiding this comment.
Not all mtg mods are in mods/mtg/
| ## ctf_settings | ||
| This mod adds a 'Settings' tab to the player's inventory. | ||
| Mods can use the ctf_settings API to add buttons/fields to the Settings tab that can be used to customize the mod's functionality per-player. | ||
|
|
||
| ### `ctf_settings.register(name, def)` | ||
| #### `ctf_settings.register(name, def)` |
There was a problem hiding this comment.
Might be better to just bold it, going off of my memory of H4s. IIRC you're not supposed to skip a header size when adding a sub-header
| This mod adds suffocation. Suffocation is basically the same as drowning, but it is for being stuck inside solid blocks. No API's are exposed by this mod. | ||
|
|
||
| ## select_item | ||
| This mod provides a simple dialog for players to select an item from. The API Reference is [here](https://github.com/MT-CTF/capturetheflag/blob/master/mods/other/select_item/API.md) |
There was a problem hiding this comment.
I planned to use this in the map editor, IIRC it's forked from a mod by Wuzzy
CONTRIBUTING.MD