Update README.MD

Updated to new style.
Made the version badge update automatically.
This commit is contained in:
MysteriousKyle 2021-01-17 09:23:06 -06:00 committed by GitHub
parent 206c0bb835
commit de70a6df3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

111
README.MD
View File

@ -7,8 +7,7 @@
<p align="center"> <p align="center">
<b> <b>
Connect hoppers over long distances with the added ability to filter out unwanted items, Connect hoppers over long distances with the added ability to filter out unwanted items, auto break blocks, auto sell items and much more. Perfect for SkyBlock servers.
auto break blocks, auto sell items and much more. Perfect for SkyBlock servers.
</b> </b>
</p> </p>
@ -20,7 +19,7 @@
<img alt="Patreon" src="https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white"> <img alt="Patreon" src="https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white">
</a> </a>
<br> <br>
<img alt="Latest" src="https://img.shields.io/badge/-ver_4.6.15-4078C0.svg?logo=github&style=flat&logoColor=white&color=blue&label=Latest&labelColor=black"> <img alt="Latest" src="https://img.shields.io/badge/dynamic/xml?label=version&query=string%28%2F%2F%2A%5Blocal-name%28.%29%3D%27version%27%20and%20namespace-uri%28.%29%3D%27http%3A%2F%2Fmaven.apache.org%2FPOM%2F4.0.0%27%5D%5B1%5D%29&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsongoda%2FEpicHoppers%2Fmaster%2Fpom.xml&logo=github&style=flat&logoColor=white&color=blue&labelColor=black">
<a href="https://app.codacy.com/gh/songoda/EpicHoppers/dashboard"> <a href="https://app.codacy.com/gh/songoda/EpicHoppers/dashboard">
<img alt="quality" src="https://img.shields.io/codacy/grade/96f244144f20443b9a30e02f70e5e7b0"> <img alt="quality" src="https://img.shields.io/codacy/grade/96f244144f20443b9a30e02f70e5e7b0">
</a> </a>
@ -29,50 +28,70 @@
<a href="https://bstats.org/plugin/bukkit/EpicHoppers/4185"> <a href="https://bstats.org/plugin/bukkit/EpicHoppers/4185">
<img alt="Servers" src="https://img.shields.io/bstats/servers/4185"> <img alt="Servers" src="https://img.shields.io/bstats/servers/4185">
</a> </a>
<img alt="Maintained" src="https://img.shields.io/maintenance/yes/2020"> <img alt="Maintained" src="https://img.shields.io/maintenance/yes/2021">
</p> </p>
## Table of Contents <h2>Table of Contents</h2>
<ul>
<li><a href='#Introduction'>Introduction</a></li>
<li><a href='#Marketplace'>Marketplace</a></li>
<li><a href='#Showcase'>Showcase</a></li>
<li><a href='#Documentation'>Documentation</a></li>
<li><a href='#Support'>Support</a></li>
<li><a href='#Suggestions'>Suggestions</a></li>
</ul>
* [Introduction](#introduction) <article>
* [Marketplace](#marketplace) <h2 id="Introduction">Introduction</h2>
* [Documentation](#documentation) <p>
* [Support](#support) EpicHoppers is a powerful hopper plugin that completely revolutionizes the way in which hoppers work. The plugin allows you to increase the speed at which items are transferred through hoppers, the amount of items that are transferred per tick, allows you to wirelessly connect EpicHoppers to chests or other hoppers which decreases the amount of hoppers needed, offers a filter system GUI that allows you to transfer, block or delete the items you want without needing to set up complicated filter systems with multiple hoppers, allows you to teleport between hoppers as an easy transportation system around your base, allows you to automatically craft resources such as ingots and minerals into their respective blocks (among other things that can be crafted) before sending them into a storage chest, allows you to automatically smelt ores into ingots before storing it or transferring it into another hopper, allows you to customize the range at which hoppers will pickup items around it, allows you to use hoppers to automatically break and transport blocks from generators which leaves you with more time to do other stuff, allows you to autosell items in hoppers so you don't run out of storage containers in your base, and allows you to set up mob hoppers which will automatically kill mobs that come into range of the hopper.<br>
* [Suggestions](#suggestions) Each of these options can be individually managed for each hopper through the EpicHoppers GUI, and server owners are able to customize which features they want players to have access to, and lock features behind EpicHopper level restrictions to make it a progressive grind for players to unlock all the powerful capabilities of EpicHoppers.
</p>
</article>
<hr>
<article>
<h2 id="Marketplace">Marketplace</h2>
<p>
You can visit our marketplace to <a href="https://songoda.com/marketplace/product/epichoppers-better-stronger-faster-hoppers.15">download EpicHoppers</a> to use on your server.<br>
You can browse all the plugins made by the <a href="https://songoda.com/teams/songoda">Songoda team</a> both free and premium.<br>
You can also visit <a href="https://songoda.com/marketplace">our marketplace</a> to browse the many other fantastic plugins available there, both well-known and newly made plugins that are sure to catch your eye.
</p>
</article>
<hr>
<article>
<h2 id="Showcase">Showcase</h2>
<p>
For a quick visual introduction into the main features of the plugin and how it works, feel free to watch the showcase video below.
<details>
<summary>Showcase Video</summary>
Coming Soon
</details>
</p>
</article>
<hr>
<article>
<h2 id="Documentation">Documentation</h2>
<p>
You can find all the information about the plugin, including dependencies,
commands, permissions, incompatible plugins on the <a href="https://wiki.songoda.com/Epic_Hopperss">EpicHoppers wiki page<a>.
Feel free to also contribute to the wiki as a way to help others in the community with using the plugin, or request for something to be added in our <a href="https://discord.gg/6JwbEQB">wiki discord</a>.
</p>
</article>
<hr>
<article>
<h2 id="Support">Support</h2>
<p>
If you have any quick questions about using the plugin or how a feature works, feel free to join <a href="https://discord.gg/songoda">our main discord</a> and ask in the questions channels. If you encounter any issues or find a bug while using the plugin, feel free to create a ticket on <a href="https://support.songoda.com">our support desk</a> and one of our support stafff will assist you as soon as they are available.
</p>
</article>
<hr>
<article>
<h2 id="Suggestions">Suggestions</h2>
<p>
For suggestions about features you think should be added to the plugin to increase its functionality, feel free to create a thread or upvote an existing thread over on <a href="https://feedback.songoda.com">our feedback site</a> and it might be chosen to be added into a future update of the plugin when one of our developers are looking for new features to add to the plugin.
</p>
</article>
## Introduction <p align="center">
EpicHoppers is a powerful hopper plugin that completely revolutionizes the way in which hoppers work. &copy;Songoda 2021
The plugin allows you to increase the speed at which items are transferred through hoppers, </p>
the amount of items that are transferred per tick,
allows you to wirelessly connect EpicHoppers to chests or other hoppers which decreases the amount of hoppers needed,
offers a filter system GUI that allows you to transfer, block or delete the items you want
without needing to set up complicated filter systems with multiple hoppers,
allows you to teleport between hoppers as an easy transportation system around your base,
allows you to automatically craft resources such as ingots and minerals into their respective blocks
(among other things that can be crafted) before sending them into a storage chest,
allows you to automatically smelt ores into ingots before storing it or transferring it into another hopper,
allows you to customize the range at which hoppers will pickup items around it,
allows you to use hoppers to automatically break and transport blocks from generators which leaves you with more time to do other stuff,
allows you to autosell items in hoppers so you don't run out of storage containers in your base,
and allows you to set up mob hoppers which will automatically kill mobs that come into range of the hopper.
Each of these options can be individually managed for each hopper through the EpicHoppers GUI,
and server owners are able to customize which features they want players to have access to,
and lock features behind EpicHopper level restrictions to make it a progressive grind for players to unlock all the powerful capabilities of EpicHoppers.
## Marketplace
You can visit [our marketplace](https://songoda.com/marketplace/product/epichoppers-better-stronger-faster-hoppers.15)
to download EpicHoppers as well as take a look at many other fantastic plugins which are sure to catch your eye.
## Documentation
You can find all the information about the plugin, including dependencies,
commands, permissions, incompatible plugins on [our wiki](https://wiki.songoda.com/Epic_Hoppers).
Feel free to also contribute to the wiki as a way to help others in the community with using the plugin.
## Support
If you encounter any issues while using the plugin,
feel free to create a ticket on [our support desk](https://support.songoda.com).
## Suggestions
For suggestions about features you think should be added to the plugin to increase its functionality,
feel free to create a thread over on [our feedback site](https://feedback.songoda.com).