Improve and update readme and issue templates

This commit is contained in:
Phoenix616 2024-12-17 16:12:41 +01:00
parent 7c2edc93a4
commit 1e40caa64a
No known key found for this signature in database
GPG Key ID: 40E2321E71738EB0
5 changed files with 49 additions and 22 deletions

View File

@ -1,6 +1,6 @@
name: Bug report
description: Report an error that happens in the plugin.
labels: []
labels: ["unconfirmed bug"]
body:
- type: markdown
attributes:
@ -28,6 +28,14 @@ body:
description: The full plugin version that you are running from `/version ChestShop`
validations:
required: true
- type: checkboxes
attributes:
label: Version Check
description: Please make sure your specified version meets the following. If it doesn't then your issue can most likely be resolved by updating.
options:
- label: It is the latest development version available from https://ci.minebench.de/job/ChestShop-3/.
- label: The version [has support](https://github.com/ChestShop-authors/ChestShop-3/security/policy#supported-versions) for this type of issue.
required: true
- type: textarea
attributes:
label: Plugin Config
@ -37,7 +45,7 @@ body:
<summary>Config</summary>
```yaml
[Put the config here]
PUT THE CONFIG HERE, DO NOT REPLACE THE WHOLE TEXT!
```
</details>
@ -59,7 +67,7 @@ body:
<summary>Log</summary>
```
[Your log here]
PUT YOUR LOG HERE, DO NOT REPLACE THE WHOLE TEXT!
```
</details>
@ -78,9 +86,7 @@ body:
description: Please agree to the following.
options:
- label: I have checked if there are already similar issues open.
- label: I am running the latest development version available from https://ci.minebench.de/job/ChestShop-3/.
- label: The version [has support](https://github.com/ChestShop-authors/ChestShop-3/security/policy#supported-versions) for this type of issue.
- label: I have provided all requested information and agree to the terms of the [project's license](https://github.com/ChestShop-authors/ChestShop-3/blob/master/LICENSE)
- label: I have provided all requested information and agree to the terms of the [project's license](https://github.com/ChestShop-authors/ChestShop-3/blob/master/LICENSE), especially the part about no warranty.
required: true
- type: textarea

View File

@ -1,7 +1,10 @@
blank_issues_enabled: false
contact_links:
- name: "#chestshop IRC channel on irc.spi.gt"
url: "https://kiwiirc.com/client/irc.spi.gt/#chestshop"
- name: "#chestshop IRC channel on ircesper.net"
url: "https://kiwiirc.com/client/irc.esper.net/#chestshop"
about: Live chat with the devs and other members of the community
- name: "ChestShop channel on Phoenix616's Discord"
url: "https://discord.gg/FuTujm6Egd"
about: Live chat with the devs and other members of the community
- name: SpigotMC discussion thread
url: https://www.spigotmc.org/threads/chestshop.295890/

View File

@ -34,7 +34,7 @@ body:
options:
- label: I have checked if there are already similar issues open.
required: true
- label: I have checked that the latest build doesn't already implement the feature.
- label: I have checked that the [latest build](https://ci.minebench.de/job/ChestShop-3/) doesn't already implement the feature.
required: true
- type: textarea

View File

@ -1,18 +1,38 @@
ChestShop
<img src="/assets/ChestShop_mini.png" alt="ChestShop icon" height="32px"> ChestShop
================================
Development downloads can be found here: [https://ci.minebench.de/job/ChestShop-3/](https://ci.minebench.de/job/ChestShop-3/)
![Created At](https://img.shields.io/github/created-at/ChestShop-authors/ChestShop-3)
[![ChestShop license: LGPL-2.1](https://img.shields.io/github/license/ChestShop-authors/ChestShop-3)](LICENSE) [![](https://badges.crowdin.net/chestshop-3/localized.svg)](https://crowdin.com/project/chestshop-3/)
[![Latest Release](https://img.shields.io/github/v/release/ChestShop-authors/ChestShop-3)](https://github.com/ChestShop-authors/ChestShop-3/releases/latest)
[![Commits since latest release](https://img.shields.io/github/commits-since/ChestShop-authors/ChestShop-3/latest?color=red)](https://github.com/ChestShop-authors/ChestShop-3/commits/master/) [![bStats Server Count](https://img.shields.io/bstats/servers/1109.svg) ![bStats Player Count](https://img.shields.io/bstats/players/1109.svg)](https://bstats.org/plugin/bukkit/ChestShop)
ChestShop is an awesome plugin for managing your server's economy.
By using chests and signs, you can effectively create your own market!
ChestShop also makes admininstators' lives easier.
Simply drag-and-drop the .jar to your "plugins" folder and you're done!
ChestShop also makes administrators' lives easier.
Simply drag-and-drop the .jar to your "plugins" folder, install [Vault](http://dev.bukkit.org/server-mods/vault/) or [Reserve](https://www.spigotmc.org/resources/reserve.50739/) and a [compatible Economy plugin](https://www.spigotmc.org/wiki/chestshop-economy-plugins/) which provides money, and you're done!
If you need any help - just ask. There is a ticket system, in which you can report bugs, suggest improvements and more.
Don't be fooled though - you might think that your ticket disappeared, however that's not the case.
You should configure the system to show **"All tickets"**, instead of only **"All open"** - you can do that by clicking on the "Filters".
It's never been that easy to create shops! With features like shop protection and anti-lag protection, you won't have to worry about your server's economy anymore! It even is [compatible](https://dev.bukkit.org/projects/chestshop/#:~:text=Compatibility,provide%20additional%20functionality%3A) with a good chunk of other plugins and there is an ever-growing list of [addon plugins](https://dev.bukkit.org/projects/chestshop/#:~:text=Additional%20modules%20for%20ChestShop%3A) to add even more compatibility and features!
If you need any help check the wiki or just ask in IRC or Discord!
Helpful Links
--------------------------------
* [Wiki](https://www.spigotmc.org/wiki/chestshop-3/)
* [List of known compatible Economy plugins](https://www.spigotmc.org/wiki/chestshop-economy-plugins/)
* [IRC channel](https://kiwiirc.com/client/irc.esper.net/#chestshop): `#chestshop` on `irc.esper.net`
* [ChestShop channel](https://discord.gg/FuTujm6Egd) in Phoenix616's Discord
* [Latest Dev Build](https://ci.minebench.de/job/ChestShop-3/) ![](https://img.shields.io/github/commits-since/ChestShop-authors/ChestShop-3/latest?color=red)
* [Build for 1.12](https://ci.minebench.de/view/ChestShop/job/ChestShop-3-1.12/)
* [Build for 1.8.8](https://ci.minebench.de/view/ChestShop/job/ChestShop-3-1.8.8/)
Project Pages
--------------------------------
* [BukkitDev site](http://dev.bukkit.org/projects/chestshop/)
* [Modrinth page](https://modrinth.com/plugin/chestshop)
* [SpigotMC resource](https://www.spigotmc.org/resources/chestshop.51856/)
* [PaperMC's Hangar](https://hangar.papermc.io/ChestShop/ChestShop)
* [Original dbo Thread](http://forums.bukkit.org/threads/4150/)
Building
--------------------------------
@ -23,17 +43,15 @@ To build ChestShop, you'll need a Maven installation.
* [Maven download](http://maven.apache.org/download.cgi)
* Launch `mvn clean install` -- that's it!
Pre-build versions can also be found on the [Jenkins server](https://ci.minebench.de/job/ChestShop-3/).
#### Installing external dependencies
To install external dependencies, place your .jar into the main folder and launch the `install_dependency_to_repo.sh` script - it'll guide you through the process.
To install new external dependencies that aren't available in a maven repo, place your .jar into the main folder and launch the `install_dependency_to_repo.sh` script - it'll guide you through the process.
Links
Development Links
--------------------------------
* [Dev Builds](https://ci.minebench.de/job/ChestShop-3/)
* [Forum Thread](http://forums.bukkit.org/threads/4150/)
* [BukkitDev site](http://dev.bukkit.org/projects/chestshop/)
* [SpigotMC site](https://www.spigotmc.org/resources/chestshop.51856/)
* [Bounties via IssueHunt](https://issuehunt.io/r/ChestShop-authors/ChestShop-3?tab=idle)
* [Localization](https://crowdin.com/project/chestshop-3)
* [Qodana code quality](https://qodana.cloud/projects/zxDG5/)

BIN
assets/ChestShop_mini.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB