https://github.com/mineinabyss/deeperworld

A PaperMC plugin that automatically teleports players between regions, mimicking deeper worlds
https://github.com/mineinabyss/deeperworld

minecraft papermc

Last synced: 3 months ago
JSON representation

A PaperMC plugin that automatically teleports players between regions, mimicking deeper worlds

• Host: GitHub
• URL: https://github.com/mineinabyss/deeperworld
• Owner: MineInAbyss
• License: mit
• Created: 2018-07-05T07:15:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-22T12:15:32.000Z (3 months ago)
• Last Synced: 2024-09-28T12:01:55.624Z (3 months ago)
• Topics: minecraft, papermc
• Language: Kotlin
• Homepage:
• Size: 438 KB
• Stars: 22
• Watchers: 5
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# DeeperWorld

[![Java CI](https://github.com/MineInAbyss/DeeperWorld/actions/workflows/main.yml/badge.svg)](https://github.com/MineInAbyss/DeeperWorld/actions/workflows/main.yml)

[![Package](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.mineinabyss.com/releases/com/mineinabyss/deeperworld/maven-metadata.xml)](https://repo.mineinabyss.com/#/releases/com/mineinabyss/deeperworld)

[![Wiki](https://img.shields.io/badge/-Project%20Wiki-blueviolet?logo=Wikipedia&labelColor=gray)](https://wiki.mineinabyss.com/deeperworld)

[![Contribute](https://shields.io/badge/Contribute-e57be5?logo=github%20sponsors&style=flat&logoColor=white)](https://wiki.mineinabyss.com/contribute)



DeeperWorld is a plugin used on the Mine in Abyss server to create the illusion of a world taller than Minecraft's 256

block limit. We achieve this by dividing our deep world into `sections`, which have an overlap of identical blocks from

the bottom of one section, and top of the next. The plugin relatively teleports players between these sections when

reaching the top or bottom.

# Features

## Syncing

Additionally, we must sync overlaps by listening to many Bukkit events.

#### Currently we support some of the following syncing features:

- Block place/break

- Chests and other inventories, by directly accessing the higher layer's inventory, preventing dupe exploits

- Crop growth

#### Notable features that don't get synced on overlaps:

- Water flow

- Shulkers

- Pistons (they will not push/pull blocks on intersections in order to prevent dupe exploits)

- Entities (would be possible with fancy packet manipulation, but not currently planned)

## Other features

The config has some additional features like damaging players outside managed sections.

# Setup

Please read the [project wiki](https://wiki.mineinabyss.com/deeperworld/) for more details on setup and

configuration.

#### build.gradle.kts

```kotlin

repositories {

    maven("https://repo.mineinabyss.com/releases")

}

dependencies {

    compileOnly("com.mineinabyss:deeperworld:")

}

```

# Contributing

Please contact us in `#plugin-dev` on [Discord](https://discord.gg/QXPCk2y) if you'd like to help out. We are open to

new features and contributions!

Check out the contribution guide button on top.