Index

Symbols

--cache bedrock-server-manager-cleanup command line option --debug bedrock-server-manager-web-start command line option --enable-autostart bedrock-server-manager-service-configure command line option --host bedrock-server-manager-web-start command line option --log-dir bedrock-server-manager-cleanup command line option --logs bedrock-server-manager-cleanup command line option --mode bedrock-server-manager-web-start command line option --no-enable-autostart bedrock-server-manager-service-configure command line option --password bedrock-server-manager-service-configure command line option --setup-service bedrock-server-manager-service-configure command line option --system bedrock-server-manager-service-configure command line option bedrock-server-manager-service-disable command line option bedrock-server-manager-service-enable command line option bedrock-server-manager-service-remove command line option bedrock-server-manager-service-status command line option

--username bedrock-server-manager-service-configure command line option --version bedrock-server-manager command line option -c bedrock-server-manager-cleanup command line option -d bedrock-server-manager-web-start command line option -H bedrock-server-manager-web-start command line option -l bedrock-server-manager-cleanup command line option -m bedrock-server-manager-web-start command line option -s bedrock-server-manager-service-configure command line option bedrock-server-manager-service-disable command line option bedrock-server-manager-service-enable command line option bedrock-server-manager-service-remove command line option bedrock-server-manager-service-status command line option -v bedrock-server-manager command line option

_

__init__() (bedrock_server_manager.BedrockDownloader method) (bedrock_server_manager.BedrockProcessManager method) (bedrock_server_manager.BedrockServer method) (bedrock_server_manager.BedrockServerManager method) (bedrock_server_manager.core.system.base.ResourceMonitor method) (bedrock_server_manager.Settings method) _app_data_dir (bedrock_server_manager.BedrockServerManager attribute) _app_version (bedrock_server_manager.BedrockServerManager attribute) _base_dir (bedrock_server_manager.BedrockServerManager attribute) _config_dir (bedrock_server_manager.BedrockServerManager attribute)

_content_dir (bedrock_server_manager.BedrockServerManager attribute) _expath (bedrock_server_manager.BedrockServerManager attribute) _initialized (bedrock_server_manager.core.system.base.ResourceMonitor attribute) _instance (bedrock_server_manager.core.system.base.ResourceMonitor attribute) _last_readings (bedrock_server_manager.core.system.base.ResourceMonitor attribute) _lock (bedrock_server_manager.core.system.base.ResourceMonitor attribute) _WEB_SERVER_PID_FILENAME (bedrock_server_manager.BedrockServerManager attribute) _WEB_SERVICE_SYSTEMD_NAME (bedrock_server_manager.BedrockServerManager attribute) _WEB_SERVICE_WINDOWS_DISPLAY_NAME (bedrock_server_manager.BedrockServerManager attribute) _WEB_SERVICE_WINDOWS_NAME_INTERNAL (bedrock_server_manager.BedrockServerManager attribute)

A

actual_version (bedrock_server_manager.BedrockDownloader attribute) add_players_manually_api() (in module bedrock_server_manager.api.player) add_players_to_allowlist_api() (in module bedrock_server_manager.api.server_install_config) add_server() (bedrock_server_manager.BedrockProcessManager method) add_to_allowlist() (bedrock_server_manager.BedrockServer method) after_addon_import() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_allowlist_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_autoupdate_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_backup() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_command_send() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_permission_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_player_db_scan() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_players_add() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_properties_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_prune_backups() (bedrock_server_manager.plugins.plugin_base.PluginBase method)

after_prune_download_cache() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_restore() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_server_install() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_server_start() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_server_stop() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_server_update() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_service_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_world_export() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_world_import() (bedrock_server_manager.plugins.plugin_base.PluginBase method) after_world_reset() (bedrock_server_manager.plugins.plugin_base.PluginBase method) allowlist_json_path (bedrock_server_manager.BedrockServer property) api (bedrock_server_manager.plugins.plugin_base.PluginBase attribute) app_config_dir (bedrock_server_manager.BedrockServer attribute) app_data_dir (bedrock_server_manager.Settings property) AppFileNotFoundError

B

