https://github.com/thebozzz34/upnp
This simple Minecraft plugin allows your server to automatically open network ports on supported routers using UPnP.
https://github.com/thebozzz34/upnp
java minecraft-plugin upnp
Last synced: 4 months ago
JSON representation
This simple Minecraft plugin allows your server to automatically open network ports on supported routers using UPnP.
- Host: GitHub
- URL: https://github.com/thebozzz34/upnp
- Owner: TheBozzz34
- License: lgpl-3.0
- Created: 2023-12-26T01:50:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-14T17:34:09.000Z (4 months ago)
- Last Synced: 2026-02-15T01:39:35.088Z (4 months ago)
- Topics: java, minecraft-plugin, upnp
- Language: Java
- Homepage: https://www.spigotmc.org/resources/upnp-open-ports-with-ease.114033/
- Size: 102 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# UPnP
[](https://github.com/TheBozzz34/UPnP/actions/workflows/maven.yml)
## Version 2.1
This plugin allows for automatic opening of user-selectable ports on supported routers. This is accomplished via the [UPnP Protocol](https://en.wikipedia.org/wiki/Universal_Plug_and_Play). The plugin will automatically open the server port, and additional ports can be added in the config for things like dynmap. You can also choose whether the plugin automatically closes the ports when the server closes.
## Troubleshooting Options
You can enable extra troubleshooting controls in `config.yml`:
- `troubleshooting.manual-router-ip`: Optional LAN router IP override (for example `192.168.1.1`). Leave empty to use automatic gateway selection.
- `troubleshooting.verbose-logging`: Enables additional logging during gateway discovery and port mapping.
You can also control verbose logging in-game (OP/default):
- `/upnpverbose status`
- `/upnpverbose on`
- `/upnpverbose off`
- `/upnpverbose toggle`
## License
This mod is licensed under the **GNU Lesser General Public License v3.0 only (LGPL-3.0-only)**.
### What this means for users and developers
- You may use this mod in modpacks (including commercial modpacks).
- You may run this mod on servers, including paid or hosted servers.
- Other mods may depend on or integrate with this mod under any license.
- Closed-source mods and launchers may link against this mod.
### What you must do
- If you modify *this mod’s source code*, you must release those modifications
under the same LGPL-3.0-only license.
- You must allow users to replace or update this mod independently (e.g., by
distributing it as a normal JAR).
### What you do *not* have to do
- You do NOT have to open-source your entire mod, server, or modpack.
- You do NOT have to publish server source code just because players connect.
- You do NOT have to license your project under LGPL if you merely depend on this mod.
### License history
Versions released prior to **January 3rd 2026** were licensed under **AGPL-3.0-only**. You can read more about the change [here](https://github.com/TheBozzz34/UPnP/blob/main/NOTICE.md).
Versions released on or after **January 3rd 2026** are licensed under **LGPL-3.0-only**.
For the full license text, see the [LICENSE](LICENSE) file.