Bedrock Server Manager
General Information
Introduction
CLI Usage
Web Usage
Plugin Support
Disclaimer
Changelog
Changelog
Extras
Installation
Install Content
Web Server
Theming
CLI Commands
bedrock-server-manager
bsm-api-client
Plugins
Introduction to Plugins
Developing Plugins
Available APIs
Plugin Base
Plugin Manager
Developer Documentation
API Documentation
Core Class Documentation
Core Documentation
Bedrock Server Manager
Index
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
Symbols
--autoupdate
bedrock-server-manager-system-configure-service command line option
--base-url
bsm-api-client-auth-login command line option
--cache
bedrock-server-manager-cleanup command line option
--debug
bedrock-server-manager-web-start command line option
--enable-autostart
bedrock-server-manager-system-configure-service command line option
bedrock-server-manager-web-service-configure command line option
--file
bedrock-server-manager-backup-create command line option
bedrock-server-manager-backup-restore command line option
bedrock-server-manager-install-addon command line option
bedrock-server-manager-world-install command line option
bsm-api-client-addon-install command line option
bsm-api-client-backup-create command line option
bsm-api-client-backup-restore command line option
bsm-api-client-world-install command line option
--host
bedrock-server-manager-web-start command line option
--ignore-limit
bedrock-server-manager-allowlist-add command line option
bsm-api-client-allowlist-add command line option
--key
bedrock-server-manager-server-config command line option
--level
bedrock-server-manager-permissions-set command line option
bsm-api-client-permissions-set command line option
--log-dir
bedrock-server-manager-cleanup command line option
--logs
bedrock-server-manager-cleanup command line option
--loop
bedrock-server-manager-list-servers command line option
bsm-api-client-server-list command line option
--mode
bedrock-server-manager-server-start command line option
bedrock-server-manager-web-start command line option
--no-autoupdate
bedrock-server-manager-system-configure-service command line option
--no-enable-autostart
bedrock-server-manager-system-configure-service command line option
bedrock-server-manager-web-service-configure command line option
--no-restart
bedrock-server-manager-properties-set command line option
--no-stop
bedrock-server-manager-backup-create command line option
bedrock-server-manager-backup-restore command line option
bedrock-server-manager-world-install command line option
--no-verify-ssl
bsm-api-client-auth-login command line option
--password
bsm-api-client-auth-login command line option
--payload-json
bedrock-server-manager-plugin-trigger-event command line option
bsm-api-client-plugin-trigger-event command line option
--player
bedrock-server-manager-allowlist-add command line option
bedrock-server-manager-allowlist-remove command line option
bedrock-server-manager-permissions-set command line option
bedrock-server-manager-player-add command line option
bsm-api-client-allowlist-add command line option
bsm-api-client-allowlist-remove command line option
bsm-api-client-permissions-set command line option
bsm-api-client-player-add command line option
--prop
bedrock-server-manager-properties-get command line option
bedrock-server-manager-properties-set command line option
bsm-api-client-properties-get command line option
bsm-api-client-properties-set command line option
--server
bedrock-server-manager-allowlist-add command line option
bedrock-server-manager-allowlist-list command line option
bedrock-server-manager-allowlist-remove command line option
bedrock-server-manager-backup-create command line option
bedrock-server-manager-backup-prune command line option
bedrock-server-manager-backup-restore command line option
bedrock-server-manager-install-addon command line option
bedrock-server-manager-permissions-list command line option
bedrock-server-manager-permissions-set command line option
bedrock-server-manager-properties-get command line option
bedrock-server-manager-properties-set command line option
bedrock-server-manager-server-config command line option
bedrock-server-manager-server-delete command line option
bedrock-server-manager-server-restart command line option
bedrock-server-manager-server-send-command command line option
bedrock-server-manager-server-start command line option
bedrock-server-manager-server-stop command line option
bedrock-server-manager-server-update command line option
bedrock-server-manager-system-configure-service command line option
bedrock-server-manager-system-disable-service command line option
bedrock-server-manager-system-enable-service command line option
bedrock-server-manager-system-monitor command line option
bedrock-server-manager-world-export command line option
bedrock-server-manager-world-install command line option
bedrock-server-manager-world-reset command line option
bsm-api-client-addon-install command line option
bsm-api-client-allowlist-add command line option
bsm-api-client-allowlist-list command line option
bsm-api-client-allowlist-remove command line option
bsm-api-client-backup-create command line option
bsm-api-client-backup-prune command line option
bsm-api-client-backup-restore command line option
bsm-api-client-permissions-list command line option
bsm-api-client-permissions-set command line option
bsm-api-client-properties-get command line option
bsm-api-client-properties-set command line option
bsm-api-client-server-delete command line option
bsm-api-client-server-restart command line option
bsm-api-client-server-send-command command line option
bsm-api-client-server-start command line option
bsm-api-client-server-stop command line option
bsm-api-client-server-update command line option
bsm-api-client-system-configure-service command line option
bsm-api-client-system-disable-service command line option
bsm-api-client-system-enable-service command line option
bsm-api-client-system-monitor command line option
bsm-api-client-world-export command line option
bsm-api-client-world-install command line option
bsm-api-client-world-reset command line option
--server-name
bedrock-server-manager-list-servers command line option
bsm-api-client-server-list command line option
--setup-service
bedrock-server-manager-system-configure-service command line option
bedrock-server-manager-web-service-configure command line option
--token
bsm-api-client-auth-login command line option
--type
bedrock-server-manager-backup-create command line option
bsm-api-client-backup-create command line option
--username
bsm-api-client-auth-login command line option
--value
bedrock-server-manager-server-config command line option
--verify-ssl
bsm-api-client-auth-login command line option
--version
bedrock-server-manager command line option
--yes
bedrock-server-manager-server-delete command line option
bedrock-server-manager-world-reset command line option
bsm-api-client-server-delete command line option
bsm-api-client-world-reset command line option
-c
bedrock-server-manager-cleanup command line option
-d
bedrock-server-manager-web-start command line option
-f
bedrock-server-manager-backup-create command line option
bedrock-server-manager-backup-restore command line option
bedrock-server-manager-install-addon command line option
bedrock-server-manager-world-install command line option
bsm-api-client-addon-install command line option
bsm-api-client-backup-create command line option
bsm-api-client-backup-restore command line option
bsm-api-client-world-install command line option
-H
bedrock-server-manager-web-start command line option
-k
bedrock-server-manager-server-config command line option
-l
bedrock-server-manager-cleanup command line option
bedrock-server-manager-permissions-set command line option
bsm-api-client-permissions-set command line option
-m
bedrock-server-manager-server-start command line option
bedrock-server-manager-web-start command line option
-p
bedrock-server-manager-allowlist-add command line option
bedrock-server-manager-allowlist-remove command line option
bedrock-server-manager-permissions-set command line option
bedrock-server-manager-player-add command line option
bedrock-server-manager-properties-get command line option
bedrock-server-manager-properties-set command line option
bsm-api-client-allowlist-add command line option
bsm-api-client-allowlist-remove command line option
bsm-api-client-permissions-set command line option
bsm-api-client-player-add command line option
bsm-api-client-properties-get command line option
bsm-api-client-properties-set command line option
-s
bedrock-server-manager-allowlist-add command line option
bedrock-server-manager-allowlist-list command line option
bedrock-server-manager-allowlist-remove command line option
bedrock-server-manager-backup-create command line option
bedrock-server-manager-backup-prune command line option
bedrock-server-manager-backup-restore command line option
bedrock-server-manager-install-addon command line option
bedrock-server-manager-permissions-list command line option
bedrock-server-manager-permissions-set command line option
bedrock-server-manager-properties-get command line option
bedrock-server-manager-properties-set command line option
bedrock-server-manager-server-config command line option
bedrock-server-manager-server-delete command line option
bedrock-server-manager-server-restart command line option
bedrock-server-manager-server-send-command command line option
bedrock-server-manager-server-start command line option
bedrock-server-manager-server-stop command line option
bedrock-server-manager-server-update command line option
bedrock-server-manager-system-configure-service command line option
bedrock-server-manager-system-disable-service command line option
bedrock-server-manager-system-enable-service command line option
bedrock-server-manager-system-monitor command line option
bedrock-server-manager-world-export command line option
bedrock-server-manager-world-install command line option
bedrock-server-manager-world-reset command line option
bsm-api-client-addon-install command line option
bsm-api-client-allowlist-add command line option
bsm-api-client-allowlist-list command line option
bsm-api-client-allowlist-remove command line option
bsm-api-client-backup-create command line option
bsm-api-client-backup-prune command line option
bsm-api-client-backup-restore command line option
bsm-api-client-permissions-list command line option
bsm-api-client-permissions-set command line option
bsm-api-client-properties-get command line option
bsm-api-client-properties-set command line option
bsm-api-client-server-delete command line option
bsm-api-client-server-restart command line option
bsm-api-client-server-send-command command line option
bsm-api-client-server-start command line option
bsm-api-client-server-stop command line option
bsm-api-client-server-update command line option
bsm-api-client-system-configure-service command line option
bsm-api-client-system-disable-service command line option
bsm-api-client-system-enable-service command line option
bsm-api-client-system-monitor command line option
bsm-api-client-world-export command line option
bsm-api-client-world-install command line option
bsm-api-client-world-reset command line option
-t
bedrock-server-manager-backup-create command line option
bsm-api-client-backup-create command line option
-v
bedrock-server-manager command line option
bedrock-server-manager-server-config command line option
-y
bedrock-server-manager-server-delete command line option
bedrock-server-manager-world-reset command line option
bsm-api-client-server-delete command line option
bsm-api-client-world-reset command line option
_
__init__() (bedrock_server_manager.BedrockDownloader 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_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-allowlist-add command line option
--ignore-limit
--player
--server
-p
-s
bedrock-server-manager-allowlist-list command line option
--server
-s
bedrock-server-manager-allowlist-remove command line option
--player
--server
-p
-s
bedrock-server-manager-backup-create command line option
--file
--no-stop
--server
--type
-f
-s
-t
bedrock-server-manager-backup-prune command line option
--server
-s
bedrock-server-manager-backup-restore command line option
--file
--no-stop
--server
-f
-s
bedrock-server-manager-cleanup command line option
--cache
--log-dir
--logs
-c
-l
bedrock-server-manager-install-addon command line option
--file
--server
-f
-s
bedrock-server-manager-list-servers command line option
--loop
--server-name
bedrock-server-manager-permissions-list command line option
--server
-s
bedrock-server-manager-permissions-set command line option
--level
--player
--server
-l
-p
-s
bedrock-server-manager-player-add command line option
--player
-p
bedrock-server-manager-plugin-disable command line option
PLUGIN_NAME
bedrock-server-manager-plugin-enable command line option
PLUGIN_NAME
bedrock-server-manager-plugin-trigger-event command line option
--payload-json
EVENT_NAME
bedrock-server-manager-properties-get command line option
--prop
--server
-p
-s
bedrock-server-manager-properties-set command line option
--no-restart
--prop
--server
-p
-s
bedrock-server-manager-server-config command line option
--key
--server
--value
-k
-s
-v
bedrock-server-manager-server-delete command line option
--server
--yes
-s
-y
bedrock-server-manager-server-restart command line option
--server
-s
bedrock-server-manager-server-send-command command line option
--server
-s
COMMAND_PARTS
bedrock-server-manager-server-start command line option
--mode
--server
-m
-s
bedrock-server-manager-server-stop command line option
--server
-s
bedrock-server-manager-server-update command line option
--server
-s
bedrock-server-manager-system-configure-service command line option
--autoupdate
--enable-autostart
--no-autoupdate
--no-enable-autostart
--server
--setup-service
-s
bedrock-server-manager-system-disable-service command line option
--server
-s
bedrock-server-manager-system-enable-service command line option
--server
-s
bedrock-server-manager-system-monitor command line option
--server
-s
bedrock-server-manager-web-service-configure command line option
--enable-autostart
--no-enable-autostart
--setup-service
bedrock-server-manager-web-start command line option
--debug
--host
--mode
-d
-H
-m
bedrock-server-manager-world-export command line option
--server
-s
bedrock-server-manager-world-install command line option
--file
--no-stop
--server
-f
-s
bedrock-server-manager-world-reset command line option
--server
--yes
-s
-y
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)
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
bsm-api-client-addon-install command line option
--file
--server
-f
-s
bsm-api-client-allowlist-add command line option
--ignore-limit
--player
--server
-p
-s
bsm-api-client-allowlist-list command line option
--server
-s
bsm-api-client-allowlist-remove command line option
--player
--server
-p
-s
bsm-api-client-auth-login command line option
--base-url
--no-verify-ssl
--password
--token
--username
--verify-ssl
bsm-api-client-backup-create command line option
--file
--server
--type
-f
-s
-t
bsm-api-client-backup-prune command line option
--server
-s
bsm-api-client-backup-restore command line option
--file
--server
-f
-s
bsm-api-client-permissions-list command line option
--server
-s
bsm-api-client-permissions-set command line option
--level
--player
--server
-l
-p
-s
bsm-api-client-player-add command line option
--player
-p
bsm-api-client-plugin-disable command line option
PLUGIN_NAME
bsm-api-client-plugin-enable command line option
PLUGIN_NAME
bsm-api-client-plugin-trigger-event command line option
--payload-json
EVENT_NAME
bsm-api-client-properties-get command line option
--prop
--server
-p
-s
bsm-api-client-properties-set command line option
--prop
--server
-p
-s
bsm-api-client-server-delete command line option
--server
--yes
-s
-y
bsm-api-client-server-list command line option
--loop
--server-name
bsm-api-client-server-restart command line option
--server
-s
bsm-api-client-server-send-command command line option
--server
-s
COMMAND_PARTS
bsm-api-client-server-start command line option
--server
-s
bsm-api-client-server-stop command line option
--server
-s
bsm-api-client-server-update command line option
--server
-s
bsm-api-client-system-configure-service command line option
--server
-s
bsm-api-client-system-disable-service command line option
--server
-s
bsm-api-client-system-enable-service command line option
--server
-s
bsm-api-client-system-monitor command line option
--server
-s
bsm-api-client-world-export command line option
--server
-s
bsm-api-client-world-install command line option
--file
--server
-f
-s
bsm-api-client-world-reset command line option
--server
--yes
-s
-y
BSMError
C
can_manage_services (bedrock_server_manager.BedrockServerManager property)
can_schedule_tasks (bedrock_server_manager.BedrockServerManager property)
capabilities (bedrock_server_manager.BedrockServerManager attribute)
check_internet_connectivity() (in module bedrock_server_manager.core.system.base)
check_server_status() (in module bedrock_server_manager.core.utils)
check_service_exists() (bedrock_server_manager.BedrockServer method)
(in module bedrock_server_manager.core.system.linux)
(in module bedrock_server_manager.core.system.windows)
check_systemd_service_file_exists() (bedrock_server_manager.BedrockServer method)
check_web_service_exists() (bedrock_server_manager.BedrockServerManager method)
command (bedrock_server_manager.core.system.process.GuardedProcess attribute)
COMMAND_PARTS
bedrock-server-manager-server-send-command command line option
bsm-api-client-server-send-command command line option
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_server_service() (in module bedrock_server_manager.api.system)
create_service() (bedrock_server_manager.BedrockServer method)
create_systemd_service_file() (bedrock_server_manager.BedrockServer method)
(in module bedrock_server_manager.core.system.linux)
create_web_service_file() (bedrock_server_manager.BedrockServerManager method)
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_server_service() (in module bedrock_server_manager.api.system)
disable_service() (bedrock_server_manager.BedrockServer method)
disable_systemd_service() (bedrock_server_manager.BedrockServer method)
(in module bedrock_server_manager.core.system.linux)
disable_web_service() (bedrock_server_manager.BedrockServerManager method)
disable_web_ui_service() (in module bedrock_server_manager.api.web)
disable_windows_service() (in module bedrock_server_manager.core.system.windows)
discover_and_store_players_from_all_server_logs() (bedrock_server_manager.BedrockServerManager method)
dispatch_event() (bedrock_server_manager.plugins.plugin_manager.PluginManager method)
DownloadError
E
enable_server_service() (in module bedrock_server_manager.api.system)
enable_service() (bedrock_server_manager.BedrockServer method)
enable_systemd_service() (bedrock_server_manager.BedrockServer method)
(in module bedrock_server_manager.core.system.linux)
enable_web_service() (bedrock_server_manager.BedrockServerManager method)
enable_web_ui_service() (in module bedrock_server_manager.api.web)
enable_windows_service() (in module bedrock_server_manager.core.system.windows)
EVENT_NAME
bedrock-server-manager-plugin-trigger-event command line option
bsm-api-client-plugin-trigger-event command line option
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_app_version() (bedrock_server_manager.BedrockServerManager method)
get_application_info_api() (in module bedrock_server_manager.api.application)
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_cli_commands() (bedrock_server_manager.plugins.plugin_base.PluginBase method)
get_cli_menu_items() (bedrock_server_manager.plugins.plugin_base.PluginBase method)
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_known_players() (bedrock_server_manager.BedrockServerManager method)
get_os_type() (bedrock_server_manager.BedrockServerManager 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_servers_data() (bedrock_server_manager.BedrockServerManager method)
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_user_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_executable_path() (bedrock_server_manager.BedrockServerManager method)
get_web_ui_expected_start_arg() (bedrock_server_manager.BedrockServerManager method)
get_web_ui_pid_path() (bedrock_server_manager.BedrockServerManager method)
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_service_active() (bedrock_server_manager.BedrockServer method)
is_service_enabled() (bedrock_server_manager.BedrockServer method)
is_systemd_service_active() (bedrock_server_manager.BedrockServer method)
is_systemd_service_enabled() (bedrock_server_manager.BedrockServer method)
is_update_needed() (bedrock_server_manager.BedrockServer method)
is_web_service_active() (bedrock_server_manager.BedrockServerManager method)
is_web_service_enabled() (bedrock_server_manager.BedrockServerManager method)
L
launch_detached_process() (in module bedrock_server_manager.core.system.process)
list_available_addons() (bedrock_server_manager.BedrockServerManager method)
list_available_addons_api() (in module bedrock_server_manager.api.application)
list_available_worlds() (bedrock_server_manager.BedrockServerManager method)
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.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
managed_bedrock_servers (in module bedrock_server_manager.core.system.windows)
manager_expath (bedrock_server_manager.BedrockServer attribute)
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
parse_player_cli_argument() (bedrock_server_manager.BedrockServerManager method)
permissions_json_path (bedrock_server_manager.BedrockServer property)
PermissionsError
PLUGIN_NAME
bedrock-server-manager-plugin-disable command line option
bedrock-server-manager-plugin-enable command line option
bsm-api-client-plugin-disable command line option
bsm-api-client-plugin-enable command line option
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_service() (bedrock_server_manager.BedrockServer method)
remove_systemd_service_file() (bedrock_server_manager.BedrockServer method)
remove_web_service_file() (bedrock_server_manager.BedrockServerManager 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
save_player_data() (bedrock_server_manager.BedrockServerManager method)
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_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)
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)
start_web_ui_direct() (bedrock_server_manager.BedrockServerManager method)
stop() (bedrock_server_manager.BedrockServer method)
stop_server() (in module bedrock_server_manager.api.server)
stop_web_server_api() (in module bedrock_server_manager.api.web)
systemd_service_name_full (bedrock_server_manager.BedrockServer property)
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
update_server() (in module bedrock_server_manager.api.server_install_config)
update_server_status_in_config() (in module bedrock_server_manager.core.utils)
update_server_statuses() (in module bedrock_server_manager.api.utils)
UserInputError
V
validate_installation() (bedrock_server_manager.BedrockServer method)
validate_server() (bedrock_server_manager.BedrockServerManager 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_pid_to_file() (in module bedrock_server_manager.core.system.process)
Z
zip_file_path (bedrock_server_manager.BedrockDownloader attribute)