backup_all() (in module bedrock_server_manager.api.backup_restore) backup_all_data() (bedrock_server_manager.BedrockServer method) backup_config_file() (in module bedrock_server_manager.api.backup_restore) backup_world() (in module bedrock_server_manager.api.backup_restore) BackupRestoreError base_dir (bedrock_server_manager.BedrockServer attribute) base_download_dir (bedrock_server_manager.BedrockDownloader attribute) bedrock-server-manager command line option --version -v bedrock-server-manager-cleanup command line option --cache --log-dir --logs -c -l bedrock-server-manager-service-configure command line option --enable-autostart --no-enable-autostart --password --setup-service --system --username -s bedrock-server-manager-service-disable command line option --system -s bedrock-server-manager-service-enable command line option --system -s bedrock-server-manager-service-remove command line option --system -s bedrock-server-manager-service-status command line option --system -s bedrock-server-manager-web-start command line option --debug --host --mode -d -H -m bedrock_executable_name (bedrock_server_manager.BedrockServer property) bedrock_executable_path (bedrock_server_manager.BedrockServer property) bedrock_server_manager.api.addon module bedrock_server_manager.api.application module bedrock_server_manager.api.backup_restore module bedrock_server_manager.api.info module bedrock_server_manager.api.misc module bedrock_server_manager.api.player module

bedrock_server_manager.api.plugins module bedrock_server_manager.api.server module bedrock_server_manager.api.server_install_config module bedrock_server_manager.api.system module bedrock_server_manager.api.utils module bedrock_server_manager.api.web module bedrock_server_manager.api.world module bedrock_server_manager.core.system.base module bedrock_server_manager.core.system.linux module bedrock_server_manager.core.system.process module bedrock_server_manager.core.system.windows module bedrock_server_manager.core.utils module bedrock_server_manager.error module bedrock_server_manager.plugins.plugin_base module bedrock_server_manager.plugins.plugin_manager module BedrockDownloader (class in bedrock_server_manager) BedrockProcessManager (class in bedrock_server_manager) BedrockServer (class in bedrock_server_manager) BedrockServerManager (class in bedrock_server_manager) before_addon_import() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_allowlist_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_autoupdate_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_backup() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_command_send() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_permission_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_player_db_scan() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_players_add() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_properties_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_prune_backups() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_prune_download_cache() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_restore() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_server_install() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_server_start() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_server_stop() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_server_update() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_service_change() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_world_export() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_world_import() (bedrock_server_manager.plugins.plugin_base.PluginBase method) before_world_reset() (bedrock_server_manager.plugins.plugin_base.PluginBase method) BlockedCommandError BSMError

C

capabilities (bedrock_server_manager.BedrockServerManager attribute) check_internet_connectivity() (in module bedrock_server_manager.core.system.base) check_service_exists() (in module bedrock_server_manager.core.system.linux) (in module bedrock_server_manager.core.system.windows) command (bedrock_server_manager.core.system.process.GuardedProcess attribute) CommandNotFoundError config_dir (bedrock_server_manager.Settings property) config_file_name (bedrock_server_manager.Settings attribute)

config_path (bedrock_server_manager.Settings attribute) ConfigParseError ConfigurationError configure_player_permission() (in module bedrock_server_manager.api.server_install_config) core_validate_server_name_format() (in module bedrock_server_manager.core.utils) create_systemd_service_file() (in module bedrock_server_manager.core.system.linux) create_web_ui_service() (in module bedrock_server_manager.api.web) create_windows_service() (in module bedrock_server_manager.core.system.windows)

D

default_config (bedrock_server_manager.Settings property) delete_active_world_directory() (bedrock_server_manager.BedrockServer method) delete_all_data() (bedrock_server_manager.BedrockServer method) delete_path_robustly() (in module bedrock_server_manager.core.system.base) delete_server_data() (in module bedrock_server_manager.api.server) delete_server_files() (bedrock_server_manager.BedrockServer method)

delete_windows_service() (in module bedrock_server_manager.core.system.windows) disable_systemd_service() (in module bedrock_server_manager.core.system.linux) disable_web_ui_service() (in module bedrock_server_manager.api.web) disable_windows_service() (in module bedrock_server_manager.core.system.windows) dispatch_event() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) DownloadError

E

enable_systemd_service() (in module bedrock_server_manager.core.system.linux) enable_web_ui_service() (in module bedrock_server_manager.api.web) enable_windows_service() (in module bedrock_server_manager.core.system.windows) export_addon() (bedrock_server_manager.BedrockServer method)

