Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
jsorrell committed Jul 2, 2020
1 parent 0948aff commit 874810d
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 9 deletions.
61 changes: 52 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,69 @@
# SkyBlock
# Skyblock

SkyBlock is a module for [fabric-carpet](https://github.com/gnembon/fabric-carpet)
Skyblock is a module for [fabric-carpet](https://github.com/gnembon/fabric-carpet)

It is a fork of [skyrising/skyblock](https://github.com/skyrising/skyblock)

## Features
- Generator for empty worlds, keeping biomes, structure bounding boxes and end portals
- Generates a skyblock style spawn platform
- Additional wandering trader trades
- Dirt and sand generation from composters

### Skyblock Generation

- Set world type to Skyblock to generate an empty world (in all dimensions) with a single spawn platform.
![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.
![end portal frame remains](screenshots/end_portal.png?raw=true "End Portal Frame")

### Additional Wandering Trader Trades
Enable with ```/skyblock wanderingTraderSkyblockTrades true```
#### 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 |

#### Tier 2
| Item | Price | Trades until disabled |
| ------------------ | ----- | --------------------- |
| Lava Bucket | 16 | 9 |
| 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```
- 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.

## Installation
- Install [Fabric](https://fabricmc.net/use)
- Download [fabric-carpet](https://github.com/gnembon/fabric-carpet/releases)
- Download [SkyBlock](https://github.com/jsorrell/skyblock/releases)
- Place fabric-carpet and SkyBlock into `<minecraft-directory>/mods/`
- 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`
- Choose `World Type: Skyblock` (or `World Type: generator.skyblock.skyblock` if you didn't download `fabric-api`)

### Multiplayer
- Open `server.properties`
Expand Down
Binary file added screenshots/end_portal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/spawn_platform.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 874810d

Please sign in to comment.