Giter VIP home page Giter VIP logo

minecraft-nether-ratio's Introduction

Nether Ratio

A PaperMC plugin to allow customizable Nether to Overworld ratio.

How to set up

Place the plugin jar into your plugins folder inside the server files.

Keep in mind that portals created prior to this operation will not be recognized by the plugin.

Behavior

By default, this plugin will allow you to build portals out of Crying Obsidian and travel at a ratio of 20:1, instead of the vanilla 8:1 - meaning, every block you travel in the Nether dimension will correspond to 20 blocks traveled in the Overworld.

Vanilla portals made out of Obsidian will keep their vanilla ratio of 8:1.

A custom portal will only lead to another custom portal, and a normal portal to another normal portal.

The plugin will test whether other plugins allow the portal to be created or if the player may teleport to it.

Config

Several aspects of the plugin are configurable.

Option Valid values Description
ratio any positive number The defining ratio of the custom portals.
Traveling ratio.nether blocks in the Nether dimension will correspond to traveling ratio.overworld in the Overworld.
A ratio of 40:2 is equivalent to 20:1.

Defaults to overworld: 20, and nether: 1.
frame_block any Minecraft block ID The block the custom portal should be made out of.
One may set this to any existent block in Minecraft, but expect weird behaviors when using weird blocks.
Setting this to an invalid block ID will reset it to the default value.
Setting this to "minecraft:obsidian" will essentially replace the vanilla portals.

Defaults to "minecraft:crying_obsidian".
allow_floating_placement true/false Initially, the plugin attempts to create a portal on top of a buildable surface. If no such position is found and this value is set to true, the plugin will attempt to create a portal floating in the air.

Defaults to true.
allow_forced_placement true/false If the methods above still failed in creating a portal and this value is set to true, the plugin will force a portal creation by creating an air bubble to place it into.
This is an extremely rare case, but it may result in player-placed blocks being overwritten if they are not protected by another plugin.

Defaults to true.
min_distance_between_portals any positive number Two portals that are closer than min_distance_between_portals blocks to each other in a dimension may lead to the same portal in the other dimension.
Similarly, when looking for a portal to teleport to in the other dimension, if none is found within min_distance_between_portals blocks, a new one will be created.

The recommended value for a dimension is the ratio of that dimension multiplied by max_portal_placement_offset.horizontal (see below).

Defaults to overworld: 320, and nether: 16.
max_portal_placement_offset any positive number When a new portal needs to be created in the other dimension, a valid position is searched in a cylindrical shape, of range max_portal_placement_offset.horizontal and height max_portal_placement_offset.vertical.
This means that a high volume of blocks is checked, so increasing any of these values will decrease the performance.

Defaults to vertical: 128, and horizontal: 16.
portal_size any positive number Sizes that define how small or how large portals may be, in height and width.
These measurements do NOT include the frame blocks.
The min sizes define the smallest possible portal. For example, in the absence of this plugin, Nether portals need a width of at least 2 and a height of at least 3.
The max sizes define the largest possible portal.
The new sizes define the measurements of newly created portals, generated as a consequence of traveling to the other dimension.

Defaults to height.min: 1, height.max: 21, height.new: 3, width.min: 1, width.max: 21, and width.new: 2.

Commands

The plugin adds the custom command /nrreload, which is intended to be used after modifying the configuration file, in order to avoid a server restart.

To use this command, a player needs the netherratio.nrreload permission (or netherratio.*).

minecraft-nether-ratio's People

Contributors

cofiprt avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.