A PowerNukkitX plugin that broadcasts your server as a joinable session over Xbox Live. Friends of the authenticated Xbox account can find and join the server directly from Minecraft's Friends tab.
Use this project at your own risk. The contributors are not responsible for any damage or loss caused by this software. Using a separate Xbox account is recommended because the plugin emulates client functionality that may be subject to Microsoft's terms of service.
- Native PowerNukkitX plugin integration
- Automatic synchronization of MOTD and player counts
- Automatic Xbox friend and follower management
- Multi-account support
- Configurable public address and port
- Configurable WebRTC/NetherNet ICE port range
- Optional Slack or Discord notifications
- Custom Xbox profile showcase image
- Native PowerNukkitX command parameter tree and client-side suggestions
- PowerNukkitX with API 3.0.0
- Java 21 or newer
- An Xbox account that can play Minecraft
- A publicly reachable Bedrock server address and port
- Download
MCXboxBroadcast.jarfrom the latest GitHub release. - Place it in the PowerNukkitX
pluginsdirectory. - Start or restart the server.
- Wait for the plugin to display a Microsoft device-login URL and authentication code in the console.
- Open the displayed URL, enter the code, and sign in with the Xbox account that should advertise the server.
- Add or follow that account from another Xbox account.
- Open Minecraft's Friends tab. The PowerNukkitX server should appear as a joinable session.
The plugin stores its configuration and authentication data in plugins/MCXboxBroadcast/.
On its first start, the plugin creates plugins/MCXboxBroadcast/config.yml.
The most relevant session settings are:
| Setting | Description |
|---|---|
session.remote-address |
Public address advertised to joining players. auto attempts to determine it automatically. |
session.remote-port |
Public Bedrock port. auto uses the PowerNukkitX listener port. |
session.update-interval |
Interval in seconds for updating the Xbox session. Must be at least 20 seconds. |
session.ice-port-range.min |
Lowest UDP port used for WebRTC/NetherNet, or 0 for the operating-system default. |
session.ice-port-range.max |
Highest UDP port used for WebRTC/NetherNet, or 0 for the operating-system default. |
When the server is behind NAT, a proxy, or port forwarding, set remote-address and remote-port to the public values players must use. MOTD, online players, and maximum player count are read directly from PowerNukkitX.
The main command is /mcxboxbroadcast; /mcbroadcast is available as an alias.
| Command | Description |
|---|---|
/mcxboxbroadcast restart |
Recreates the Xbox Live session. |
/mcxboxbroadcast dumpsession |
Writes the current and previous session responses to JSON files for debugging. |
/mcxboxbroadcast accounts list |
Lists the active primary and sub-accounts. |
/mcxboxbroadcast accounts add <sub-session-id> |
Adds a sub-account. |
/mcxboxbroadcast accounts remove <sub-session-id> |
Removes a sub-account. |
/mcxboxbroadcast version |
Displays the installed plugin version. |
Except for version, commands can only be executed from the server console.
To use a custom showcase image for the Xbox account, place a file named screenshot.jpg in plugins/MCXboxBroadcast/ before restarting the plugin.
Recommended image properties:
- Resolution:
1200x675 - JPEG quality:
90 - Chroma subsampling:
4:2:0
Xbox Live may take several minutes to display an updated image.
Clone the repository and run:
./gradlew :bootstrap-pnx:buildThe finished plugin is created at:
bootstrap/pnx/build/libs/MCXboxBroadcast.jar
The PowerNukkitX server and protocol dependencies are used for compilation but are not included in the plugin JAR.