export_world() (in module bedrock_server_manager.api.world) export_world_directory_to_mcworld() (bedrock_server_manager.BedrockServer method) extract_mcworld_to_directory() (bedrock_server_manager.BedrockServer method) extract_server_files() (bedrock_server_manager.BedrockDownloader method) ExtractError

F

FileError

FileOperationError full_server_setup() (bedrock_server_manager.BedrockDownloader method)

G

get() (bedrock_server_manager.Settings method) get_actual_version() (bedrock_server_manager.BedrockDownloader method) get_all_known_players_api() (in module bedrock_server_manager.api.player) get_all_server_settings() (in module bedrock_server_manager.api.server) get_all_servers_data() (in module bedrock_server_manager.api.application) get_allowlist() (bedrock_server_manager.BedrockServer method) get_application_info_api() (in module bedrock_server_manager.api.application) get_autostart() (bedrock_server_manager.BedrockServer method) get_autoupdate() (bedrock_server_manager.BedrockServer method) get_bedrock_launcher_pid_file_path() (in module bedrock_server_manager.core.system.process) get_bedrock_process_info() (in module bedrock_server_manager.api.system) get_bedrock_server_pid_file_path() (in module bedrock_server_manager.core.system.process) get_custom_config_value() (bedrock_server_manager.BedrockServer method) get_fastapi_routers() (bedrock_server_manager.plugins.plugin_base.PluginBase method) get_formatted_permissions() (bedrock_server_manager.BedrockServer method) get_html_render_routes() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) get_pid_file_path() (bedrock_server_manager.BedrockServer method) (in module bedrock_server_manager.core.system.process) get_plugin_statuses() (in module bedrock_server_manager.api.plugins) get_process_info() (bedrock_server_manager.BedrockServer method) get_resolved_download_url() (bedrock_server_manager.BedrockDownloader method) get_server_allowlist_api() (in module bedrock_server_manager.api.server_install_config) get_server_config_status() (in module bedrock_server_manager.api.info) get_server_installed_version() (in module bedrock_server_manager.api.info) get_server_permissions_api() (in module bedrock_server_manager.api.server_install_config)

get_server_properties() (bedrock_server_manager.BedrockServer method) get_server_properties_api() (in module bedrock_server_manager.api.server_install_config) get_server_property() (bedrock_server_manager.BedrockServer method) get_server_running_status() (in module bedrock_server_manager.api.info) get_server_setting() (in module bedrock_server_manager.api.server) get_setting() (bedrock_server_manager.BedrockServerManager method) get_specific_download_dir() (bedrock_server_manager.BedrockDownloader method) get_static_mounts() (bedrock_server_manager.plugins.plugin_base.PluginBase method) get_stats() (bedrock_server_manager.core.system.base.ResourceMonitor method) get_status() (bedrock_server_manager.BedrockServer method) get_status_from_config() (bedrock_server_manager.BedrockServer method) get_summary_info() (bedrock_server_manager.BedrockServer method) get_system_and_app_info() (in module bedrock_server_manager.api.utils) get_systemd_service_file_path() (in module bedrock_server_manager.core.system.linux) get_target_version() (bedrock_server_manager.BedrockServer method) get_template_paths() (bedrock_server_manager.plugins.plugin_base.PluginBase method) get_verified_bedrock_process() (in module bedrock_server_manager.core.system.process) get_version() (bedrock_server_manager.BedrockServer method) get_version_for_target_spec() (bedrock_server_manager.BedrockDownloader method) get_web_server_status_api() (in module bedrock_server_manager.api.web) get_web_ui_service_status() (in module bedrock_server_manager.api.web) get_world_name() (bedrock_server_manager.BedrockServer method) (in module bedrock_server_manager.api.world) get_zip_file_path() (bedrock_server_manager.BedrockDownloader method) guard_env (bedrock_server_manager.core.system.process.GuardedProcess attribute) GuardedProcess (class in bedrock_server_manager.core.system.process)

H

has_world_icon() (bedrock_server_manager.BedrockServer method)

I

import_active_world_from_mcworld() (bedrock_server_manager.BedrockServer method) import_addon() (in module bedrock_server_manager.api.addon) import_world() (in module bedrock_server_manager.api.world) input_target_version (bedrock_server_manager.BedrockDownloader attribute) install_new_server() (in module bedrock_server_manager.api.server_install_config) install_or_update() (bedrock_server_manager.BedrockServer method)

InternetConnectivityError InvalidServerNameError is_installed() (bedrock_server_manager.BedrockServer method) is_process_running() (in module bedrock_server_manager.core.system.process) is_running() (bedrock_server_manager.BedrockServer method) is_server_running() (in module bedrock_server_manager.core.system.base) is_update_needed() (bedrock_server_manager.BedrockServer method)

L

launch_detached_process() (in module bedrock_server_manager.core.system.process) list_available_addons_api() (in module bedrock_server_manager.api.application) list_available_worlds_api() (in module bedrock_server_manager.api.application) list_backup_files() (in module bedrock_server_manager.api.backup_restore) list_backups() (bedrock_server_manager.BedrockServer method)

list_world_addons() (bedrock_server_manager.BedrockServer method) load() (bedrock_server_manager.BedrockServerManager method) (bedrock_server_manager.Settings method) load_plugins() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) logger (bedrock_server_manager.BedrockServer attribute) (bedrock_server_manager.plugins.plugin_base.PluginBase attribute)

M

MissingArgumentError modify_server_properties() (in module bedrock_server_manager.api.server_install_config) module bedrock_server_manager.api.addon bedrock_server_manager.api.application bedrock_server_manager.api.backup_restore bedrock_server_manager.api.info bedrock_server_manager.api.misc bedrock_server_manager.api.player bedrock_server_manager.api.plugins bedrock_server_manager.api.server bedrock_server_manager.api.server_install_config bedrock_server_manager.api.system bedrock_server_manager.api.utils bedrock_server_manager.api.web bedrock_server_manager.api.world bedrock_server_manager.core.system.base bedrock_server_manager.core.system.linux bedrock_server_manager.core.system.process bedrock_server_manager.core.system.windows bedrock_server_manager.core.utils bedrock_server_manager.error bedrock_server_manager.plugins.plugin_base bedrock_server_manager.plugins.plugin_manager

N

name (bedrock_server_manager.plugins.plugin_base.PluginBase attribute)

NetworkError

O

on_load() (bedrock_server_manager.plugins.plugin_base.PluginBase method) on_unload() (bedrock_server_manager.plugins.plugin_base.PluginBase method)

os_name (bedrock_server_manager.BedrockDownloader attribute) os_type (bedrock_server_manager.BedrockServer attribute)

P

permissions_json_path (bedrock_server_manager.BedrockServer property) PermissionsError PluginBase (class in bedrock_server_manager.plugins.plugin_base) PluginManager (class in bedrock_server_manager.plugins.plugin_manager) popen() (bedrock_server_manager.core.system.process.GuardedProcess method) prepare_download_assets() (bedrock_server_manager.BedrockDownloader method)

PRESERVED_ITEMS_ON_UPDATE (bedrock_server_manager.BedrockDownloader attribute) process_addon_file() (bedrock_server_manager.BedrockServer method) prune_download_cache() (in module bedrock_server_manager.api.misc) prune_old_backups() (in module bedrock_server_manager.api.backup_restore) prune_old_downloads() (in module bedrock_server_manager.core.downloader) prune_server_backups() (bedrock_server_manager.BedrockServer method)

R

read_pid_from_file() (in module bedrock_server_manager.core.system.process) register_plugin_event_listener() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) reload() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) (bedrock_server_manager.Settings method) reload_plugins() (in module bedrock_server_manager.api.plugins) remove_addon() (bedrock_server_manager.BedrockServer method) remove_from_allowlist() (bedrock_server_manager.BedrockServer method) remove_pid_file_if_exists() (in module bedrock_server_manager.core.system.process) remove_players_from_allowlist() (in module bedrock_server_manager.api.server_install_config) remove_server() (bedrock_server_manager.BedrockProcessManager method)

remove_web_ui_service() (in module bedrock_server_manager.api.web) reset_world() (in module bedrock_server_manager.api.world) resolved_download_url (bedrock_server_manager.BedrockDownloader attribute) ResourceMonitor (class in bedrock_server_manager.core.system.base) restart_server() (in module bedrock_server_manager.api.server) restore_all() (in module bedrock_server_manager.api.backup_restore) restore_all_data_from_latest() (bedrock_server_manager.BedrockServer method) restore_config_file() (in module bedrock_server_manager.api.backup_restore) restore_world() (in module bedrock_server_manager.api.backup_restore) run() (bedrock_server_manager.core.system.process.GuardedProcess method)

S

scan_and_update_player_db_api() (in module bedrock_server_manager.api.player) scan_log_for_players() (bedrock_server_manager.BedrockServer method) send_command() (bedrock_server_manager.BedrockServer method) (in module bedrock_server_manager.api.server) SendCommandError server_backup_directory (bedrock_server_manager.BedrockServer property) server_config_dir (bedrock_server_manager.BedrockServer property) server_dir (bedrock_server_manager.BedrockDownloader attribute) (bedrock_server_manager.BedrockServer attribute) server_lifecycle_manager() (in module bedrock_server_manager.api.utils) server_log_path (bedrock_server_manager.BedrockServer property) server_name (bedrock_server_manager.BedrockServer attribute) server_properties_path (bedrock_server_manager.BedrockServer property) ServerError ServerNotRunningError ServerProcessError ServerStartError ServerStopError set() (bedrock_server_manager.Settings method) set_app_context() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) set_autostart() (bedrock_server_manager.BedrockServer method) (in module bedrock_server_manager.api.system) set_autoupdate() (bedrock_server_manager.BedrockServer method) (in module bedrock_server_manager.api.system) set_custom_config_value() (bedrock_server_manager.BedrockServer method)

set_filesystem_permissions() (bedrock_server_manager.BedrockServer method) set_player_permission() (bedrock_server_manager.BedrockServer method) set_plugin_status() (in module bedrock_server_manager.api.plugins) set_server_custom_value() (in module bedrock_server_manager.api.server) set_server_folder_permissions() (in module bedrock_server_manager.core.system.base) set_server_property() (bedrock_server_manager.BedrockServer method) set_server_setting() (in module bedrock_server_manager.api.server) set_setting() (bedrock_server_manager.BedrockServerManager method) set_status_in_config() (bedrock_server_manager.BedrockServer method) set_target_version() (bedrock_server_manager.BedrockServer method) set_version() (bedrock_server_manager.BedrockServer method) settings (bedrock_server_manager.BedrockDownloader attribute) (bedrock_server_manager.BedrockServer attribute) (bedrock_server_manager.BedrockServerManager attribute) Settings (class in bedrock_server_manager) shutdown() (bedrock_server_manager.BedrockProcessManager method) specific_download_dir (bedrock_server_manager.BedrockDownloader attribute) start() (bedrock_server_manager.BedrockServer method) start_server() (in module bedrock_server_manager.api.server) start_web_server_api() (in module bedrock_server_manager.api.web) stop() (bedrock_server_manager.BedrockServer method) stop_all_servers() (in module bedrock_server_manager.api.utils) stop_server() (in module bedrock_server_manager.api.server) stop_web_server_api() (in module bedrock_server_manager.api.web) SystemError

T

terminate_process_by_pid() (in module bedrock_server_manager.core.system.process) trigger_custom_plugin_event() (bedrock_server_manager.plugins.plugin_manager.PluginManager method)

trigger_event() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) trigger_external_plugin_event_api() (in module bedrock_server_manager.api.plugins) trigger_guarded_event() (bedrock_server_manager.plugins.plugin_manager.PluginManager method)

U

unload_plugins() (bedrock_server_manager.plugins.plugin_manager.PluginManager method) update_server() (in module bedrock_server_manager.api.server_install_config)

update_server_statuses() (in module bedrock_server_manager.api.utils) UserInputError

V

validate_installation() (bedrock_server_manager.BedrockServer method) validate_server_exist() (in module bedrock_server_manager.api.utils) validate_server_name_format() (in module bedrock_server_manager.api.utils)

validate_server_property_value() (in module bedrock_server_manager.api.server_install_config) verify_process_identity() (in module bedrock_server_manager.core.system.process) version (bedrock_server_manager.plugins.plugin_base.PluginBase attribute) (bedrock_server_manager.Settings property)

W

world_icon_filename (bedrock_server_manager.BedrockServer property) world_icon_filesystem_path (bedrock_server_manager.BedrockServer property)

write_error_status() (bedrock_server_manager.BedrockProcessManager method) write_pid_to_file() (in module bedrock_server_manager.core.system.process)

Z

zip_file_path (bedrock_server_manager.BedrockDownloader attribute)