mirror of
https://github.com/Crazy-Crew/CrazyAuctions.git
synced 2025-02-17 01:52:27 +01:00
[ci-skip] Update README.md
Signed-off-by: Ryder Belserion <no-reply@ryderbelserion.com>
This commit is contained in:
parent
faf53d4941
commit
7aa461bc5b
127
README.md
127
README.md
@ -1,91 +1,66 @@
|
||||
<br />
|
||||
<center><div align="center">
|
||||
|
||||
<div align="center">
|
||||
|
||||
[![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)
|
||||
<big>**Auction off your items in style!**</big>
|
||||
|
||||
<p align="center">
|
||||
A crates plugin that offers quality crates with ease!
|
||||
<br />
|
||||
<a href="https://docs.crazycrew.us/crazyauctions/home"><strong>Explore the docs »</strong></a>
|
||||
<br />
|
||||
<br />
|
||||
<a href="https://github.com/Crazy-Crew/CrazyAuctions/issues/new?assignees=ryderbelserion&labels=bug&projects=&template=bugs.yml&title=%5BBug+Report%5D%3A+">Report Bug</a>
|
||||
·
|
||||
<a href="https://github.com/Crazy-Crew/CrazyAuctions/issues/new?assignees=&labels=feature&template=feature_request.md&title=%5BFeature%5D+">Request Feature</a>
|
||||
·
|
||||
<a href="https://discord.gg/badbones-s-live-chat-182615261403283459">Get Support</a>
|
||||
</p>
|
||||
</div>
|
||||
### **Quick Links**
|
||||
[Request Features](https://github.com/Crazy-Crew/CrazyAuctions/issues)<br>
|
||||
[Documentation](https://docs.crazycrew.us/docs/category/crazyauctions)<br>
|
||||
[Developer API](https://docs.crazycrew.us/docs/plugins/crazyauctions/guides/api/intro)<br>
|
||||
[Report Bugs](https://github.com/Crazy-Crew/CrazyAuctions/issues)<br>
|
||||
[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`<br>
|
||||
|
||||
[![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.**<br>
|
||||
**Easy to use configurations.**<br>
|
||||
**Max/min bidding/buying.**<br>
|
||||
**Customizable category selector.**<br>
|
||||
**Blacklist items you don't want to be auctioned off.**<br>
|
||||
**Cancel auctions & retrieve the item afterwards.**<br>
|
||||
**And much more!**<br>
|
||||
|
||||
![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!<br>
|
||||
Please head to [crazy-auctions](https://discord.com/channels/182615261403283459/1178545378564509786) with your question and do not cross post.<br>
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<details>
|
||||
<summary>Table of Contents</summary>
|
||||
<ol>
|
||||
<li>
|
||||
<a href="#getting-started">Getting Started</a>
|
||||
<ul>
|
||||
<li><a href="#prerequisites">Prerequisites</a></li>
|
||||
<li><a href="#installation">Installation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#roadmap">Roadmap</a></li>
|
||||
<li><a href="#contributing">Contributing</a></li>
|
||||
<li><a href="#license">License</a></li>
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
</ol>
|
||||
<summary>Support Checklist</summary>
|
||||
|
||||
Please check to make sure that your question wasn't asked before, You can use `Ctrl+F` on Discord to look for past conversations.<br>
|
||||
Describe your issue in detail, Don't just make it a bread crumb trail that has to be questioned out of you.<br>
|
||||
Plugin Version i.e. `CrazyAuctions 3.3` **LATEST DOES NOT COUNT**<br>
|
||||
Server Version & Server Type i.e. `Paper 1.21.1` or `Purpur 1.21.1` **LATEST DOES NOT COUNT**<br>
|
||||
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.)<br>
|
||||
|
||||
</details>
|
||||
|
||||
### 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](https://discord.com/api/guilds/182615261403283459/widget.png?style=banner2)](https://discord.gg/badbones-s-live-chat-182615261403283459)<br>-->
|
||||
[![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)
|
||||
</div>
|
||||
|
||||
## Getting Started
|
||||
How to get started with contributing / maintaining your own version of CrazyAuctions!
|
||||
![CrazyAuctions Statistics](https://bstats.org/signatures/bukkit/CrazyAuctions.svg)
|
||||
</center>
|
||||
|
||||
### 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
|
||||
[license-url]: https://github.com/Crazy-Crew/CrazyAuctions/blob/main/LICENSE
|
||||
|
Loading…
Reference in New Issue
Block a user