Skip to content

Bedrock Portal handles and creates a Minecraft Bedrock game session which will redirect players to the specified server. Features webhook support for events and debug mode for troubleshooting.

Notifications You must be signed in to change notification settings

ZayrixTheAvali/Bedrock-Portal-Egg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

🎮 Bedrock Portal for Pterodactyl

Pterodactyl Wings Node.js License

A premium Pterodactyl egg for running Bedrock Portal - Xbox Live friend list integration for Minecraft Bedrock servers

FeaturesInstallationConfiguration


🌟 Overview

Bedrock Portal for Pterodactyl is a professionally crafted egg that enables Xbox Live integration for any Minecraft Bedrock server. Built on LucienHH's Bedrock Portal, it provides seamless friend list joining without requiring server modifications or plugins.

🎯 Key Features

  • 🔐 Secure Authentication - Microsoft/Xbox Live account integration
  • 🤝 Auto Friend System - Automatically accepts friends and sends invites
  • 🔄 Auto Updates - Keep dependencies updated automatically
  • 🪝 Webhook Integration - Discord/Slack notifications for all events
  • 📊 Live Statistics - Real-time player counts and session monitoring
  • 🎨 Beautiful UI - Custom console interface with ASCII art
  • ⚡ High Performance - Optimized for minimal resource usage

📦 Installation

Prerequisites

Component Minimum Version Recommended
Pterodactyl Panel v1.11.5 Latest
Pterodactyl Wings v1.11.13 Latest
OS Ubuntu 20.04 Ubuntu 22.04
RAM 512MB 1GB+
Storage 500MB 1GB+

Quick Start

  1. Download the Egg

    wget https://raw.githubusercontent.com/Virus-Gaming/pterodactyl-bedrock-portal/main/egg-bedrock-portal.json
  2. Import to Panel

    • Navigate to Admin → Nests
    • Click Import Egg
    • Select the downloaded JSON file
  3. Create Server

    • Choose the Bedrock Portal egg
    • Configure your target server
    • Allocate resources (minimum 1GB RAM)
  4. First Run Setup

    • Start the server
    • Follow Microsoft authentication in console
    • Portal is ready!

⚙️ Configuration

Environment Variables

Variable Description Default Required
SERVER_IP Target Minecraft server IP localhost
SERVER_PORT Target Minecraft server port 19132
JOINABILITY Who can join via portal FriendsOfFriends
UPDATE_PRESENCE Show as playing Minecraft false
AUTO_UPDATE Update packages on startup false
WEBHOOK_ENABLED Enable webhook notifications false
WEBHOOK_URL Discord/Slack webhook URL
DEBUG_MODE Enable debug logging false

Joinability Options

  • FriendsOnly - Only direct friends can join
  • FriendsOfFriends - Friends and their friends can join
  • InviteOnly - Manual invites only

Webhook Events

{
  "event": "player-joined",
  "timestamp": "2024-01-01T12:00:00Z",
  "data": {
    "gamertag": "Player123",
    "xuid": "1234567890"
  }
}

Available events: session-created, player-joined, player-left, member-count-updated


Optimization Tips

  • Enable auto-update for performance improvements
  • Use webhook filtering to reduce overhead
  • Set appropriate member count update intervals
  • Monitor logs with debug mode during setup only

🔧 Troubleshooting

Common Issues

Authentication Failed
  1. Delete the auth folder
  2. Restart the server
  3. Complete Microsoft authentication again
  4. Ensure Xbox Live is enabled on your account
Players Can't Join
  1. Verify target server is online
  2. Check firewall rules
  3. Confirm joinability settings
  4. Ensure players are friends with the bot account
High Resource Usage
  1. Disable debug mode
  2. Increase update intervals
  3. Limit webhook events
  4. Allocate more RAM if needed

📊 Statistics

GitHub Stars Downloads Issues


🤝 Credits & Support

Development Team

Get Support

Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting PRs.


Made with ❤️ for the Minecraft Bedrock community

⬆ Back to Top

About

Bedrock Portal handles and creates a Minecraft Bedrock game session which will redirect players to the specified server. Features webhook support for events and debug mode for troubleshooting.

Resources

Stars

Watchers

Forks

Packages

No packages published