Skip to content
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.

Sign up for GitHub

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

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

New Documentation #1369

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
175f83a
New Readme Style.
mrtechtroid Dec 15, 2024
23a258a
Create CONTRIBUTING.md
mrtechtroid Dec 15, 2024
c4eebde
Update CONTRIBUTING.md
mrtechtroid Dec 16, 2024
6e336dd
Update CTF_API, (API folder)
mrtechtroid Dec 28, 2024
2e33cff
Update CTF_API, (Others, MTG, PVP folder)
mrtechtroid Dec 28, 2024
79623e7
Update CTF_API, (CTF Folder Part 1)
mrtechtroid Dec 29, 2024
50eb5df
Update CTF_API, (CTF Folder Part 2)
mrtechtroid Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# 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 cloning the project, creating patches, etc.
mrtechtroid marked this conversation as resolved.
Show resolved Hide resolved

### 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 •
edited
Loading

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

```
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.
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.
mrtechtroid marked this conversation as resolved.
Show resolved Hide resolved
* 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 before working on it.
mrtechtroid marked this conversation as resolved.
Show resolved Hide resolved

Thank you for your time!

You can help out the project by just ★ starring this repository from the upper right corner.
43 changes: 38 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,35 @@
# Capture The Flag

[![ContentDB](https://content.minetest.net/packages/rubenwardy/capturetheflag/shields/downloads/)](https://content.minetest.net/packages/rubenwardy/capturetheflag/) [![Build status](https://github.com/MT-CTF/capturetheflag/workflows/build/badge.svg)](https://github.com/MT-CTF/capturetheflag/actions)

<p align="center">
<img width="100px" src="/menu/icon.png" align="center" alt="Capture the Flag" />
<h1 align="center">Capture the Flag</h1>
<p align="center">Combat the enemy with swords, guns, grenades, and more as you try to capture their flag before they capture yours!</p>
</p>
<p align="center">
<a href="https://content.minetest.net/packages/rubenwardy/capturetheflag/">
<img alt="ContentDB" src="https://content.minetest.net/packages/rubenwardy/capturetheflag/shields/downloads/" />
</a>
<a href="[https://content.minetest.net/packages/rubenwardy/capturetheflag/](https://github.com/MT-CTF/capturetheflag/actions)">
<img alt="Build Status" src="https://github.com/MT-CTF/capturetheflag/workflows/build/badge.svg" />
</a>
<a href="https://github.com/MT-CTF/capturetheflag/graphs/contributors">
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/MT-CTF/capturetheflag" />
</a>
<a href="https://github.com/MT-CTF/capturetheflag/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/MT-CTF/capturetheflag?color=0088ff" />
</a>
<a href="https://github.com/MT-CTF/capturetheflag/pulls">
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/MT-CTF/capturetheflag?color=0088ff" />
</a>
<br />
<br />
</p>

<p align="center">
<h4 align="center">Official Server</h4>
<p align="center">Address: <code>ctf.rubenwardy.com</code> Port: <code>30001</code></p>
<p align="center" >You will need a Luanti (formerly Minetest) Client to join. </p>
</p>

<hr>

## Installation

Expand Down Expand Up @@ -41,12 +69,15 @@ Note that this version may be slightly behind the git version, but it will be a

## Development

* ### [WIP CTF API DOCS](docs/ctf-api.md)
* CTF API Docs: Lua API Reference - [Link](docs/ctf-api.md)
* 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

## Contributing
* Contributions are always welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.

## License

Created by [rubenwardy](https://rubenwardy.com/).
Expand All @@ -64,3 +95,5 @@ Media: [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)
* [Header](menu/header.png): [CC BY 3.0 Unported](https://creativecommons.org/licenses/by/3.0/) by [SuddenSFD](https://github.com/SuddenSFD)
* [Background Image](menu/background.png): [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) (where applicable) by [GreenBlob](https://github.com/a-blob) (Uses [Minetest Game](https://github.com/minetest/minetest_game) textures, the majority of which are licensed [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)). The player skins used are licensed under [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)
* [Icon](menu/icon.png): [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) by [SuddenSFD](https://github.com/SuddenSFD)


Loading