# Portal Preloader<\/p>\n
A Folia-compatible Minecraft plugin that reduces loading screens and improves the portal travel experience by preloading chunks at portal destinations before players teleport.<\/p>\n
## Features<\/p>\n
– **Portal Preloading**: Automatically spawns a snowball through newly created portals to pre-generate destination chunks
\n– **Portal Cooldown System**: Gives the destination time to fully load before allowing players to teleport
\n– **Dimension-Specific Cooldowns**: Set different cooldown times for Overworld and Nether portals
\n– **Live Countdown**: Players waiting in a portal see a countdown message every second
\n– **Automatic Timer Reset**: When cooldown expires, players don’t need to leave and re-enter the portal
\n– **Folia Compatible**: Fully compatible with Folia’s region-based threading
\n– **Customizable Messages**: All chat messages are configurable with color code support
\n– **Reload Command**: Update configuration without restarting the server<\/p>\n
## Why Use This Plugin?<\/p>\n
When players travel through nether portals to unexplored areas, the destination chunks need to be generated. This can cause:
\n– Long loading screens
\n– Client freezing
\n– Players getting stuck in the portal animation
\n– Poor user experience, especially on servers with complex terrain generation<\/p>\n
**Portal Preloader solves this by:**
\n1. Spawning a snowball through the portal immediately when it’s lit
\n2. The snowball travels to the destination and triggers chunk generation
\n3. Chunks are pre-loaded and ready before any player teleports
\n4. The configurable cooldown ensures chunks have time to fully generate
\n5. Players experience smooth, instant teleportation with no loading screen<\/p>\n
This is especially useful for:
\n– Servers with custom terrain generation
\n– High-performance servers running Folia
\n– Anarchy servers where players frequently explore new areas
\n– Any server wanting to improve the portal travel experience<\/p>\n
## Installation<\/p>\n
1. Download the latest release JAR file
\n2. Place it in your server’s `plugins` folder
\n3. Restart your server or use a plugin manager to load it
\n4. Configure the plugin in `plugins\/PortalPreloader\/config.yml`<\/p>\n
## Requirements<\/p>\n
– Minecraft 1.21.x
\n– Folia or Paper server
\n– Java 21<\/p>\n
## Configuration<\/p>\n
### Default Config (`config.yml`)<\/p>\n
“`yaml
\n# Portal Preloader Configuration<\/p>\n
# Enable portal cooldown system
\n# When enabled, players cannot use newly lit portals for a set time
\nenable-portal-cooldown: true<\/p>\n
# Default cooldown for all portals (in seconds)
\n# This is used when dimension-specific cooldowns are not set or set to -1
\nportal-cooldown-seconds: 10<\/p>\n
# Dimension-specific cooldowns (set to -1 to use default cooldown)
\n# Overworld portals cooldown (portals lit in the overworld)
\noverworld-cooldown-seconds: -1<\/p>\n
# Nether portals cooldown (portals lit in the nether)
\nnether-cooldown-seconds: -1<\/p>\n
# Messages sent to players
\n# Use {time} as a placeholder for remaining seconds in cooldown message
\n# Color codes supported with & (e.g., &c for red, &a for green, &e for yellow)
\nmessages:
\n # Message sent every second while player waits in a portal on cooldown
\n cooldown: “&cThis portal is still loading! Please wait {time} seconds.”<\/p>\n
# Message sent when the portal becomes ready while player is waiting inside
\n ready: “&aPortal is ready! You can now travel.”<\/p>\n
# Enable verbose logging for debugging
\n# Shows detailed information about portal creation, cooldowns, and player interactions
\nverbose: false
\n“`<\/p>\n
### Configuration Options<\/p>\n
| Option | Description | Default |
\n|——–|————-|———|
\n| `enable-portal-cooldown` | Enable\/disable the cooldown system | `true` |
\n| `portal-cooldown-seconds` | Default cooldown time in seconds | `10` |
\n| `overworld-cooldown-seconds` | Cooldown for portals lit in the Overworld (-1 = use default) | `-1` |
\n| `nether-cooldown-seconds` | Cooldown for portals lit in the Nether (-1 = use default) | `-1` |
\n| `messages.cooldown` | Message shown during countdown (use `{time}` for seconds remaining) | See config |
\n| `messages.ready` | Message shown when portal becomes ready | See config |
\n| `verbose` | Enable detailed logging for debugging | `false` |<\/p>\n
### Color Codes<\/p>\n
Messages support Minecraft color codes using `&`:
\n– `&0` – Black
\n– `&1` – Dark Blue
\n– `&2` – Dark Green
\n– `&3` – Dark Aqua
\n– `&4` – Dark Red
\n– `&5` – Dark Purple
\n– `&6` – Gold
\n– `&7` – Gray
\n– `&8` – Dark Gray
\n– `&9` – Blue
\n– `&a` – Green
\n– `&b` – Aqua
\n– `&c` – Red
\n– `&d` – Light Purple
\n– `&e` – Yellow
\n– `&f` – White<\/p>\n
## Commands<\/p>\n
| Command | Permission | Description |
\n|———|————|————-|
\n| `\/portalpreloader` | – | Shows plugin version and help |
\n| `\/portalpreloader reload` | `portalpreloader.reload` | Reloads the configuration |<\/p>\n
**Aliases:** `\/pp`, `\/preloader`<\/p>\n
## Permissions<\/p>\n
| Permission | Description | Default |
\n|————|————-|———|
\n| `portalpreloader.reload` | Allows reloading the plugin configuration | `op` |<\/p>\n
## How It Works<\/p>\n
### Portal Preloading
\n1. When a nether portal is lit with fire
\n2. A snowball is spawned in the center of the portal
\n3. The snowball immediately goes through the portal
\n4. This generates the destination portal before any player can teleport<\/p>\n
### Cooldown System
\n1. When a portal is created, it’s placed on cooldown
\n2. Players attempting to enter get a message showing remaining time
\n3. If a player waits inside the portal, they see countdown updates every second
\n4. When the cooldown expires, their portal timer automatically resets
\n5. Players can then teleport without leaving and re-entering<\/p>\n
### Standing in Portal Area
\n– If a player is already standing where portal blocks will appear when it’s lit
\n– They automatically get the cooldown and countdown starts
\n– This prevents bypassing the system by pre-positioning<\/p>\n
## License<\/p>\n
This project is provided as-is for use on Minecraft servers.<\/p>\n","protected":false},"excerpt":{"rendered":"
Reduces loading screens and improves the portal travel experience by beginning to load chunks as soon as a nether portal is lit<\/p>\n","protected":false},"featured_media":123998,"template":"","meta":{"_minecraft_slug":"portalpreloader","_minecraft_project_id":"8Og6SUCJ","_minecraft_author":"MistaSoup","_minecraft_license":"MIT","_minecraft_downloads":37,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"portalpreloader.zip","_minecraft_size_bytes":8737,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T21:45:42.769666Z","_minecraft_date_created":"2026-01-26T05:14:59.734918Z","_minecraft_date_modified":"2026-01-26T00:43:36.720554Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/portalpreloader","_minecraft_icon_attachment_id":123998,"_minecraft_imported_at":"2026-06-07T06:58:17+00:00","_minecraft_import_hash":"970722bf55c8da8325982dcb92583c1a","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[125,90,127,128,129,92,159],"mod_loader":[131,132,133,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-123997","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-folia","mod_category-optimization","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-utility","mod_category-worldgen","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