Bedrock Server Manager

Welcome to the Bedrock Server Manager documentation!

This documentation is designed to help you understand and use the Bedrock Server Manager effectively.

Browse through the sections below to find various information about Bedrock Server Manager, including general information, CLI commands, web interface, plugins, and developer documentation.

General Information

• Introduction
  • Features
  • Quick Start Guide
  • What’s Next?
• CLI Usage
  • Examples:
• Web Usage
  • Hosts:
• Plugin Support
• Troubleshooting
  • Initial Checks & Common Fixes
  • Gathering More Information
  • Reporting an Issue
  • For Developers
  • Common Issues & Important Notes
  • Platform Information

Features

• Installation & Updates
  • Installing a New Server
  • Updating Servers
  • Custom Versions
• Server Management
  • Basic Operations
  • Console Interaction
  • Resource Monitoring
• Server Configuration
  • Server Properties
  • Allowlist Management
  • Permissions
• Backup & Restore
  • Creating Backups
  • Restoring Backups
  • Automated Backups
  • Managing Backups
• Content Management
  • World Management
  • Addons (Resource & Behavior Packs)
• Application Settings
  • Global Settings
  • User Management
  • Plugin Management
  • Global Player Management
• Default Plugins
  • Lifecycle Automation
  • Notifications & Safety
  • Content Tools

Changelog

• Changelog
  • 3.8.0
  • 3.7.2
  • 3.7.1
  • 3.7.0
  • 3.6.3
  • 3.6.2
  • 3.6.1
  • 3.6.0
  • 3.5.7
  • 3.5.6
  • 3.5.5
  • 3.5.4
  • 3.5.3
  • 3.5.2
  • 3.5.1
  • 3.5.0
  • 3.4.1
  • 3.4.0
  • 3.3.1
  • 3.3.0
  • 3.2.5
  • 3.2.4
  • 3.2.3
  • 3.2.2
  • 3.2.1
  • 3.2.0
  • 3.1.4
  • 3.1.3
  • 3.1.2
  • 3.1.1
  • 3.1.0
  • 3.0.3
  • 3.0.2
  • 3.0.1
  • 3.0.0

Extras

• Installation
  • 1. Stable Version (Recommended)
  • 2. Beta / Pre-Release Versions (For Testers)
  • 3. Advanced Installation (For Developers & Contributors)
  • 4. Environment Variables
  • 5. Database Configuration
• Docker Install
  • Image Location
  • Image Tags and Versioning
  • Running the Container
  • Using Docker Compose
  • Advanced Usage
• Install Content
• Web Server
  • Themes
  • Custom Web Server Panorama
  • World Icons
  • API Client
  • Home Assistant Integration
• WebSocket Implementation
  • WebSocket Router
  • Connection Manager
  • Wildcard Subscription
  • Architecture
  • Available Topics
• Theming
  • How it Works
  • Creating a Custom Theme
  • Available Variables
  • Plugin Theming
  • Images

CLI Commands

• bedrock-server-manager
  • cleanup
  • database
  • migrate
  • reset-password
  • service
  • setup
  • web

Plugins

• Introduction to Plugins
  • How Plugins Work
  • Managing Plugins with the Web Server
  • The plugins.json Configuration File
  • Creating Your Own Plugins
• Developing Plugins
  • 1. Getting Started: Your First Plugin
  • 2. Plugin Structures: Single File vs. Package
  • 3. The PluginBase Class
  • 3. Understanding Event Hooks
  • 4. Custom Plugin Events (Inter-Plugin Communication)
  • 5. Extending Functionality: Custom FastAPI Endpoints
  • 6. Best Practices
• Available APIs
  • add_players_manually_api
  • add_players_to_allowlist_api
  • backup_all
  • backup_config_file
  • backup_world
  • configure_player_permission
  • export_world
  • get_all_global_settings
  • get_all_known_players_api
  • get_all_server_settings
  • get_all_servers_data
  • get_application_info_api
  • get_bedrock_process_info
  • get_global_setting
  • get_plugin_statuses
  • get_server_allowlist_api
  • get_server_config_status
  • get_server_installed_version
  • get_server_permissions_api
  • get_server_properties_api
  • get_server_running_status
  • get_server_setting
  • get_system_and_app_info
  • get_web_server_status
  • get_world_name
  • import_addon
  • import_world
  • install_new_server
  • list_available_addons_api
  • list_available_worlds_api
  • list_backup_files
  • modify_server_properties
  • prune_download_cache
  • prune_old_backups
  • remove_players_from_allowlist
  • reset_world
  • restart_server
  • restore_all
  • restore_config_file
  • restore_world
  • scan_and_update_player_db_api
  • send_command
  • server_lifecycle_manager
  • set_custom_global_setting
  • set_server_custom_value
  • start_server
  • stop_server
  • update_server
  • validate_server_exist
  • validate_server_name_format
  • validate_server_property_value
• Plugin Base
  • PluginBase
• Plugin Manager
  • PluginManager
• Native JSON UI for Plugins
  • How it Works
  • Available Components
  • Actions
  • Real-time Updates (WebSockets)
  • Icons

Developer Documentation

• API Documentation
  • Server API Documentation
  • Server Install & Config API Documentation
  • Backup & Restore API Documentation
  • World API Documentation
  • Addon API Documentation
  • Plugins API Documentation
  • Application API Documentation
  • Player API Documentation
  • System API Documentation
  • Web API Documentation
  • Misc API Documentation
  • Info API Documentation
  • Utils API Documentation
• Core Class Documentation
  • Settings Core Documentation
  • Bedrock Server Manager Core Documentation
  • Bedrock Server Core Documentation
  • Bedrock Downloader Core Documentation
  • Bedrock Process Manager Core Documentation
  • Resource Monitor Core Documentation
• Core Documentation
  • Error Class Documentation
  • System Base Core Documentation
  • System Process Core Documentation
  • Utils Core Documentation
  • Miscellaneous Core Documentation
  • Platform Dependent Core Documentation

Source Code: Github