aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 3c7721cfb1760bf0fd3873d8ecc8b563c0b4d06d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<h1 align="center">
  SkyHanni: Mod for Hypixel SkyBlock
</h1>


<div align="center">

![sh_logo](https://github.com/hannibal002/SkyHanni/assets/24389977/2f52afa0-0330-434e-ba1c-f2affee96bc1)

[![Discord](https://img.shields.io/discord/997079228510117908?label=discord&color=9089DA&logo=discord&style=for-the-badge)](https://discord.gg/skyhanni-997079228510117908)
[![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/hannibal002/SkyHanni/total?label=downloads&color=208a19&logo=github&style=for-the-badge)](https://github.com/hannibal002/SkyHanni/releases)
</div>

## What it does

SkyHanni is a Forge mod for Minecraft 1.8.9 that adds many useful features to [Hypixel SkyBlock](https://wiki.hypixel.net/Main_Page). With SkyHanni you have access to:

* **Helpful GUIs:** View important information at a glance.
* **Extra Chat Messages:** Receive reminders and tips at the right moment.
* **Object Highlighters:** Focus on important items in inventories or highlight mobs in the world.
* **Highly Customizable Displays:** Personalise your Scoreboard, Tab List or chat format.
* [And **much** more!](docs/FEATURES.md)

SkyHanni is especially useful when doing farming, slayers, Bingo, Diana, fishing, Rift or mining.

## Getting Started

1. **Install:**  Follow the [installation guide](docs/INSTALLING.md).
2. **Set Up:** Type `/sh` or `/skyhanni` in-game to configure your settings.
3. **Explore:** See all the features [here](docs/FEATURES.md).

## Discord & Support

Give feedback or just chat with others on our community Discord!

* **Bug Reports:** Use the `#bug-reports` channel when you find broken features (please check out `#faq` and `#known-bugs`).
* **Quick Help** Ask in `#support` for questions and problems with the mod or Minecraft in general.
* **Feature Suggestions:** Feel fre to tell your ideas in `#suggestions` channel for new features and improvements to the mod. (Don't copy from existing mods or break Hypixel rules).
* **General Chat:** Chat with other SkyHanni users in `#skyblock-general` channel about the game.

**[Join the Discord!](https://discord.gg/skyhanni-997079228510117908)**

## Contributing

Are you interested in writing your own SkyHanni feature? Do you want to fix that one annoying bug yourself? Check out our [contributing guide](CONTRIBUTING.md) for more information!

---

**SkyHanni is part of an active modding community. Explore other useful mods [here](https://sbmw.ca/mod-lists/skyblock-mod-list/) for even more SkyBlock features!**