Skip to content

Commit

Permalink
Merge pull request #5 from Deftu/patch-1
Browse files Browse the repository at this point in the history
Improve README grammar and internal syntax.
  • Loading branch information
DeDiamondPro authored Oct 18, 2022
2 parents a17daea + 1522efb commit 868d50d
Showing 1 changed file with 26 additions and 20 deletions.
46 changes: 26 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
# SkyGuide
<div align="center">

# `SkyGuide`
A mod that aims to improve the Hypixel SkyBlock experience in a vanilla-like way.

</div>

SkyGuide is a mod that aims to improve the skyblock experience in a vanilla-like way.

## Current Features

Map of skyblock, including portals and npcs *(not available on all islands since some renders aren't done yet)*
## Current features
Map of SkyBlock, including portals and NPCs. *(not available on all islands since some renders aren't done yet)*

![Image of map](https://i.dediamondpro.dev/HewzvqHG.png)

Customizable Mini-Map *(not available on all islands since some renders aren't done yet)*
Customizable Mini-Map. *(not available on all islands since some renders aren't done yet)*

![Image of mini-map](https://i.dediamondpro.dev/3oUBsq8F.png)

Intelligent waypoint system that can guide you to portals in order to get to your destination or warp to the nearest
warp.

## FAQ
## FaQ

<details>
<summary>Where can I get support?</summary>
<br>
<strong>You can get support in our <a href="https://discord.gg/XtAuqsJWby">Discord</a>.</strong>
<summary>Where can I get support?</summary>

**Support is available in our [Discord server](https://discord.gg/XtAuqsJWby).**

</details>

<details>
<summary>Is SkyGuide bannable?</summary>
<br>
<strong>No</strong>, I do not believe it is bannable but as any mod it is use at your own risk.
<summary>Is SkyGuide bannable on Hypixel?</summary>

**No**, it should not be bannable in it's current state. __Though with all mods, it is and always will be "use at your own risk"!__

</details>

<details>
<summary>Is the Mini-Map against Hypixel's rules?</summary>
<br>
<summary>Is the Mini-Map against Hypixel's rules/bannable?</summary>

Due to Hypixel's vague rules regarding client modifications it is hard to say for certain and this mod stays use at your
own risk but <strong>I do not believe the mini-map is against the rules</strong>, here is my reasoning:
own risk but **I do not believe the mini-map is against the rules**, here is my reasoning:

The mini-maps Hypixel is saying are not allowed take their data straight from the world and display it on your HUD,
while SkyGuide's mini-map uses pre-rendered images. This is important because Hypixel states the following in their rules:
> a general rule of thumb is that any modification which provides any significant advantage to the players in any of our games - even if not in the specific game you are playing - using them anywhere on our server will be against our rules.
So a normal mini-map doesn't provide an unfair advantage in skyblock, but it does in some pvp games, especially if it
So a normal mini-map doesn't provide an unfair advantage in SkyBlock, but it does in some pvp games, especially if it
has an entity radar. SkyGuide's mini-map uses pre rendered images and hence doesn't work in any games other than
skyblock. So SkyGuide's mini-map cannot provide an unfair advantage anywhere on the Hypixel network.
SkyBlock. So SkyGuide's mini-map cannot provide an unfair advantage anywhere on the Hypixel network.

</details>

## Dev stuff
Expand All @@ -59,7 +65,7 @@ this size should be inputted in the scene tab depending on the texture quality.

Now enable transparent sky and set the SPP to 250 (this is plenty for our purpose and speeds up rendering)

#### For multilayered images
#### For multi-layered images

- Reduce Y-max clip until you have the layer you want
- In the json set the value before the image to the Y-max clip

0 comments on commit 868d50d

Please sign in to comment.