diff --git a/README.md b/README.md index 67a93d5..4d4f4e6 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,66 @@ -
+
-
- -[![CrazyAuctions](https://raw.githubusercontent.com/RyderBelserion/Assets/main/crazycrew/webp/CrazyAuctionsBanner.webp)](https://modrinth.com/plugin/crazyauctions) +![CrazyCrates](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/crazyauctions/banner/webp/banner.webp) [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] -[![GPU License][license-shield]][license-url] -[![Contact][discord-shield]][discord-url] -![CodeFactor][codefactor-shield] +[![MIT License][license-shield]][license-url] +[![CodeFactor](https://www.codefactor.io/repository/github/crazy-crew/crazyauctions/badge)](https://www.codefactor.io/repository/github/crazy-crew/crazyauctions) -![Paper](https://cdn.jsdelivr.net/gh/intergrav/devins-badges/assets/compact/supported/paper_vector.svg) -![Purpur](https://cdn.jsdelivr.net/gh/intergrav/devins-badges/assets/compact/supported/purpur_vector.svg) +**Auction off your items in style!** -

- A crates plugin that offers quality crates with ease! -
- Explore the docs » -
-
- Report Bug - · - Request Feature - · - Get Support -

-
+### **Quick Links** +[Request Features](https://github.com/Crazy-Crew/CrazyAuctions/issues)
+[Documentation](https://docs.crazycrew.us/docs/category/crazyauctions)
+[Developer API](https://docs.crazycrew.us/docs/plugins/crazyauctions/guides/api/intro)
+[Report Bugs](https://github.com/Crazy-Crew/CrazyAuctions/issues)
+[Trello Board](https://trello.com/b/B9exh23d/crazyauctions) + +### Supported Platforms +[![paper software](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/paper_vector.svg)](https://papermc.io/) +[![purpur software](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/purpur_vector.svg)](https://purpurmc.org/) + +### **Initial Plugin Setup** +CrazyAuctions as first install will come with a set of default files such as `config.yml`, `messages.yml` +You can simply edit these files, and configure the looks and settings then do `/crazyauctions reload`
+ +[![Partnered with ApexHosting](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/apex-banner-transparent.webp)](https://billing.apexminecrafthosting.com/aff.php?aff=5511) + +![Features Banner](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/crazyauctions/banner/webp/features.webp) + +**Selling/buying/bidding items with ease.**
+**Easy to use configurations.**
+**Max/min bidding/buying.**
+**Customizable category selector.**
+**Blacklist items you don't want to be auctioned off.**
+**Cancel auctions & retrieve the item afterwards.**
+**And much more!**
+ +![Support Banner](https://raw.githubusercontent.com/Crazy-Crew/Branding/main/crazyauctions/banner/webp/support.webp) + +Are you confused about something? Hop by the Discord and you might just get an answer!
+Please head to [crazy-auctions](https://discord.com/channels/182615261403283459/1178545378564509786) with your question and do not cross post.
-
- Table of Contents -
    -
  1. - Getting Started - -
  2. -
  3. Roadmap
  4. -
  5. Contributing
  6. -
  7. License
  8. -
  9. Contact
  10. -
+Support Checklist + +Please check to make sure that your question wasn't asked before, You can use `Ctrl+F` on Discord to look for past conversations.
+Describe your issue in detail, Don't just make it a bread crumb trail that has to be questioned out of you.
+Plugin Version i.e. `CrazyAuctions 3.3` **LATEST DOES NOT COUNT**
+Server Version & Server Type i.e. `Paper 1.21.1` or `Purpur 1.21.1` **LATEST DOES NOT COUNT**
+Send any console errors or files you have through https://mclo.gs/ - (We don't own the website, You have to copy the link and send it.)
+
-### Resource Page -[![Hangar](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/compact/available/hangar_46h.png)](https://hangar.papermc.io/CrazyCrew/CrazyAuctions) -[![Modrinth](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/compact/available/modrinth_46h.png)](https://modrinth.com/user/plugin/CrazyAuctions) + +[![Discord Invite Button](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/badbones-s-live-chat-182615261403283459) +
-## Getting Started -How to get started with contributing / maintaining your own version of CrazyAuctions! +![CrazyAuctions Statistics](https://bstats.org/signatures/bukkit/CrazyAuctions.svg) +
-### Prerequisites -A list of things necessary to make sure you can build CrazyAuctions properly. -* Intellij IDEA - * > https://www.jetbrains.com/idea/download/ -* Gradle - -### Installation -1. Clone the repo - ```sh - git clone https://github.com/Crazy-Crew/CrazyAuctions.git - ``` -2. Open the repository using Intellij IDEA & wait until it finishes downloading/indexing. -3. Run the clean assemble task. - ```gradle - ./gradlew clean assemble - ``` - -## Roadmap -Check our public [trello board](https://trello.com/b/bzQ5TwXo) for our current plans, any bugs and general tracking of the project progress. - -## Contributing -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/yourfeature`) -3. Commit your Changes (`git commit -m 'your amazing feature.'`) -4. Push to the Branch (`git push`) -5. Open a Pull Request to the `main` branch to add your feature/fix. - -## License -Distributed under the MIT License. See [`LICENSE`](/LICENSE) for more information. - -[discord-shield]: https://img.shields.io/discord/182615261403283459.svg?style=flat&logo=appveyor -[discord-url]: https://discord.gg/badbones-s-live-chat-182615261403283459 [contributors-shield]: https://img.shields.io/github/contributors/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor [contributors-url]: https://github.com/Crazy-Crew/CrazyAuctions/graphs/contributors @@ -96,6 +71,4 @@ Distributed under the MIT License. See [`LICENSE`](/LICENSE) for more informatio [issues-shield]: https://img.shields.io/github/issues/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor [issues-url]: https://github.com/Crazy-Crew/CrazyAuctions/issues [license-shield]: https://img.shields.io/github/license/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor -[license-url]: https://github.com/Crazy-Crew/CrazyAuctions/blob/master/LICENSE - -[codefactor-shield]: https://img.shields.io/codefactor/grade/github/crazy-crew/CrazyAuctions/main?style=flat&logo=appveyor \ No newline at end of file +[license-url]: https://github.com/Crazy-Crew/CrazyAuctions/blob/main/LICENSE