skyblock

KO | EN

gitlite — search

#typescript #python #nextjs #tailwindcss #css #nodejs #postgresql #javascript #react #docker #svelte #transformers

★ 29 Open GitHub ↗

Hypixel Skyblock Remake in Python.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Skyblock Beta

![](https://img.shields.io/github/repo-size/peter-hunt/skyblock)
![](https://img.shields.io/github/license/peter-hunt/skyblock)
![](https://img.shields.io/github/issues/peter-hunt/skyblock)
![](https://img.shields.io/github/stars/peter-hunt/skyblock)

![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/social-preview.jpeg)

## Hypixel Skyblock Remake in Python.

**This project is a command-line-based fantasy RPG game.** You type commands to play the game. **Many mechanics and content are a bit different from the original Hypixel Skyblock**, but I'm trying to make it as close to the original Hypixel Skyblock as possible.

I started this project because **my friends couldn't log onto Hypixel**. I'm also learning many of the mechanics and getting better at Hypixel Skyblock by the time.

I chose Python because **I'm the most familiar with Python**. Plus, Python code is more readable and understandable than most of the other languages. And since this is a **command**-line project, which doesn't need to run fast, Python is the choice.

It requires the Skyblock Data repo, [Skyblock Data](https://github.com/peter-hunt/skyblock-data), which **will install and update automatically** (the main program updates the data every 12 hours).

# Table of Contents

- [Skyblock Beta](#skyblock-beta)
  - [Hypixel Skyblock Remake in Python.](#hypixel-skyblock-remake-in-python)
- [Table of Contents](#table-of-contents)
- [Reasons for installing Skyblock](#reasons-for-installing-skyblock)
- [Credits](#credits)
- [License](#license)
- [Warnings](#warnings)
- [Installation](#installation)
  - [Running](#running)
- [Content](#content)
  - [Warning](#warning)
  - [Added Features](#added-features)
  - [Planned Features](#planned-features)
- [Example Saves](#example-saves)
- [Screenshots](#screenshots)
- [Known Issues and Fixes](#known-issues-and-fixes)
- [How to Contribute](#how-to-contribute)
- [Helpful Links](#helpful-links)

# Reasons for installing Skyblock

Well, if you **don't want to buy Minecraft for 29.99 dollars**, and you **still want to play Hypixel Skyblock**, then this project is for you.

The project is also for people who **can't connect to Hypixel or having a bad connection**.

Even more, if you want to **cheat Skyblock**, then cheating on this project won't cost you a single dollar, including having up to \[YouTube\] rank perks for free, even getting admin items or having trillions of coins. And if you want to **make your custom content or mod it**, this project is for you.

# Credits

Quotes from Simon are shown on [BlueCommander](https://www.youtube.com/c/BlueCommander)'s [Hypixel Skyblock Recreate release video](https://youtu.be/GvsjASwuZv4?t=80).

**Simon's quotes contain rules about remaking Hypixel Skyblock**, including not charging clones for money, not for monetization uses, not confusing other players thinking that this is the real Hypixel Skyblock. **This project is among all of the rules above, which could make this project valid**, but I haven't contracted with Hypixel staff for official permission yet.

Social preview image generated by [Bannerbear](https://bannerbear.com).

# License

[MIT](LICENSE.txt)

# Warnings

**This project is still in heavy development**, so the data structures used for caching and saving data will change. If you'd like to play this game in Beta, and your saved files get out of date or just from strange bugs, your files can corrupt.

If your data folder corrupts, delete the whole `~/skyblock/data` folder to let the program fix it.

If your saved files go corrupt, then it's probably not going to be resolved.

# Installation

Use git command or GitHub install-as-zip to install Skyblock.

```bash
git clone https://github.com/peter-hunt/skyblock.git
```

## Running

**This project requires Python 3.10+**

To run the project, go into the project directory and do:

```bash
python -m skyblock
```

Upon your first successful execution of the project, you should see something like this:
![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/first-launch.png)

To check command usage, type `help` for command documentation.

# Content

## Warning

The content added in the Skyblock Remake may slightly differ from the original content, including special abilities, game mechanisms, tools, etc. You might want to read their in-game descriptions for detailed information.

## Added Features

* Abilities
* Accessories
* Accessory bag and Minion bag.
* Armor Pieces, Tools, and Weapons
* Bestiaries and Bestiary Milestones
* Crafting
* Collections
* Combining Enchantments, Reforge Stone, and Potato Books
* Dyes
* Enchantments, Modifiers, Recombobulation, and Reforges
* Farming, Mining, Simple Combat, Foraging, Fishing, and Enchanting
* Fast Traveling
* NPC Buying and Trading items
* Minions
* Pets and Pet Score
* Skills
* Slayers Items and Recipes

## Planned Features

* Wardrobe and other bags/sacks.
* Arachane & Dragons
* Brewing and Potion effects
* Commissions
* Crystal Hollows
* Diana, Griffin Pet and Mythological creature
* Dungeons
* Fairy Souls
* Forging (Forging recipes are already accessible)
* Heart of The Mountain Skill Tree
* Mayors and Unique Perks
* Minion Support Items
* NPC Usage (like Kat, Fetchur, etc.)
* Pet Support Items
* Power Stones and Magic Power
* Slayers Quests
* Templates and abilities optimation
* Templates organized for translation update (abilities included)

# Example Saves

There's some example game save file in the [example](./example) folder. The example files are used in the introduction video. (coming soon)

You can view the saves with the following links, or copy the following files under the `~/skyblock/saves` folder to play it.

The following `Example Game` is my test game, which is achievable in-game.

* [Example Game](example/game.json)
* [Pro Game](example/pro.json)  (based on YouTuber 56ms's Strawberry profile in January 2022)

Some of the items, enchantments, and so on in the future Pro save is currently unobtainable in-game.

# Screenshots

Here's some footage on the gameplay:

![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/usage-1.png)
![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/usage-2.png)
![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/usage-3.png)
![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/usage-4.png)
![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/usage-5.png)
![](https://raw.githubusercontent.com/peter-hunt/skyblock/main/screenshots/usage-6.png)

# Known Issues and Fixes

* Displaying the wrong colour in VSCode terminal when using certain Color Themes;
  * Use `"terminal.integrated.minimumContrastRatio": 1` in configuration file `settings.json`.

# How to Contribute

[CONTRIBUTING.md](CONTRIBUTING.md)

# Helpful Links

* [Hypixel Website](https://hypixel.net)
* [Hypixel Skyblock Wiki](https://hypixel-skyblock.fandom.com/wiki/Hypixel_SkyBlock_Wiki)
* [Skyblock Data Repo](https://github.com/peter-hunt/skyblock-data)
* [My Patreon Page](https://www.patreon.com/peter_hunt)

skyblock

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README