CrazyAuctions/README.md

112 lines
4.3 KiB
Markdown
Raw Normal View History

2022-10-11 22:45:15 +02:00
<br />
2020-02-26 19:06:56 +01:00
2023-02-06 04:47:15 +01:00
[![CrazyAuctions]([![crazyauctions](https://raw.githubusercontent.com/RyderBelserion/Assets/main/crazycrew/new/crazyauctions/Banner.png)](https://modrinth.com/plugin/crazyauctions)
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
<div align="center">
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
[![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]
2022-07-08 02:10:11 +02:00
2023-01-07 08:27:10 +01:00
![Spigot](https://cdn.jsdelivr.net/gh/intergrav/devins-badges/assets/compact/unsupported/spigot_vector.svg)
![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)
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
<p align="center">
2023-01-07 08:27:10 +01:00
A crates plugin that offers quality crates with ease!
2022-10-11 22:45:15 +02:00
<br />
<a href="https://github.com/Crazy-Crew/CrazyAuctions/wiki"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/Crazy-Crew/CrazyAuctions/issues">Report Bug</a>
·
2023-02-06 04:47:15 +01:00
<a href="https://github.com/orgs/Crazy-Crew/discussions/categories/features?discussions_q=label%3Acrazyauctions+category%3AFeatures">Request Feature</a>
2022-10-11 22:45:15 +02:00
·
2023-02-06 04:47:15 +01:00
<a href="https://github.com/orgs/Crazy-Crew/discussions/categories/support?discussions_q=label%3Acrazyauctions+category%3ASupport">Get Support</a>
2022-10-11 22:45:15 +02:00
</p>
</div>
<!-- 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>
</details>
2022-07-08 02:10:11 +02:00
## Downloads
2023-02-06 04:47:15 +01:00
> https://modrinth.com/plugin/crazyauctions
2022-10-11 22:45:15 +02:00
2023-02-06 04:47:15 +01:00
## Beta Builds
2023-01-07 08:27:10 +01:00
### Get the latest changes before marked as release.
2023-02-06 04:47:15 +01:00
All beta builds will be on Modrinth.<br>
> https://modrinth.com/plugin/crazyauctions/versions
2022-10-11 22:45:15 +02:00
## Getting Started
How to get started with contributing / maintaining your own version of CrazyAuctions!
### Prerequisites
A list of things necessary to make sure you can build CrazyAuctions properly.
* Intellij IDEA
2023-01-07 08:27:10 +01:00
* > https://www.jetbrains.com/idea/download/
2022-10-11 22:45:15 +02:00
* 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 shadowJar task.
```gradle
2023-01-07 08:27:10 +01:00
./gradlew shadowJar
2022-10-11 22:45:15 +02:00
```
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
## Roadmap
2022-07-08 02:10:11 +02:00
2023-02-06 04:47:15 +01:00
Check our public [trello board](https://trello.com/b/CcPYmsBt) for our current plans, any bugs and general tracking of the project progress.
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
## Contributing
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
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`)
2023-02-06 04:47:15 +01:00
5. Open a Pull Request to the dev branch to add your feature/fix.
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
## License
2022-07-08 02:10:11 +02:00
2022-10-11 22:45:15 +02:00
Distributed under the MIT License. See [`LICENSE`](/LICENSE) for more information.
2022-07-08 02:10:11 +02:00
2023-01-07 08:27:10 +01:00
[discord-shield]: https://img.shields.io/discord/182615261403283459.svg?style=flat&logo=appveyor
2022-10-11 22:45:15 +02:00
[discord-url]: https://discord.gg/crazycrew
2022-07-08 02:10:11 +02:00
2023-01-07 08:27:10 +01:00
[contributors-shield]: https://img.shields.io/github/contributors/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
2022-10-11 22:45:15 +02:00
[contributors-url]: https://github.com/Crazy-Crew/CrazyAuctions/graphs/contributors
2023-01-07 08:27:10 +01:00
[forks-shield]: https://img.shields.io/github/forks/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
2022-10-11 22:45:15 +02:00
[forks-url]: https://github.com/Crazy-Crew/CrazyAuctions/network/members
2023-01-07 08:27:10 +01:00
[stars-shield]: https://img.shields.io/github/stars/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
2022-10-11 22:45:15 +02:00
[stars-url]: https://github.com/Crazy-Crew/CrazyAuctions/stargazers
2023-01-07 08:27:10 +01:00
[issues-shield]: https://img.shields.io/github/issues/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
2022-10-11 22:45:15 +02:00
[issues-url]: https://github.com/Crazy-Crew/CrazyAuctions/issues
2023-01-07 08:27:10 +01:00
[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
2022-07-08 02:10:11 +02:00
2023-01-07 08:27:10 +01:00
[codefactor-shield]: https://img.shields.io/codefactor/grade/github/crazy-crew/CrazyAuctions/main?style=flat&logo=appveyor