-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9a88720
commit c4dfa0e
Showing
1 changed file
with
56 additions
and
0 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,56 @@ | ||
| <p align="center"> | ||
| <img src="http://dwarslooper.com/media/projects/tntwars_logo.png" alt="dl-logo" width="15%"/> | ||
| </p> | ||
|
|
||
| <h1 align="center">TNTWars</h1> | ||
| <p align="center">A Minecraft minigame for explosive battles</p> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://dwarslooper.com/?re=discord"><img src="https://img.shields.io/discord/1085606686007500811?logo=discord&style=for-the-badge" alt="Discord"/></a> | ||
| <br> | ||
| <img src="https://img.shields.io/github/v/tag/Dwarslooper/TNTWars?style=for-the-badge" alt="Releases"/> | ||
| <img src="https://img.shields.io/github/last-commit/Dwarslooper/TNTWars?style=for-the-badge" alt="Last commit"/> | ||
| <img src="https://img.shields.io/github/issues/Dwarslooper/TNTWars?style=for-the-badge" alt="Issues open"/> | ||
| </div> | ||
|
|
||
| ## Documentation | ||
| Take a look at our [documentations](https://dwarslooper.com/documentation/tnt-wars/#/) for this project! | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Installation | ||
| 1. Download the latest release from the [releases](https://github.com/Dwarslooper/TNTWars/releases) page. | ||
| 2. Put the file in the plugins folder of your server. | ||
| 3. Restart your server. | ||
|
|
||
| ### Dependencies | ||
| - [Fast-Async-Worldedit](https://www.spigotmc.org/resources/fastasyncworldedit.13932/) | ||
|
|
||
| ⚠️ _Make sure to have all plugins installed on their latest versions!_ ⚠️ | ||
|
|
||
| ### Compatibilities | ||
| - [Multiverse-Core](https://dev.bukkit.org/projects/multiverse-core) | ||
|
|
||
| ## Contributions | ||
| We welcome and review all reasonable pull requests as long as you follow the guidelines below: | ||
|
|
||
| - IDE or system-related files should be added to the `.gitignore` and should never be committed in pull requests. | ||
| - If you modify existing code, ensure that it remains relatively close to the original code. | ||
| - Favor readability over compactness. | ||
| - Use the provided Manager classes for general changes. | ||
| - Before creating a pull request, remove any debug code, such as redundant logging or chat messages, that is always active. | ||
|
|
||
| ## Credits | ||
| - [LimoDerEchte](https://github.com/LimoDerEchte) for the StackCreator | ||
| - The [Paper Team](https://github.com/papermc) for [Paper](https://papermc.io) | ||
| - The Team of [FastAsyncWorldedit](https://intellectualsites.github.io/download/fawe.html) for the [FAWE Api](https://intellectualsites.github.io/fastasyncworldedit-documentation/api/api-usage.html) | ||
|
|
||
| ## Licensing | ||
| This project is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). | ||
|
|
||
| If you use **ANY** code from this source: | ||
| - You must disclose the source code of your modified work and the source code you took from this project. This means you are not allowed to use code from this project (even partially) in a closed-source and/or obfuscated application. | ||
| - You must clearly and prominently state to all end users that you are using code from this project. | ||
| - Your application must also be licensed under the same license. | ||
|
|
||
| *If you have any other questions, feel free to ask in our [Discord](https://dwarslooper.com/discord) server.* |