Skip to content
This repository has been archived by the owner on Dec 28, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Initial creation of README.md
  • Loading branch information
Jordyrat authored Sep 14, 2024
1 parent 391c959 commit 4903363
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<h1 align="center">Rat-ons</h1>

<div align="center">

[![Made with Kotlin](https://img.shields.io/badge/Made%20With-Kotlin-orange?style=for-the-badge&logo=kotlin&logocolor=white)](https://kotlinlang.org/)
[![Downloads](https://img.shields.io/github/downloads/Jordyrat/Rat-ons/latest/total?style=for-the-badge&logo=github)](https://github.com/Jordyrat/Rat-ons/releases)
</div>

A 1.8.9 Minecraft mod made for Hypixel Skyblock. Rat-ons focuses on trying to reduce your modlist with features considered UAYOR (Use At Your Own Risk).

If you like Rat-ons, please consider Starring!

## Installation
1. **Download** the latest release from [Releases](https://github.com/Jordyrat/Rat-ons/releases) into your mods folder.
2. **Install** the dependencies required for the mod to work, [SkyHanni](https://github.com/hannibal002/SkyHanni/releases) and [NEU](https://github.com/NotEnoughUpdates/NotEnoughUpdates/releases)
3. **Configure** the mod's options with `/rat`.
4. **Enjoy** using the mods features to enhance your gameplay!

## Support
Suggest features and report issues using the **Issues** tab above. We do not current have a discord for support but please feel free to use the **Discussions** tab to talk to other members and ask for support.

### Issues

Please follow the formatting rules below when creating a new issue.

* Start your issue with its type, these include:
- **Feature:** to suggest any new features for the mod.
- **Imporvement:** to suggest ann imporvement to an existing feature.
- **Bug:** to report a bug with the mod.
- **Docs:** to suggest any changes to the mod's documentation.
- **Backend:** to suggest any changes to how the backend code works.

* Explain the issue in its description.
* Include any useful pictures.

### Support

No specific formatting is required in the **Discussions** tab but please ensure to use the appropriate category so that any support isn't missed.

## Contributing

Rat-ons is an open-source mod and is open to contributons from anyone. If you would like to contribute to Rat-ons, please follow the [Contributors Guide](docs/CONTRIBUTING.md), create a feature and make a pull request when you're ready!

0 comments on commit 4903363

Please sign in to comment.