Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jsorrell committed Jul 20, 2021
1 parent cd93ec5 commit fa40d35
Showing 1 changed file with 312 additions and 56 deletions.
368 changes: 312 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,332 @@
# SkyBlock

SkyBlock is a module for [fabric-carpet](https://github.com/gnembon/fabric-carpet)
originally based on [skyrising/skyblock](https://github.com/skyrising/skyblock).

It is a fork of [skyrising/skyblock](https://github.com/skyrising/skyblock)
This mod aims to provide an expert level SkyBlock gameplay that depends on players' knowledge
of Minecraft mechanics. In some cases, outside tools such as [Chunkbase](https://www.chunkbase.com/)
or [MiniHUD](https://www.curseforge.com/minecraft/mc-mods/minihud) will be helpful.
Usage of these is encouraged. Sometimes extended grinding or AFK sessions will be
required for progression, although I've tried to minimize this in some cases.
Unless a command is run to enable features or SkyBlock world generation is chosen,
the mod will not affect other saves on the client it is installed on.

## Installation
- Install [Fabric](https://fabricmc.net/use)
- Download [fabric-carpet](https://github.com/gnembon/fabric-carpet/releases)
- Optionally download [fabric-api](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files)
- Download [SkyBlock and the Datapack](https://github.com/jsorrell/skyblock/releases)
- Place fabric-carpet, fabric-api, and SkyBlock into `<minecraft-directory>/mods/`

## Usage

### Singleplayer
- `Create New World`
- Set the Difficulty to Hard (for more armor/weapon drops)
- Select the downloaded Datapack
- Set Allow Cheats to `ON` so you will be able to enable mod features
- Click on `More World Options...`
- Choose `World Type: SkyBlock` (or `World Type: generator.skyblock` if you didn't download `fabric-api`)
- Create the world
- Run `/function skyblock:enable_features` to enable SkyBlock features

### Multiplayer
The mod and datapack are only required on the server.

- Open `server.properties`
- Change `level-type=default` to `level-type=skyblock`
- Make sure to delete or move the world folder in order to create a new world
- Move the downloaded datapack to the `datapack` directory
- Run `function skyblock:enable_features` to enable SkyBlock features

## Features

### SkyBlock Generation
A SkyBlock world generates exactly like a Default generation world, but with every block removed.
Biomes and Structure Bounding Boxes are kept in place.
This means Husks will still spawn in Deserts and Blazes will spawn in Nether Fortresses, for example.

- Set world type to SkyBlock to generate an empty world (in all dimensions) with a single spawn platform.
Only two things are generated:
- A small starting island where you spawn:
![small spawn platform with grass, mycelium, nylium, and a tree](screenshots/spawn_platform.png?raw=true "Spawn Platform")

- Keeps biomes, structure bounding boxes, end portal frames, and silverfish spawners.
- All end portal frames and silverfish spawners:
![end portal frame remains](screenshots/end_portal.png?raw=true "End Portal Frame")

Even with every block removed, almost every block is obtainable and almost every mob is spawnable,
using only *Vanilla* features.

### Additional Wandering Trader Trades
Enable with ```/skyblock wanderingTraderSkyBlockTrades true```
#### Tier 1
### Additional Mod Features ###
SkyBlock generation does, however, leave a few unobtainable resources.
In addition to generation, this mod also fills in the gaps,
making as minimal and Minecrafty changes as possible.

---

#### Additional Wandering Trader Trades ####
Provides *tall flowers* and *Lava Buckets*

Disable with ```/skyblock setDefault wanderingTraderSkyBlockTrades false```

Tall Flowers trades mimic Bedrock.

##### Additional Trades: #####

###### Tier 1
| Item | Price | Trades until disabled |
| ------------- | ----- | --------------------- |
| Chorus Flower | 5 | 6 |
| Nether Wart | 1 | 12 |
| Sweet Berries | 1 | 16 |
| Lilac | 5 | 10 |
| Rose Bush | 5 | 10 |
| Peony | 5 | 10 |
| Glow Lichen | 5 | 10 |

#### Tier 2
| Item | Price | Trades until disabled |
| ------------------ | ----- | --------------------- |
| Lava Bucket | 16 | 1 |
| Jukebox | 64 | 6 |
| Enchanting Table | 64 | 6 |
| Heart of the Sea | 64 | 6 |
| Wet Sponge | 16 | 6 |
| Pigstep Music Disc | 16 | 6 |
| Cobweb | 3 | 9 |

#### Changes from [skyrising/skyblock](https://github.com/skyrising/skyblock)
- Removed soul sand: Use piglin bartering
- Removed cocoa beans: Go fishing in a jungle
- Added enchating table
- Added cobweb
- Added wet sponge
- Added pigstep music disc which is new in 1.16


### Useful Composters
Enable with ```/skyblock usefulComposters true``` or ```/skyblock usefulComposters redstone```
- Provides a nicer way to get sand/red sand than the 64/24 you can get at a time from a wandering trader.
- Makes dirt generation nicer too.
- Compost result depends on the biome.
| Lilac | 1 | 12 |
| Rose Bush | 1 | 12 |
| Peony | 1 | 12 |
| Sunflower | 1 | 12 |

###### Tier 2
| Output Item | Input Item | Price | Trades until disabled |
| ----------- | ---------- | ----- | --------------------- |
| Lava Bucket | Bucket | 16 | 1 |

---

#### Lightning Electrifies Vines ####
Provides *Glow Lichen*

Disable with ```/skyblock setDefault lightningElectrifiesVines false```

If lightning strikes glowstone with vines attached,
the vines will turn into glow lichen.
It can also strike a lightning rod on the glowstone.

---

#### Renewable Budding Amethysts ####
Provides *Budding Amethysts*

Disable with ```/skyblock setDefault renewableBuddingAmethysts false```

A lava block surrounded by Calcite which is then surrounded by Smooth Basalt
will eventually turn into a Budding Amethyst.
Conversion takes about 2 hours on average.

---

#### End Gateways Spawn Chorus ####
Provides *Chorus Fruit* and *Chorus Flowers*

Disable with ```/skyblock setDefault gatewaysSpawnChorus false```

When an End Gateway is taken to a position over the void, the Endstone island
generated spawns with a Chorus Tree on it.

---

#### Dolphins Find Hearts of the Sea ####
Provides *Hearts of the Sea*

Disable with ```/skyblock setDefault renewableHeartsOfTheSea false```

When a dolphin gives up finding a treasure chest after being given a fish,
they will find a Heart of the Sea.

---

#### Ender Dragons Can Drop Heads ####
Provides *Dragon Heads*

Disable with ```/skyblock setDefault renewableDragonHeads false```

When an Ender Dragon is killed by a Charged Creeper, she will drop her head.

---

#### Shulkers Spawn On Dragon Kill ####
Provides *Shulkers*

Disable with ```/skyblock setDefault shulkerSpawning false```

When an Ender Dragon is re-killed, a Shulker spawns on top of the Bedrock pillar.

---

#### Anvils Compact Coal into Diamonds ####
Provides *Diamonds*

Disable with ```/skyblock setDefault renewableDiamonds false```

A Falling Anvil crushes a stack of Coal Blocks into a Diamond.

---

#### Goats Ram Open Nether Wart Blocks ####
Provides *Nether Wart*

Disable with ```/skyblock setDefault rammingWart false```

When a Goat rams a Nether Wart Block, it will break into Nether Wart.

---

#### Useful Composters (disabled by default) ####
Provides additional *Sand*, *Red Sand*, and *Dirt*

Enable with ```/skyblock setDefault usefulComposters true``` or ```/skyblock setDefault usefulComposters redstone```

Provides an easier way to get sand/red sand than the 64/24 you can get at a time from a wandering trader.

The datapack now makes it so Husks drop Sand and Red Sand has a crafting recipe, so this is disabled by default.
Additionally, Dirt farming is nicer since 1.17.

Compost result depends on the biome.
Get sand in deserts, beaches, warm oceans etc, red sand from badlands, and dirt elsewhere.

- When set to ```redstone```, the composter outputs bonemeal without a redstone signal.
When set to ```redstone```, the composter outputs Bonemeal without a redstone signal.

## Installation
- Install [Fabric](https://fabricmc.net/use)
- Download [fabric-carpet](https://github.com/gnembon/fabric-carpet/releases)
- Optionally download [fabric-api](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files)
- Download [SkyBlock](https://github.com/jsorrell/skyblock/releases)
- Place fabric-carpet, fabric-api, and SkyBlock into `<minecraft-directory>/mods/`
---

## Usage (World Generation)
### Singleplayer
- `Create New World`
- Optionally download [skyblock-datapack](https://github.com/jsorrell/skyblock-datapack) and select this as a datapack
- `More World Options...`
- Choose `World Type: SkyBlock` (or `World Type: generator.skyblock.skyblock` if you didn't download `fabric-api`)
### Additional Datapack Features ###
The included datapack provides additional recipes, and advancements.

### Multiplayer
- Open `server.properties`
- Change `level-type=default` to `level-type=skyblock`
- Make sure to delete or move the world folder in order to create a new world
When possible, changes were added to the datapack over the mod for ease of user customization.

---

#### Additional Blast Furnace Recipe ####
In 1.17, Drowneds no longer drop Gold Ingots.
This makes progression extremely slow and tedious as 16 Foxes spawning with Emeralds are required.
By adding this Blast Furnace recipe, Golden Tools can be smelted into nuggets.

![blast furnace recipe](screenshots/blast_furnace_recipe.png?raw=true "Blast Furnace Recipe")

The center slot accepts any cooked meat.

---

#### Calcite and Tuff Obtainable ####
Provides *Calcite* and *Tuff*

Put Diorite in a Blast Furnace for Calcite.

Put Andesite in a Blast Furnace for Tuff.

---

#### Husks Drop Sand ####
Provides additional *Sand*

Husks drop Sand because obtaining large amounts from a Wandering Trader is tedious.

---

#### Ancient Debris Given as a Hero of the Village Gift in the Nether ####
Provides *Ancient Debris*

Armorers, Toolsmiths, and Weaponsmiths will sometimes gift village heroes
Ancient Debris while in the Nether.

---

#### Cobbled Deepslate is Craftable ####
Provides *Cobbled Deepslate*

Craft Cobbled Deepslate with 9 Cobblestone in a crafting grid.

---

#### Elytra Obtainable by Fishing in the End ####
Provides *Elytra*

Elytra can be caught rarely as treasure items when fishing in the End.

---

#### Red Sand Recipe ####
Provides additional *Red Sand*

Sand combined 1-1 with Red Dye makes Red Sand.

---

#### Spider Jockeys Drop Cobwebs ####
Provides *Cobwebs*

When a player kills a Spider Jockey,
the first half killed drops a cobweb.

---

#### Cocoa Beans Obtainable by Fishing in Jungles ####
Provides *Cocoa Beans*

Matching Bedrock, Cocoa Beans can be obtained as a junk item when fishing in a Jungle.

---

#### Ores Obtainable in Smithing Table ####
Provides *ores*

All ores can be crafted in a smithing table using a block of the base stone material and
a block of the ore's material.

For example, Nether Gold Ore can be crafted with Netherrack and a Block of Gold.

---

#### Horse Armors are Craftable ####
Provides *Iron Horse Armor*, *Golden Horse Armor*, and *Diamond Horse Armor*

Craft Horse Armors with their respective materials in a **H** shape.

---

#### Cats Gift Enchanted Golden Apples ####
Provides *Enchanted Golden Apples*

Cats will rarely bring the player an Enchanted Golden Apple as a morning gift.

---

#### Piglins Give Gilded Blackstone ####
Provides *Gilded Blackstone*

Piglins will rarely give Gilded Blackstone when bartering.

---

#### Creepers Drop Pigstep ####
Provides the music disc *Pigstep*

When Creepers are killed by Skeletons in the Nether,
they can drop any music disc, including Pigstep.

---

#### Zoglins Drop Snout Banner Patterns ####
Provides *Snout Banner Pattern*

Title says it all.

---

### Numerous Added Advancements ###
SkyBlock advancements help guide progression, as well as serve to document the mod's changes to vanilla.

With all features enabled, all vanilla advancements except for `War Pigs` can be completed.


## Carpet Features
Installation will also enable these `fabric-carpet` features.

With the `fabric-carpet` options below enabled, all blocks, items, and mobs obtainable in vanilla survival are obtainable in SkyBlock.
- [desertShrubs](https://github.com/gnembon/fabric-carpet/wiki/Current-Available-Settings#desertshrubs) for Dead Bushes
- run `/carpet setDefault desertShrubs true` to enable
- [renewableSponges](https://github.com/gnembon/fabric-carpet/wiki/Current-Available-Settings#renewablesponges) for Sponges
- run `/carpet setDefault renewableSponges true` to enable

## Acknowledgements
- [@skyrising](https://github.com/skyrising/skyblock) for the initial mod idea and some source code

- [@DeadlyMC](https://github.com/DeadlyMC/Skyblock-datapack) for the initial ideas for the datapack

- [@gnembon](https://github.com/gnembon/fabric-carpet) for `fabric-carpet`

## License
This project is licensed under the terms of the MIT license.

0 comments on commit fa40d35

Please sign in to comment.