Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

New Documentation #1369

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

New Documentation #1369

wants to merge 9 commits into from

Conversation

mrtechtroid
Copy link
Contributor

@mrtechtroid mrtechtroid commented Dec 15, 2024

  • This PR has been tested locally. (Not needed to be)
  • New README
  • New CONTRIBUTING.MD
  • Update CTF Api Docs.

Ready for Merge/Final Review

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can clone with Visual Studio?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant using the GUI interface VSCode offers, after installing git. Like Ctrl+Shift+P and then Git: Clone.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably move the recommendation to CLI git but mention that VSCode offers a GUI for it

Copy link
Member

@LoneWolfHT LoneWolfHT Dec 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not all mtg mods are in mods/mtg/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Examples of ones which are not in /mtg/?

@mrtechtroid mrtechtroid marked this pull request as ready for review February 13, 2025 03:04
@mrtechtroid
Copy link
Contributor Author

@LoneWolfHT Its ready for review. Please lemme know all changes. Also search for "???" and lemme know what to put there.

@mrtechtroid
Copy link
Contributor Author

@LoneWolfHT Could I also get the correct params/config while setting up the different backends? (Especially redis)

@LoneWolfHT
Copy link
Member

@LoneWolfHT Could I also get the correct params/config while setting up the different backends? (Especially redis)

The redis instructions are in the readme.md

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants