# NetherRatio<\/p>\n
\n<\/p>\n
A Paper\/Spigot plugin that allows you to customize the Nether-to-Overworld coordinate ratio for portal travel. Perfect for servers that want to change the vanilla 8:1 ratio to suit their world design!<\/p>\n
## \u2728 Features<\/p>\n
– \ud83c\udfaf **Per-World Ratios**: Set different ratios for each world pair
\n– \ud83e\uddee **Coordinate Calculator**: Calculate portal coordinates without building portals
\n– \ud83d\udee1\ufe0f **Coordinate Bounds**: Prevent teleportation into ungenerated chunks or beyond world borders
\n– \ud83c\udf0d **Multi-World Support**: Configure different world pairs for complex server setups
\n– \ud83c\udf10 **Internationalization**: Built-in support for English, German, French, Italian, and Korean
\n– \u26a1 **Performance Optimized**: Lightweight with minimal server impact
\n– \ud83d\udd12 **Permission-Based**: Full integration with permission management plugins
\n– \ud83d\udd04 **Hot Reload**: Change settings without restarting the server
\n– \ud83d\udcdd **Well Documented**: Comprehensive JavaDoc and code comments
\n– \u2699\ufe0f **Easy Configuration**: Simple YAML configuration files<\/p>\n
## \ud83d\udccb Requirements<\/p>\n
– **Server**: Paper 1.21.4+ (or compatible Spigot fork)
\n– **Java**: Java 21 or higher
\n– **Dependencies**: None required<\/p>\n
## \ud83d\udce5 Installation<\/p>\n
1. Download the latest version from GitHub Releases
\n2. Place the JAR file in your server’s `plugins` folder
\n3. Restart your server
\n4. Configure the plugin in `plugins\/NetherRatio\/config.yml`
\n5. Use `\/netherratio reload` to apply changes<\/p>\n
## \u2699\ufe0f Configuration<\/p>\n
### config.yml<\/p>\n
“`yaml
\n# Language for messages (available: en, de, fr, it, ko)
\nlanguage: en<\/p>\n
# Default ratio for world pairs that don’t have a specific ratio configured
\n# Overworld value : Nether 1
\n# For vanilla Minecraft behavior, set to 8
\nvalue: 8<\/p>\n
# Coordinate bounds – Prevent players from being teleported outside safe areas
\n# This helps avoid teleportation into ungenerated chunks or beyond world borders
\ncoordinate-bounds:
\n enabled: false
\n # Minecraft’s world border default is \u00b129,999,984 blocks
\n # These values apply to the destination coordinates (after ratio calculation)
\n min-x: -29999968
\n max-x: 29999968
\n min-z: -29999968
\n max-z: 29999968<\/p>\n
# World pairs for portal travel
\n# Define which overworld connects to which nether world
\n#
\n# Simple format (uses default ratio):
\n# overworld_name: nether_name
\n#
\n# Advanced format (per-world ratio):
\n# overworld_name:
\n# nether: nether_name
\n# ratio: 16
\n#
\n# Examples:
\nworld-pairs:
\n world: world_nether
\n # Example with custom ratio:
\n # survival:
\n # nether: survival_nether
\n # ratio: 16
\n # Example with coordinate offsets:
\n # adventure:
\n # nether: adventure_nether
\n # ratio: 8
\n # offset-x: 1000
\n # offset-z: -500
\n # Example with simple format:
\n # creative: creative_nether
\n“`<\/p>\n
### Configuration Options<\/p>\n
| Option | Type | Default | Description |
\n|——–|——|———|————-|
\n| `language` | String | `en` | Language for in-game messages (en, de, fr, it, ko) |
\n| `value` | Double | `8` | Default coordinate conversion ratio (Overworld blocks : 1 Nether block) |
\n| `coordinate-bounds` | Section | See below | Safe coordinate limits to prevent teleportation into ungenerated areas |
\n| `world-pairs` | Map | See below | Mapping of Overworld worlds to their corresponding Nether worlds |<\/p>\n
#### Coordinate Bounds Configuration<\/p>\n
Coordinate bounds help prevent players from being teleported into ungenerated chunks or beyond world borders when using portals. This is especially useful for servers with custom world sizes or pre-generated regions.<\/p>\n
**Configuration Options:**<\/p>\n
| Option | Type | Default | Description |
\n|——–|——|———|————-|
\n| `enabled` | Boolean | `false` | Enable or disable coordinate bounds checking |
\n| `min-x` | Integer | `-29999968` | Minimum X coordinate for portal destinations |
\n| `max-x` | Integer | `29999968` | Maximum X coordinate for portal destinations |
\n| `min-z` | Integer | `-29999968` | Minimum Z coordinate for portal destinations |
\n| `max-z` | Integer | `29999968` | Maximum Z coordinate for portal destinations |<\/p>\n
**How it works:**
\n– When enabled, portal destinations are checked against these bounds
\n– If a destination exceeds the bounds, coordinates are automatically clamped to the nearest safe position
\n– Bounds apply to the **destination** coordinates (after ratio calculation)
\n– Useful for servers with smaller world borders or pre-generated areas<\/p>\n
**Example:**
\n“`yaml
\ncoordinate-bounds:
\n enabled: true
\n min-x: -10000
\n max-x: 10000
\n min-z: -10000
\n max-z: 10000
\n“`
\nWith this configuration, no portal will teleport a player beyond \u00b110,000 blocks in the destination world.<\/p>\n
#### World Pairs Configuration<\/p>\n
You can configure world pairs using two formats:<\/p>\n
**Simple Format** (uses the default ratio from `value`):
\n“`yaml
\nworld-pairs:
\n world: world_nether
\n creative: creative_nether
\n“`<\/p>\n
**Advanced Format** (per-world custom ratios and offsets):
\n“`yaml
\nworld-pairs:
\n world: world_nether # Uses default ratio (8)
\n survival:
\n nether: survival_nether
\n ratio: 16 # Custom 16:1 ratio for this world pair
\n skyblock:
\n nether: skyblock_nether
\n ratio: 4 # Custom 4:1 ratio for this world pair
\n adventure:
\n nether: adventure_nether
\n ratio: 8
\n offset-x: 1000 # Add 1000 blocks to X when going to nether
\n offset-z: -500 # Subtract 500 blocks from Z when going to nether
\n“`<\/p>\n
**Coordinate Offsets:**
\nThe `offset-x` and `offset-z` options allow you to shift the entire nether coordinate space relative to the overworld. This is useful for:
\n– Aligning spawn points between dimensions
\n– Creating separated nether regions for different overworld areas
\n– Custom world designs where nether and overworld don’t share the same origin<\/p>\n
**How offsets work:**
\n– When traveling **Overworld \u2192 Nether**: Coordinates are divided by ratio, then offsets are **added**
\n– When traveling **Nether \u2192 Overworld**: Offsets are **subtracted** first, then coordinates are multiplied by ratio<\/p>\n
**Example:**
\n“`yaml
\nworld-pairs:
\n world:
\n nether: world_nether
\n ratio: 8
\n offset-x: 1000
\n offset-z: 0
\n“`
\nWith this configuration:
\n– Overworld (0, 0) \u2192 Nether (1000, 0)
\n– Overworld (800, 0) \u2192 Nether (1100, 0)
\n– Nether (1000, 0) \u2192 Overworld (0, 0)<\/p>\n
### Configuration Examples<\/p>\n
**Default Ratio for All Worlds** (8:1):
\n“`yaml
\nvalue: 8
\nworld-pairs:
\n world: world_nether
\n survival: survival_nether
\n“`<\/p>\n
**1:1 Ratio** (same coordinates in both dimensions):
\n“`yaml
\nvalue: 1
\nworld-pairs:
\n world: world_nether
\n“`<\/p>\n
**Different Ratios Per World**:
\n“`yaml
\nvalue: 8 # Default ratio
\nworld-pairs:
\n world: world_nether # Uses default 8:1
\n survival:
\n nether: survival_nether
\n ratio: 16 # 16:1 for survival world
\n skyblock:
\n nether: skyblock_nether
\n ratio: 1 # 1:1 for skyblock
\n“`<\/p>\n
## \ud83c\udfae Commands<\/p>\n
All commands use a consistent subcommand structure:<\/p>\n
### `\/netherratio` or `\/netherratio list`
\nDisplay all configured ratios (default and per-world).<\/p>\n
**Permission**: `netherratio.netherratio`
\n**Usage**: `\/netherratio` or `\/netherratio list`
\n**Example Output**:
\n“`
\nDefault ratio: 8.0
\nWorld-specific ratios:
\n world: 8.0
\n survival: 16.0
\n“`<\/p>\n
### `\/netherratio set **Permission**: `netherratio.netherratio` ### `\/netherratio set **Permission**: `netherratio.netherratio` ### `\/netherratio calc [x z]` **Permission**: `netherratio.calc` (default: all players) **Example Output**: ### `\/netherratio reload` **Permission**: `netherratio.netherratio` ## \ud83d\udd10 Permissions<\/p>\n | Permission | Description | Default | ### Permission Examples<\/p>\n **LuckPerms**: **PermissionsEx**: ## \ud83c\udf10 Supported Languages<\/p>\n NetherRatio comes with built-in translations for:<\/p>\n – \ud83c\uddec\ud83c\udde7 **English** (`en`) To change the language, edit `language: en` in `config.yml` to your preferred language code.<\/p>\n ### Custom Languages<\/p>\n You can create custom translations by: ## \ud83d\udd27 How It Works<\/p>\n ### Coordinate Conversion<\/p>\n When a player or entity travels through a Nether portal:<\/p>\n 1. **Overworld \u2192 Nether**: Coordinates are **divided** by the ratio 2. **Nether \u2192 Overworld**: Coordinates are **multiplied** by the ratio 3. **Coordinate Bounds** (if enabled): Destination coordinates are checked and clamped ### World Mapping<\/p>\n The plugin uses the `world-pairs` configuration to determine which Nether world corresponds to each Overworld. This allows: ## \ud83c\udfd7\ufe0f Building from Source<\/p>\n ### Prerequisites ### Build Steps<\/p>\n “`bash # Build with Maven # The compiled JAR will be in target\/ The built plugin will be available at `target\/NetherRatio-2.3.1.jar`<\/p>\n ## \ud83d\udc1b Troubleshooting<\/p>\n ### Portal doesn’t work after changing ratio<\/p>\n 1. Make sure you’ve saved the config and run `\/netherratio reload` ### “World not found” errors<\/p>\n – Ensure your `world-pairs` configuration correctly maps your worlds ### Permission errors<\/p>\n – Verify the permission is correctly set: `netherratio.netherratio` ## \ud83d\udcca Technical Details<\/p>\n – **Event Priority**: HIGH (runs after most plugins, before monitoring) A Paper\/Spigot plugin that allows you to customize the Nether-to-Overworld coordinate ratio for portal travel. Perfect for servers that want to change the vanilla 8:1 ratio to suit their world design!<\/p>\n","protected":false},"featured_media":110078,"template":"","meta":{"_minecraft_slug":"netherratio-ng","_minecraft_project_id":"k8N7uV7l","_minecraft_author":"ZyanKLee","_minecraft_license":"GPL-3.0-or-later","_minecraft_downloads":40,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"netherratio-ng.zip","_minecraft_size_bytes":164796,"_minecraft_version_count":8,"_minecraft_updated_at":"2026-05-15T21:33:43.905766Z","_minecraft_date_created":"2026-02-10T00:35:38.266124Z","_minecraft_date_modified":"2026-04-08T20:50:09.721961Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/netherratio-ng","_minecraft_icon_attachment_id":110078,"_minecraft_imported_at":"2026-06-06T11:15:07+00:00","_minecraft_import_hash":"621df8974347a36fe4784391bb39654a","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[125,89,127,128,129,92],"mod_loader":[131,132,133,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-110077","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-folia","mod_category-game-mechanics","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-utility","mod_loader-folia","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\nSet the default ratio for all world pairs that don’t have a specific ratio.<\/p>\n
\n**Usage**: `\/netherratio set
\n**Example**: `\/netherratio set 8` – Sets default ratio to 8:1<\/p>\n
\nSet a custom ratio for a specific world pair.<\/p>\n
\n**Usage**: `\/netherratio set
\n**Example**: `\/netherratio set 16 survival` – Sets 16:1 ratio for the survival world<\/p>\n
\nCalculate what coordinates in one dimension correspond to in the other dimension.<\/p>\n
\n**Usage**:
\n– `\/netherratio calc` – Calculate using your current position
\n– `\/netherratio calc 800 600` – Calculate specific coordinates <\/p>\n
\n“`
\nCoordinates 800.0, 600.0 in world correspond to 100.0, 75.0 in world_nether
\n“`<\/p>\n
\nReload the plugin configuration from disk.<\/p>\n
\n**Usage**: `\/netherratio reload`<\/p>\n
\n|————|————-|———|
\n| `netherratio.netherratio` | Allows managing ratios and reloading config | OP only |
\n| `netherratio.calc` | Allows using the coordinate calculator | Everyone |<\/p>\n
\n“`
\n\/lp group admin permission set netherratio.netherratio true
\n“`<\/p>\n
\n“`
\n\/pex group admin add netherratio.netherratio
\n“`<\/p>\n
\n– \ud83c\udde9\ud83c\uddea **German** (`de`)
\n– \ud83c\uddeb\ud83c\uddf7 **French** (`fr`)
\n– \ud83c\uddee\ud83c\uddf9 **Italian** (`it`)
\n– \ud83c\uddf0\ud83c\uddf7 **Korean** (`ko`)<\/p>\n
\n1. Creating a new file in `plugins\/NetherRatio\/messages\/`
\n2. Naming it `
\n3. Copying the structure from any existing message file
\n4. Setting `language:
\n – Example with 8:1 ratio: `X=800, Z=600` \u2192 `X=100, Z=75`<\/p>\n
\n – Example with 8:1 ratio: `X=100, Z=75` \u2192 `X=800, Z=600`<\/p>\n
\n – Prevents teleportation into ungenerated chunks
\n – Keeps players within safe, pre-generated areas
\n – Example: If max-x is 10000 and calculated X is 12000, player spawns at X=10000<\/p>\n
\n– Multiple separate world pairs on the same server
\n– Custom world names (not restricted to `world_nether` naming)
\n– Flexible multi-world setups<\/p>\n
\n– Git
\n– Maven 3.6+
\n– Java 21 JDK<\/p>\n
\n# Clone the repository
\ngit clone https:\/\/github.com\/ZyanKLee\/NetherRatio.git
\ncd NetherRatio<\/p>\n
\nmvn clean package<\/p>\n
\n“`<\/p>\n
\n2. Verify the world names in `world-pairs` match your actual world names
\n3. Check server logs for any error messages<\/p>\n
\n– Use `\/worlds` (if you have a world management plugin) to verify world names
\n– World names are case-sensitive<\/p>\n
\n– Check your permission plugin’s configuration
\n– Ensure OPs have permissions if using the default setup<\/p>\n
\n– **Supported Entities**: Players, minecarts, items, and all other entities
\n– **Portal Types**: Nether portals only (End portals are not affected)
\n– **Thread Safety**: All operations are thread-safe
\n– **Performance**: < 1ms processing time per portal event\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request. For major changes:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature\/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature\/AmazingFeature`)\n5. Open a Pull Request\n\n### Code Style\n\n- Follow existing code conventions\n- Add JavaDoc comments for public methods\n- Include appropriate error handling\n- Write clear commit messages\n\n## \ud83d\udcdd License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## \ud83d\udd17 Links\n\n- Download on Modrinth\n- Report Issues\n- Paper Documentation\n\n## \ud83d\udc96 Support\n\nIf you find this plugin useful, please consider:\n- \u2b50 Starring this repository\n- \ud83d\udce2 Sharing it with others\n- \ud83d\udc1b Reporting bugs and suggesting features\n\n## \ud83d\ude4f Credits\n\nThis project is a fork and continuation of the original work by xDxRAx.\n\n**Original Author:** xDxRAx \n**Current Maintainer:** ZyanKLee\n\nSpecial thanks to the original author for creating the foundation of this plugin!\n\n---\n\n**Made with \u2764\ufe0f for the Minecraft community**\n\n<\/p>\n","protected":false},"excerpt":{"rendered":"