SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
Source-checkedAdmin & protection

World Downloader API / WDLCompanion

by pokechu22 · for Minecraft

The official implementation of the World Downloader plugin channel API

5.4KDownloads
8 yr agoLast updated
Spigot · PaperLoaders
1.16Latest game version

About World Downloader API / WDLCompanion

From SpigotMC

The official implementation of the World Downloader plugin channel API

World Downloader API / WDLCompanion


This plugin allows server owners to control the World Downloader mod (sometimes refered to as WorldDownloader, WorldDL, or WDL) on their server, using its plugin channel API. It supports a wide range of functions, from simply disabling the mod to permission requests to only allowing downloading in certain areas.

[​IMG]

What features does WDLCompanion have? Why use WDLCompanion over other plugins?


The main benefit of WDLCompanion is that it fully implements WDL's plugin channel API, rather than simply kicking players immediately upon joining (which is horrible user experience). This gives you, as a server owner, a much wider degree of control over how WDL is used.

For basic configuration, you can toggle whether WorldDL can download at all, or set more specific settings (chunk caching, saving of entities, saving of tile entities, etcetera). This configuration can be global and can also be for specific worlds on your server.

You can also use the standard bukkit permissions system to grant players permissions. Those permissions are documented here.

WDLCompanion does some custom logging logic, so messages generated by it (player login, player request) are saved both in your global server log and in a custom log as a subfolder of the server log folder. This functionality can be disabled if you desire.

This plugin also allows for permission requests. If you want to allow players to use WDL, but not without your permission, this is the easiest way of doing so. They can request permission directly from inside the mod. (This is still a work in progress and the mod side of things isn't completely done, although it is functional). Permission requests allow you to temporarily grant a player permission and will expire after a configurable amount of time.

One of the most powerful features of this plugin is chunk overrides. Chunk overrides allow you to specify areas where players are always able to download regardless of the other parts of the map. This may not seem too powerful, but the key part is that these don't have to be static areas. For simple cases, you can just put a set of coordinates in the configuration file and use those, but there is a fully-functional API for dynamically generating chunk overrides from other plugins on a player-by-player basis. For instance, if you run a factions server, you can configure it so that players are only able to download in their own faction, or in their own faction and in wilderness areas, or anything else! If a player wants to download in an area that's not covered by an existing chunk override, they can just submit a permission request.

And before you ask: Yes, I am also the developer of the World Downloader mod. This is the official implementation of the plugin channel API. It's not going to break when the mod updates.

Usage


The main way you use this plugin is editing its configuration file.

Configuration


The default configuration file (viewable here) is fully annotated, so if you are unsure about what any setting does, look there first. Additionally, incorrect configuration files will generate warnings or errors in-game, letting you know what is wrong and how to fix it.

If you just want to disable World Downloader, all you need to do is set canDownloadInGeneral to false. That's all you need to do. (The other settings can remain true or false; if canDownloadInGeneral is false they are inferred to be false). Players will still be able to join, and can request permission still. I recommend that you set requestMessage to something for players who are requesting, so that they know your rules regarding use of the mod. You will need to reload the configuration using /wdl reload after making changes to it.

If you want to configure something for a specific world, edit the per-world tag. Inside of it, first put the world name (as it would appear in the world folder), and then put keys from the general configuration file there. If a value is not set in the per-world secion, the global value is used instead. If the world has multiple dimensions, you will need to specify all dimensions for the world name.

For chunk overrides, the configuration is a bit more complicated. (Also, note that as of version 1.1.0, the default configuration documentation for chunk overrides is incorrect). By default, there are two types of chunk overrides: ChunkRange and

Read the full description on SpigotMC →

Highlights

From source data

Game versions

Supports 9 Minecraft versions, the newest being 1.16.

Loaders

Runs on Spigot and Paper.

Footprint

Rated a light load on a server.

World Downloader API / WDLCompanion on Nxeon

From our catalogue
One-click install
Supported on Nxeon Minecraft servers, for Paper servers. We download it from SpigotMC, place it, and restart the server.
Server side
Required on the server
Server type needed
Spigot, Paper
Server load
light
Smallest plan we suggest
Minecraft — 1.5 GB (2 GB RAM). This follows our own load rating above, not a benchmark.
Latest build
1.2.0, released 2018-07-21

Game versions by loader

LoaderGame versionsNewest
Paper1.8 to 1.16 (9 versions)1.16
Spigot1.8 to 1.16 (9 versions)1.16

From 6 recorded builds of World Downloader API / WDLCompanion.

Recent builds

BuildReleasedGame versionsLoaders
1.2.02018-07-211.8 to 1.16 (9 versions)Spigot, Paper
1.1.42017-11-11n/aSpigot, Paper
1.1.32017-06-02n/aSpigot, Paper
1.1.22016-06-19n/aSpigot, Paper
1.1.12016-03-17n/aSpigot, Paper
1.1.02016-03-13n/aSpigot, Paper

Run World Downloader API / WDLCompanion on a Minecraft server

Pick a server or deploy a new one above; it is installed in one click.

What kind of mod it is

From the catalog
Listed on SpigotMC as “Admin”

Admin & protection

Permissions, moderation, anti-cheat and land protection for the people running the server.

Runs on your server

From source side support

SpigotMC lists World Downloader API / WDLCompanion as required on the server. Check its SpigotMC page to see whether players need it too.

Compatibility

Game
Minecraft
Loaders
SpigotPaper
Runs on
Serverrequired on the server
Game versions
1.16 and 8 earlier
Requires
One-click install needs a Paper server.

Verified at the source

  • ✓SpigotMCOfficial listing, checked 2026-10-16Open ↗
  • ✓Authorpokechu22, as published on SpigotMC
  • ✓LicenseNot published by the sourceFree

World Downloader API / WDLCompanion, answered

Generated from the mod’s own source data.

Do my players need to install World Downloader API / WDLCompanion?

SpigotMC lists World Downloader API / WDLCompanion as required on the server. Check its SpigotMC page to see whether players need it too.

Which loaders does it support?

Spigot and Paper.

Is it free?

Yes. World Downloader API / WDLCompanion is free to download from SpigotMC.

How do I add it to my Nxeon server?

Use “Add to a server” on this page, or open NxLabs from your dashboard. We install it, restart your server and switch it on.

NxLabs

Run World Downloader API / WDLCompanion on a Minecraft server.

Deploy in about a minute from $4.20 a month, then add World Downloader API / WDLCompanion in one click.