-
Notifications
You must be signed in to change notification settings - Fork 92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Documentation #1369
Open
mrtechtroid
wants to merge
9
commits into
MT-CTF:master
Choose a base branch
from
mrtechtroid:readme_docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
New Documentation #1369
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
175f83a
New Readme Style.
mrtechtroid 23a258a
Create CONTRIBUTING.md
mrtechtroid c4eebde
Update CONTRIBUTING.md
mrtechtroid 6e336dd
Update CTF_API, (API folder)
mrtechtroid 2e33cff
Update CTF_API, (Others, MTG, PVP folder)
mrtechtroid 79623e7
Update CTF_API, (CTF Folder Part 1)
mrtechtroid 50eb5df
Update CTF_API, (CTF Folder Part 2)
mrtechtroid dc7363a
Merge branch 'master' into readme_docs
mrtechtroid 7701060
CTF_API Update Final
mrtechtroid File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,50 @@ | ||
| # Getting Started | ||
| It's very easy to set-up a local server in order to test and contribute to | ||
| the development version of this game project. | ||
| The game engine used is free, open source [Luanti](https://www.luanti.org/) formerly known as Minetest. | ||
|
|
||
| I would highly recommend using [Visual Studio Code](https://code.visualstudio.com/download), for making patches as it has easier source control and a variety of extensions. If you use Visual Studio Code we recommend these extensions: | ||
| - https://marketplace.visualstudio.com/items?itemName=sumneko.lua | ||
| - https://marketplace.visualstudio.com/items?itemName=dwenegar.vscode-luacheck | ||
| - https://marketplace.visualstudio.com/items?itemName=GreenXenith.minetest-tools | ||
|
|
||
| ### 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. | ||
| ``` | ||
| git clone --recursive https://github.com/MT-CTF/capturetheflag.git | ||
| ``` | ||
| - If you dont want to use a CLI, and want a more intitutive GUI based interface I would suggest using [Github Desktop](https://github.com/apps/desktop). | ||
| - I would recommend you to perform the git clone on a folder inside your Luanti games folder. Something like `\Luanati_5.11\games\capturetheflag_dev`. | ||
| This would make it easier for you to debug your changes. | ||
|
|
||
| # Getting Involved | ||
| ### Report Issues | ||
| If you encounter any problems with this version, you can report them to our GitHub Issue tracker. Very often, it will be very helpful for debugging purposes to fetch game logs when encountering issues. | ||
| Aditionally it will be very helpful to provide Game screenshots, debug.txt output,etc . | ||
|
|
||
| ### Patch Game | ||
| The main coding language used is Lua, feel free to create patches and propose them by making a Pull Request. You should look around on the GitHub Issue tracker for open issues or the `suggestions-note` channel on Discord | ||
| to implement new features on the game. When contributing from suggestions in the Discord server, please make sure the suggestions is not controvertial, and have at least 10 stars (With 'X's subtracted). | ||
| You can join the Discord server [here](https://discord.gg/vcZTRPX). If you are a new contributor, feel free to ask the other fellow devs any questions you have. | ||
| If you are just starting out, you can start with just making pull requests fixing minor bugs before submitting major features. | ||
|
|
||
| ### New Maps | ||
| Not into coding? But more into design? No worries, you can help us out too by creating new and interesting maps. The maps are present on a seperate [Github Repository](https://github.com/MT-CTF/maps/) | ||
| A few resources to get you started with | ||
| - Map Makers Readme: https://github.com/MT-CTF/capturetheflag/tree/master/mods/ctf/ctf_map | ||
| - A more detailed Handbook: https://ctf-handbooks.github.io/ | ||
|
|
||
| # Contribution Guidelines | ||
| Please ensure your pull request adheres to the following guidelines: | ||
| * Search for previous suggestions/pull requests before making a new one, as yours may be a duplicate. | ||
| * Make an individual pull request for each suggestion/bug fix. | ||
| * New categories or improvements to the existing code are welcome. | ||
| * Check your spelling and grammar. | ||
| * Make sure your text editor is set to | ||
| * Remove trailing whitespace | ||
| * Indent with tabs (not spaces) | ||
| * When creating a pull request based on a Discord suggestion, please include the message URL in your pull request. Ensure its not controvertial and has at least 10 stars (With 'X's subtracted) before working on it. | ||
|
|
||
| Thank you for your time! | ||
|
|
||
| You can help out the project by just ★ starring this repository from the upper right corner. | ||
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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+Pand thenGit: Clone.There was a problem hiding this comment.
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
There was a problem hiding this comment.
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