Verified Commit 247b7c1c authored by Yannick Schinko's avatar Yannick Schinko
Browse files

Nicer README

parent aa73bfec
Pipeline #382 passed with stages
in 3 minutes and 53 seconds
# AuraSudo
A plugin that let
# [AuraSudo](https://github.com/AuraDevelopmentTeam/AuraSudo)
[![Build Status](https://gitlab.aura-dev.team/AuraDev/AuraSudo/badges/master/pipeline.svg)](https://gitlab.aura-dev.team/AuraDev/AuraSudo/pipelines)
[![Coverage Report](https://gitlab.aura-dev.team/AuraDev/AuraSudo/badges/master/coverage.svg)](https://gitlab.aura-dev.team/AuraDev/AuraSudo/pipelines)
A plugin that lets you switch into sudo mode, so you can still play on your server as normal.
## Downloads
You can download all builds from either:
- Maven:
- Releases: https://maven.aura-dev.team/repository/auradev-releases/
- Snapshots: https://maven.aura-dev.team/repository/auradev-snapshots/
## [Issue Reporting](https://github.com/AuraDevelopmentTeam/AuraSudo/issues)
If you found a bug or even are experiencing a crash please report it so we can fix it. Please check first if a bug report for the issue already
[exists](https://github.com/AuraDevelopmentTeam/AuraSudo/issues). If not just create a
[new issue](https://github.com/AuraDevelopmentTeam/AuraSudo/issues/new) and fill out the form.
Please include the following:
* Minecraft version
* AuraSudo version
* BungeeCord/Velocity/Sponge/Spigot version/build
* Versions of any mods/plugins potentially related to the issue
* Any relevant screenshots are greatly appreciated.
* For crashes:
* Steps to reproduce
* Latest log
*(When creating a new issue please follow the template)*
## [Feature Requests](https://github.com/AuraDevelopmentTeam/AuraSudo/issues)
If you want a new feature added, go ahead an open a [new issue](https://github.com/AuraDevelopmentTeam/AuraSudo/new), remove the existing form and describe your
feature the best you can. The more details you provide the easier it will be implementing it.
You can also talk to us on [Discord](https://discord.me/bungeechat).
## Developing with our Plugin
So you want to add support or even develop an addon for our plugin then you can easily add it to your development environment! All releases get uploaded to my
maven repository. (Replace `{version}` with the appropriate version!)
### Maven
<repositories>
<repository>
<id>AuraDevelopmentTeam/id>
<url>https://maven.aura-dev.team/repository/auradev-releases/</url>
<!--<url>https://maven.aura-dev.team/repository/auradev-snapshots/</url>-->
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>team.aura_dev.aurasudo.api</groupId>
<artifactId>AuraSudo-api</artifactId>
<version>{version}</version>
<scope>shadow</scope>
</dependency>
</dependencies>
### Gradle
repositories {
maven {
name "AuraDevelopmentTeam"
url "https://maven.aura-dev.team/repository/auradev-releases/"
// url "https://maven.aura-dev.team/repository/auradev-snapshots/"
}
}
dependencies {
shadow "team.aura_dev.aurasudo.api:AuraSudo-api:{version}"
}
## Setting up a Workspace/Compiling from Source
* Clone: Clone the repository like this: `git clone --recursive https://github.com/AuraDevelopmentTeam/AuraSudo.git`
* IDE-Setup: Run `gradle` in the repository root: `./gradlew installLombok <eclipse|idea>`
* Build: Run `gradle` in the repository root: `./gradlew build`. The build will be in `build/libs`
## Development builds
Between each official release there are several bleeding edge development builds, which you can also use. But be aware that they might contain unfinished
features and therefore won't work properly.
You can find the builds here: https://gitlab.aura-dev.team/AuraDev/AuraSudo/pipelines
On the right is a download symbol, click that a dropdown will open. Select "build". Then you'll download a zip file containing all artifacts including the
plugin jar.
## Signing
### PGP Signing
All files will be signed with PGP.
The public key to verify it can be found in `keys/publicKey.asc`. The signatures of the files will also be found in the maven.
### Jar Signing
All jars from all official download sources will be signed. The signature will always have a SHA-1 hash of `2238d4a92d81ab407741a2fdb741cebddfeacba6` and you
are free to verify it.
## License
AuraSudo is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)
## Random Quote
> If it doesn’t work, it doesn’t matter how fast it doesn’t work.
>
> -- <cite>Mich Ravera</cite>
......@@ -6,7 +6,7 @@ type=none
pluginId=aurasudo
pluginName=AuraSudo
baseGroup=team.aura_dev
description=A plugin that let's you switch into sudo mode so you can still play on your server as normal.
description=A plugin that lets you switch into sudo mode, so you can still play on your server as normal.
signJar=true
enableShadow=true
......
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v2
mQINBFj+j0YBEADQ5LKADgC5iQDw0csb8iPv3mQAw++wr5pW2lrpsrsBJuzoCIbH
0zZ0PwNOIsbaRqb2CM+SeaCUkWlfjV0Oy41D38Ay9NBjrI3dWWQqVQcTpCmWPolJ
ScJn4iOkCeEJC394Qp6QrX9NQfQTd3ElhFSutYqYBOi+PhOMO9G+gPbNKfihcgps
T5yBlCN6JCHtzmoCgQgRhkHF05Ikf4Y2QwRX+NuwTZKGPPw6KhteWCOabJktyldI
CB+jc/0GZFm7h3iv8vneAOpjIEU5d8JCoWAkwaNcj88We37+Lze8waRA0ZJ5Nog/
EgEud3cKkAFGiVHOeiKGq6zakA8nKLfsLMPFF5cMJl6azwzKwixsEGa+SQGMr9FY
FdH/5d4SpaBBQXxGfTY9wsTlzwDIuq7UozuFBb3Zph3AP2ps3K1T58rq+yqsZd9t
TLmdoHz9tQlvxSlieyQUItH4DpUUZ/SbQbGe3yn7lVQ435gGWLgNLD7FAkrwmV4C
Po+65E4IYfEC/Da25LshGxXxSG46AWVJGx+0CMQhV4AwHXhqBdAwBVgakr9zP4hV
9naCpT82U00XHKjx2owUXwiP/gg3TxQ7fdJs7Rb1t+NwOy2nDwckU/RwZboGjcF2
IXPgU8G4OHPBaXKDB1xUfiCdxrDZjZE2Y7cj/HHbx/EZDRH6KYuL3Xz5vwARAQAB
tCVZYW5uaWNrIFNjaGlua28gPHlhbm5pY2tAdGVkd29ybGQuZGU+iQI5BBMBCAAj
BQJY/o9GAhsDBwsJCAcDAgEGFQgCCQoLBBYCAwECHgECF4AACgkQZszCNMLOswYX
zhAAwmaLkdkR0neU9xrRfcko6rLNr1DQwutQ5sKHT5TWvmGNGizRnfIpyOUpdO1u
9q+vIUK+KqVWn54MkdeVztZkHRGHMXMDO/nDQsB5rZGRPDncGquFBNTZVu2HglrF
waFihRYY5/h8hIX3G0RxS7sHH0Q6j26nn2VeSBk5Hf/lPTpd6evxfoakr9E9eEj1
HMHJnGgzroEGQIiaBSA0Gkvh7ZQE0JoIhaiCIeiYnj/s7DoiOet6Da0R90JhLt2T
w3qrZ7aKiMVFva4/5S2QM4IKhbq9Cf/dO7u7otAOYOCRL8cghbMgS9+bU0UsFUD1
2s0tBh7s7kN/3D+Sm8hjdHhWd/WKFfpmu4qpKcj5HC6B1K1bwqmfJCIsdLK7g01n
sjvowPDPezJlz8LvCHupKICGXXG137kw9a35l96modkwgZZ3EUzv8r+ftcEGVdvf
z69vL8TsmTQWw931jJrMQ6ooa1c5Pkt8FChgdjs+mIHCvJvrI+ZB8hbxb/6+7weO
/8yRwmQE4AAO7vx09pz1DjwaTbJ+5B1wdaGwXEs+g72GG+0fyLZx1wrTuyG4wu0G
i8WwuM9nr3a5YauyaRMjbf5UFP/0auE+TDtxZt1aCnJtbaJQTXxFrcT9KOoTR5dH
/RQhQIotrNmR2LopC3acaHkfFwNp8Zu6HKn41QPvmnUjrvu5Ag0EWP6PRgEQAJsV
D6A+DcxKeWg4aqhaHOGZVHSbrwa4E2YBMpArMUNNTK3lsDAJpdJICFX6uXOk34Fh
aqz58KMrcDQxfTc6yFNyYaAJMjqD3g9mtyDzdZ14+vCY/OZfomiCgCAFQodg8a0p
XzvLDncNWJlmHKTKXbcnfl0yhCnDVe20c4GaSgMncOTAS0Gq1VVia+UiD9C6qzyS
F/kyhs2HrRNveSh1bNDOd0c6BVBdxvOiuC9+0a7eJ2BpG9RLhjxn0nC66WEqU8u0
ZISuWemziQpkqDLnm7dEvOW/K8GWN4JOdKafF5jaQWwfIiuXlF4iOUUTljkAZ9Yz
hiFGA8HZcyqEOmxHIlT3q7p7ErHzY15wkIRTn4z47VJ2slF9qDHI5jxxXVDVT7cb
pkua32UTtx62j3dB/FnrRo4630Bsbu+GDNRB4WQZS+Qw6s59A6bbP5H7YqX81gFv
WsBVm6HGrKSu3KF4z1IPoOQVh7tCfHjgyEMYNsMh4U7QCIQdBFBRJof3nGc8HC0T
NhyZigIfNV1cMKGzawBI7dp5Zc0VvIEY2ynPnkvDsyxloKmgVjMfM97Mi8RDjrZz
VUjQrh9Ss4NieacsYMvy1crG+PneNclMxwSMno+NFbaOpfTT5ej2JbB2xFbtsrfm
NcMypcxskaQYCCeGv7+1zUHtdAnYAoPro0sX8BP7ABEBAAGJAh8EGAEIAAkFAlj+
j0YCGwwACgkQZszCNMLOswZrxhAArx50C20PVFGxpeTGVrfOr4u7VlESX8mjIeMU
LFxOnY9q61qqhYZQHzQOVQa3Sair3aGBKyM4dXTXuq1T2DioHjOWiA+GOooQ+7hg
7vi7zenU0oa0D3b1PVeTC+uiAizl8Zvj+LT4wv9D5/WfQhUnvO8sZ3Ng1uxbjXn9
ne/DKIEb4cJaKoPGkj3LXSDiSliWV4TEzcimqWHD8qxnVVJyfM3qxNx05i9kFCxs
R+sP+BFfqmSlfFMr9u39NoqNSG/wcrWmnMvAcsddh10gGqXPBJgS5LfPJ+O2x8tp
ee48HEV5xhvdeNito9mMcIVVm8LpovQCMf61GbJMnutwJMqBfShjkPdO6+cp8tAk
Zq0k9wbN2hIIM+dWHSe59fW2BA2oixxmuBhX9EEq/aOzxarqTV9AYXwBdIXPQEmo
U/kK2ok+VyEyUeyj+6go4K8ihoJPSZgSrkjRmf3VLAz17r591C+6qMGLD8BxQ28y
NTgTdl+odL09GMSdgWMiuFBWDYyepdXWN2pPkvV6zoS/5iHbT9ZbASv9B373pRFG
QWXuO7LIk6vfOJHkGB+6WrmFOj4aO937udKbUlrOQNiPqUtXMO49j3oQjIl4mO2p
nJXfPcUDikAQK10/36sBRYxFSfHjywboeqkt4uvB7vyxcUXPe+m+hfCxwekHeLPs
4XGgPNk=
=1yJL
-----END PGP PUBLIC KEY BLOCK-----
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment