https://github.com/dediamondpro/skyguide

https://github.com/dediamondpro/skyguide

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/dediamondpro/skyguide
• Owner: DeDiamondPro
• License: gpl-3.0
• Created: 2022-08-17T11:51:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-02T13:56:15.000Z (over 1 year ago)
• Last Synced: 2023-08-02T14:06:42.617Z (over 1 year ago)
• Language: Kotlin
• Homepage: https://dediamondpro.dev
• Size: 282 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

# `SkyGuide`

A mod that aims to improve the Hypixel 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)*

![map](https://user-images.githubusercontent.com/67508414/215343618-6c0f6818-df33-4d21-a63d-1927f8e4ec4d.png)

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

![mini-map](https://user-images.githubusercontent.com/67508414/215343639-fd39c6f8-244f-469c-857a-72816dda9815.png)

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

warp.

[](https://bisecthosting.com/diamond)

## FaQ

    Where can I get support?

  

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

    Is SkyGuide bannable on Hypixel?

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

    Is the Mini-Map against Hypixel's rules/bannable?

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 **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 

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.

## License

SkyGuide is licensed under LGPL unless explicitly noted.

All of SkyGuide's images in the `data` subdirectory are licensed under CC-BY-NC-SA-4.0

## Dev stuff

#### How to render images

Images are rendered using chunky

In chunky make a scene of all chunks of an island and position the camera accordingly,

set the camera type to parallel, then in the map tab get the top left and bottom right corner and calculate the size,

this size should be inputted in the scene tab depending on the texture quality.

- Low = 1 pixel per block

- Medium = 2 pixels per block

- High = 4 pixels per block

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

#### 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