mcipc.rcon.be package

Subpackages

Submodules

mcipc.rcon.be.client module

Client implementation for Bedrock Edition.

class mcipc.rcon.be.client.Client(host: str, port: int, *, timeout: float | None = None, passwd: str | None = None)

Bases: Client

RCON client for the Bedrock Edition.

ability(player: str, ability: Ability | str | None = None, value: bool | None = None) → str

Sets or queries player with a specific ability.

property camerashake: CamerashakeProxy

Delegates to a mcipc.rcon.be.commands.camerashake.CamerashakeProxy

clear(player: str | None = None, item_name: str | None = None, data: int | None = None, max_count: int | None = None) → str

Clears items from player inventory, including items being dragged by the player. Bedrock Edition implementation.

clearspawnpoint(player: str | None = None) → str

Used to remove spawnpoints in the world.

clone(begin: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, end: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, *, mask_mode: MaskMode | str | None = None, clone_mode: CloneMode | str | None = None, tile_name: str | None = None, tile_data: int | None = None) → str

Clones blocks from one region to another.

connect(server_uri: str) → str

Connect to designated WebSocket server.

deop(player: str) → str

Revokes operator status from the respective player.

difficulty(difficulty: Difficulty | str | int) → str

Sets the difficulty.

effect(player: str, effect_or_clear: str, seconds: int | None = None, amplifier: int | None = None, hide_particles: bool | None = None) → str

Returns a proxy for available sub-commands.

enchant(player: str, enchantment: Enchantment | str | int, level: int | None = None) → str

Enchants the given player.

property event: EventProxy

Delegates to a mcipc.rcon.be.commands.event.EventProxy

property execute: ExecuteProxy

Delegates to a mcipc.rcon.commands.execute.ExecuteProxy

experience(amount: int, player: str) → str

Gives the player the specified amount of XP.

fill(from_: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, to: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, block: str, tile_data: int | None = None, old_block_handling: FillMode | str | None = None, replace_tile_name: str | None = None, replace_data_value: str | None = None) → str

Fills all or parts of a region with a specific block.

fog(victim: str) → FogProxy

Delegates to a mcipc.rcon.be.commands.fog.Proxy

function(name: Path | str) → str

Runs the given function.

gamemode(mode: GameMode | str | int, target: str | None = None) → str

Sets the game mode.

gamerule(rule: str, value: bool | int | None = None) → str

Sets or queries a game rule value.

give(target: str, item: str, amount: int | None = None, data: int | None = None, components: dict | None = None) → str

Gives an item to one or more players.

help(command_or_page: str | int | None = None) → str

Returns help about commands.

kick(player: str, *reasons: str) → KickedPlayer

Kicks the respective player.

kill(targets: str)

Kills the targets.

list() → str

Returns the players.

locate(structure: Structure | str) → str

Locates the respective structure.

me(message: str) → str

Sends a message from RCON in first-person perspective.

mixer() → str

Mixer control.

mobevent(event: str, value: bool | None = None) → str

Controls or queries what mob events are allowed to run.

msg(player: str, message: str) → str

Whispers a message to the respective player.

property music: MusicProxy

Delegates to a mcipc.rcon.be.commands.music.MusicProxy

op(player: str) → str

Makes the respective player an operator.

particle(effect: str, position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str) → str

Creates the respective particles.

playanimation(entity: str, animation: str, next_state: str | None = None, blend_out_time: float | None = None, stop_expression: str | None = None, controller: str | None = None) → str

Makes one or more entities play a one-off animation.

playsound(sound: str, player: str | None = None, position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, volume: float | None = None, minimum_volume: float | None = None) → str

Plays a sound.

reload() → str

Reloads data packs in Java Edition and functions in behavior packs in Bedrock Edition.

property replaceitem: ReplaceitemProxy

Delegates to a mcipc.rcon.be.commands.replaceitem.ReplaceitemProxy

ride(riders_or_rides: str) → RideProxy

Delegates to a mcipc.rcon.be.commands.ride.RideProxy

save(command: SaveCommand | str) → str

Issues the specified save command.

say(message: str) → str

Broadcast a message to all players.

property schedule: ScheduleProxy

Delegates to a mcipc.rcon.be.commands.schedule.ScheduleProxy

property scoreboard: ScoreboardProxy

Delegates to a mcipc.rcon.be.commands.scoreboard.ScoreboardProxy

send_url(player: str, url: str, text: str | None = None) → str

Sends a URL to the specified player. If no text is specified, it will default to the original URL.

setblock(position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, tile_name: str, tile_data: int | None = None, mode: SetblockMode | str | None = None) → str

Sets a block.

setmaxplayers(max_players: int) → str

Sets the maximally allowed players on the server.

setworldspawn(spawn_point: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None) → str

Sets the world spawn.

spawnpoint(player: str | None = None, spawn_pos: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None) → str

Sets the spawn point for a player.

spreadplayers(x: float | str, y: float | str, spread_distance: float, max_range: float, victim: str) → str

Spreads players.

stopsound(player: str, sound: str | None = None) → str

Stops playing a sound.

property structure: StructureProxy

Delegates to a mcipc.rcon.be.commands.structure.StructureProxy

summon(entity_type: str, spawn_pos: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, spawn_event: str | None = None, name_tag: str | None = None) → str

Summons an entity.

tag(targets: str) → TagProxy

Delegates to a command proxy.

teleport(*, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, victim: str | None = None, check_for_blocks: bool | None = None, y_rot: float | str | None = None, x_rot: float | str | None = None, look_at_position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, look_at_entity: str | None = None) → str

Teleports the player.

tell(player: str, message: str) → str

Whispers a message to the respective player.

tellraw(player: str, obj: dict) → str

Sends a message represented by a JSON-ish dict.

testfor(victim: str) → str

Counts entities matching specified conditions.

testforblock(position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, tile_name: str, data_value: int | None = None) → str

Tests whether a certain block is in a specific location.

testforblocks(begin: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, end: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, match_mode: MatchMode | str | None = None) → str

Tests whether the blocks in two regions match.

property tickingarea: TickingareaProxy

Delegates to a mcipc.rcon.be.commands.tickingarea.TickingareaProxy

property time: TimeProxy

Delegates to a mcipc.rcon.be.commands.time.TimeProxy

title(player: str) → TitleProxy

Delegates to a mcipc.rcon.be.commands.title.TitleProxy

toggledownfall() → str

Toggles downfall.

tp(*, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, victim: str | None = None, check_for_blocks: bool | None = None, y_rot: float | str | None = None, x_rot: float | str | None = None, look_at_position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, look_at_entity: str | None = None) → str

Teleports the player.

transferserver(server: str, port: int) → str

Transfer player to another server.

w(player: str, message: str) → str

Whispers a message to the respective player.

wb() → str

Toggles the world builder feature.

property weather: WeatherProxy

Delegates to a mcipc.rcon.be.commands.weather.WeatherProxy

property whitelist: WhitelistProxy

Delegates to a mcipc.rcon.commands.whitelist.WhitelistProxy

worldbuilder() → str

Toggles the world builder feature.

wsserver(server_uri: str) → str

Connect to designated WebSocket server.

xp(amount: int, player: str) → str

Gives the player the specified amount of XP.

mcipc.rcon.be.enumerations module

Enumerations specific to the Bedrock Edition.

class mcipc.rcon.be.enumerations.Biome(value)

Bases: str, Enum

Available biomes in the Bedrock Edition.

BADLANDS = 'mesa'
BADLANDS_PLATEAU = 'mesa_plateau'
BAMBOO_JUNGLE = 'bamboo_jungle'
BAMBOO_JUNGLE_HILLS = 'bamboo_jungle_hills'
BASALT_DELTAS = 'basalt_deltas'
BEACH = 'beach'
BIRCH_FOREST = 'birch_forest'
BIRCH_FOREST_HILLS = 'birch_forest_hills'
COLD_OCEAN = 'cold_ocean'
CRIMSON_FOREST = 'crimson_forest'
DARK_FOREST = 'roofed_forest'
DARK_FOREST_HILLS = 'roofed_forest_mutated'
DEEP_COLD_OCEAN = 'deep_cStructureAnimationModeold_ocean'
DEEP_FROZEN_OCEAN = 'deep_frozen_ocean'
DEEP_LUKEWARN_OCEAN = 'deep_lukewarm_ocean'
DEEP_OCEAN = 'deep_ocean'
DEEP_WARM_OCEAN = 'deep_warm_ocean'
DESERT = 'desert'
DESERT_HILLS = 'desert_hills'
DESERT_LAKES = 'desert_mutated'
ERODED_BADLANDS = 'mesa_bryce'
FLOWER_FOREST = 'flower_forest'
FOREST = 'forest'
FROZEN_OCEAN = 'frozen_ocean'
FROZEN_RIVER = 'frozen_river'
GIANT_SPRUCE_TAIGA = 'redwood_taiga_mutated'
GIANT_SPRUCE_TAIGA_HILLS = 'redwood_taiga_hills_mutated'
GIANT_TREE_TAIGA = 'mega_taiga'
GIANT_TREE_TAIGA_HILLS = 'mega_taiga_hills'
GRAVELLY_MOUNTAINS = 'extreme_hills_mutated'
GRAVELLY_MOUNTAINS_PLUS = 'extreme_hills_plus_trees_mutated'
ICE_SPIKES = 'ice_plains_spikes'
JUNGLE = 'jungle'
JUNGLE_EDGE = 'jungle_edge'
JUNGLE_HILLS = 'jungle_hills'
LEGACY_FROZEN_OCEAN = 'legacy_frozen_ocean'
LUKEWARM_OCEAN = 'lukewarm_ocean'
MODIFIED_BADLANDS_PLATEAU = 'mesa_plateau_mutated'
MODIFIED_JUNGLE = 'jungle_mutated'
MODIFIED_JUNGLE_EDGE = 'jungle_edge_mutated'
MODIFIED_WOODED_BADLANDS_PLATEAU = 'mesa_plateau_stone_mutated'
MOUNTAINS = 'extreme_hills'
MOUNTAIN_EDGE = 'extreme_hills_edge'
MUSHROOM_FIELDS = 'mushroom_island'
MUSHROOM_FIELD_SHORE = 'mushroom_island_shore'
NETHER_WASTES = 'hell'
OCEAN = 'ocean'
PLAINS = 'plains'
RIVER = 'river'
SAVANNA = 'savanna'
SAVANNA_PLATEAU = 'savanna_plateau'
SHATTERED_SAVANNA = 'savanna_mutated'
SHATTERED_SAVANNA_PLATEAU = 'savanna_plateau_mutated'
SNOWY_BEACH = 'cold_beach'
SNOWY_MOUNTAINS = 'ice_mountains'
SNOWY_TAIGA = 'cold_taiga'
SNOWY_TAIGA_HILLS = 'cold_taiga_hills'
SNOWY_TAIGA_MOUNTAINS = 'cold_taiga_mutated'
SNOWY_TUNDRA = 'ice_plains'
SOUL_SAND_VALLEY = 'soul_sand_valley'
STONE_SHORE = 'stone_beach'
SUNFLOWER_PLAINS = 'sunflower_plains'
SWAMP = 'swampland'
SWAMP_HILLS = 'swampland_mutated'
TAIGA = 'taiga'
TAIGA_HILLS = 'taiga_hills'
TAIGA_MOUNTAINS = 'taiga_mutated'
TALL_BIRCH_FOREST = 'birch_forest_mutated'
TALL_BIRCH_HILLS = 'birch_forest_hills_mutated'
THE_END = 'the_end'
WARM_OCEAN = 'warm_ocean'
WARPED_FOREST = 'warped_forest'
WOODED_BADLANDS_PLATEAU = 'mesa_plateau_stone'
WOODED_HILLS = 'forest_hills'
WOODED_MOUNTAINS = 'extreme_hills_plus_trees'
class mcipc.rcon.be.enumerations.Enchantment(value)

Bases: str, Enum

Available enchantments in the Bedrock Edition.

AQUA_AFFINITY = 'aqua_affinity'
BANE_OF_ARTHROPODS = 'bane_of_arthropods'
BLAST_PROTECTION = 'blast_protection'
CHANNELING = 'channeling'
CLEAVING = 'cleaving'
CURSE_OF_BINDING = 'binding'
CURSE_OF_VANISHING = 'vanishing'
DEPTH_STRIDER = 'depth_strider'
EFFICIENCY = 'efficiency'
FEATHER_FALLING = 'feather_falling'
FIRE_ASPECT = 'fire_aspect'
FIRE_PROTECTION = 'fire_protection'
FLAME = 'flame'
FORTUNE = 'fortune'
FROST_WALKER = 'frost_walker'
IMPALING = 'impaling'
INFINITY = 'infinity'
KNOCKBACK = 'knockback'
LOOTING = 'looting'
LOYALTY = 'loyalty'
LUCK_OF_THE_SEA = 'luck_of_the_sea'
LURE = 'lure'
MENDING = 'mending'
MULTISHOT = 'multishot'
PIERCING = 'piercing'
POWER = 'power'
PROJECTILE_PROTECTION = 'projectile_protection'
PROTECTION = 'protection'
PUNCH = 'punch'
QUICK_CHARGE = 'quick_charge'
RESPIRATION = 'respiration'
RIPTIDE = 'riptide'
SHARPNESS = 'sharpness'
SILK_TOUCH = 'silk_touch'
SMITE = 'smite'
SOUL_SPEED = 'soul_speed'
SWEEPING = 'sweeping'
THORNS = 'thorns'
UNBREAKING = 'unbreaking'
class mcipc.rcon.be.enumerations.EntityEquipmentSlot(value)

Bases: str, Enum

Available entity equipment slots.

ARMOR_CHEST = 'armor.chest'
ARMOR_FEET = 'armor.feet'
ARMOR_HEAD = 'armor.head'
ARMOR_LEGS = 'armor.legs'
CONTAINER_SLOT = '<built-in method format of str object>'
ENDERCHEST_SLOT = '<built-in method format of str object>'
HORSE_ARMOR = 'horse.armor'
HORSE_CHEST = 'horse.chest'
HORSE_SADDLE = 'horse.saddle'
HORSE_SLOT = '<built-in method format of str object>'
HOTBAR_SLOT = '<built-in method format of str object>'
INVENTORY_SLOT = '<built-in method format of str object>'
VILLAGER_SLOT = '<built-in method format of str object>'
WEAPON = 'weapon'
WEAPON_MAINHAND = 'weapon.mainhand'
WEAPON_OFFHAND = 'weapon.offhand'
class mcipc.rcon.be.enumerations.FillType(value)

Bases: str, Enum

Available fill types.

IF_GROUP_FITS = 'if_group_fits'
UNTIL_FULL = 'until_full'
class mcipc.rcon.be.enumerations.Location(value)

Bases: str, Enum

Available locations.

BELOWNAME = 'belowname'
LIST = 'list'
SIDEBAR = 'sidebar'
class mcipc.rcon.be.enumerations.MatchMode(value)

Bases: str, Enum

Available block matching modes.

ALL = 'all'
MASKED = 'masked'
class mcipc.rcon.be.enumerations.Mirror(value)

Bases: str, Enum

Available mirror modes.

NONE = 'none'
X = 'x'
XZ = 'xz'
Z = 'z'
class mcipc.rcon.be.enumerations.MusicRepeatMode(value)

Bases: str, Enum

Available music repeat modes.

LOOP = 'loop'
PLAY_ONCE = 'play_once'
class mcipc.rcon.be.enumerations.Operator(value)

Bases: str, Enum

Available operators.

ADDITION = '+'
ASSIGN = '='
DIVISION = '/'
MAX = '>'
MIN = '<'
MODULO = '%'
MULTIPLICATION = '*'
SUBTRACTION = '-'
SWAP = '><'
class mcipc.rcon.be.enumerations.Order(value)

Bases: str, Enum

Available orderings.

ASCENDING = 'ascending'
DESCENDING = 'descending'
class mcipc.rcon.be.enumerations.ReplaceMode(value)

Bases: str, Enum

Available replace modes.

DESTROY = 'destroy'
KEEP = 'keep'
class mcipc.rcon.be.enumerations.RideRules(value)

Bases: str, Enum

Available ride rules.

NO_RIDE_CHANGE = 'no_ride_change'
REASSIGN_RIDES = 'reassign_rides'
SKIP_RIDERS = 'skip_riders'
class mcipc.rcon.be.enumerations.Rotation(value)

Bases: str, Enum

Available rotation modes.

DEG_0 = '0_degrees'
DEG_180 = '180_degrees'
DEG_270 = '270_degrees'
DEG_90 = '90_degrees'
class mcipc.rcon.be.enumerations.SaveCommand(value)

Bases: str, Enum

Available save commands.

HOLD = 'hold'
QUERY = 'query'
RESUME = 'resume'
class mcipc.rcon.be.enumerations.Structure(value)

Bases: str, Enum

Available structures in the Bedrock Edition.

BASTION_REMNANT = 'bastionremnant'
BURIED_TREASURE = 'buriedtreasure'
DESERT_PYRAMID = 'temple'
END_CITY = 'endcity'
FORTRESS = 'fortress'
IGLOO = 'temple'
JUNGLE_PYRAMID = 'temple'
MINESHAFT = 'mineshaft'
MONUMENT = 'monument'
OCEAN_RUINS = 'ruins'
PILLAGER_OUTPOST = 'pillageroutpost'
RUINED_PORTAL = 'ruinedportal'
SHIPWRECK = 'shipwreck'
STRONGHOLD = 'stronghold'
SWAMP_HUT = 'temple'
VILLAGE = 'village'
WOODLAND_MANSION = 'mansion'
class mcipc.rcon.be.enumerations.StructureAnimationMode(value)

Bases: str, Enum

Available structure animations.

BLOCK_BY_BLOCK = 'block_by_block'
LAYER_BY_LAYER = 'layer_by_layer'
class mcipc.rcon.be.enumerations.StructureSaveMode(value)

Bases: str, Enum

Available structure save modes.

DISK = 'disk'
MEMORY = 'memory'
class mcipc.rcon.be.enumerations.TeleportRules(value)

Bases: str, Enum

Available teleportation rules.

TELEPORT_RIDE = 'teleport_ride'
TELEPORT_RIDER = 'teleport_rider'
class mcipc.rcon.be.enumerations.TimeSpec(value)

Bases: str, Enum

Available time specifications.

DAY = 'day'
MIDNIGHT = 'midnight'
NIGHT = 'night'
NOON = 'noon'
SUNRISE = 'sunrise'
SUNSET = 'sunset'

mcipc.rcon.be.types module

Types for client -> Bedrock Edition server communication.

Module contents

RCON implementation for the Bedrock Edition server.

class mcipc.rcon.be.Biome(value)

Bases: str, Enum

Available biomes in the Bedrock Edition.

BADLANDS = 'mesa'
BADLANDS_PLATEAU = 'mesa_plateau'
BAMBOO_JUNGLE = 'bamboo_jungle'
BAMBOO_JUNGLE_HILLS = 'bamboo_jungle_hills'
BASALT_DELTAS = 'basalt_deltas'
BEACH = 'beach'
BIRCH_FOREST = 'birch_forest'
BIRCH_FOREST_HILLS = 'birch_forest_hills'
COLD_OCEAN = 'cold_ocean'
CRIMSON_FOREST = 'crimson_forest'
DARK_FOREST = 'roofed_forest'
DARK_FOREST_HILLS = 'roofed_forest_mutated'
DEEP_COLD_OCEAN = 'deep_cStructureAnimationModeold_ocean'
DEEP_FROZEN_OCEAN = 'deep_frozen_ocean'
DEEP_LUKEWARN_OCEAN = 'deep_lukewarm_ocean'
DEEP_OCEAN = 'deep_ocean'
DEEP_WARM_OCEAN = 'deep_warm_ocean'
DESERT = 'desert'
DESERT_HILLS = 'desert_hills'
DESERT_LAKES = 'desert_mutated'
ERODED_BADLANDS = 'mesa_bryce'
FLOWER_FOREST = 'flower_forest'
FOREST = 'forest'
FROZEN_OCEAN = 'frozen_ocean'
FROZEN_RIVER = 'frozen_river'
GIANT_SPRUCE_TAIGA = 'redwood_taiga_mutated'
GIANT_SPRUCE_TAIGA_HILLS = 'redwood_taiga_hills_mutated'
GIANT_TREE_TAIGA = 'mega_taiga'
GIANT_TREE_TAIGA_HILLS = 'mega_taiga_hills'
GRAVELLY_MOUNTAINS = 'extreme_hills_mutated'
GRAVELLY_MOUNTAINS_PLUS = 'extreme_hills_plus_trees_mutated'
ICE_SPIKES = 'ice_plains_spikes'
JUNGLE = 'jungle'
JUNGLE_EDGE = 'jungle_edge'
JUNGLE_HILLS = 'jungle_hills'
LEGACY_FROZEN_OCEAN = 'legacy_frozen_ocean'
LUKEWARM_OCEAN = 'lukewarm_ocean'
MODIFIED_BADLANDS_PLATEAU = 'mesa_plateau_mutated'
MODIFIED_JUNGLE = 'jungle_mutated'
MODIFIED_JUNGLE_EDGE = 'jungle_edge_mutated'
MODIFIED_WOODED_BADLANDS_PLATEAU = 'mesa_plateau_stone_mutated'
MOUNTAINS = 'extreme_hills'
MOUNTAIN_EDGE = 'extreme_hills_edge'
MUSHROOM_FIELDS = 'mushroom_island'
MUSHROOM_FIELD_SHORE = 'mushroom_island_shore'
NETHER_WASTES = 'hell'
OCEAN = 'ocean'
PLAINS = 'plains'
RIVER = 'river'
SAVANNA = 'savanna'
SAVANNA_PLATEAU = 'savanna_plateau'
SHATTERED_SAVANNA = 'savanna_mutated'
SHATTERED_SAVANNA_PLATEAU = 'savanna_plateau_mutated'
SNOWY_BEACH = 'cold_beach'
SNOWY_MOUNTAINS = 'ice_mountains'
SNOWY_TAIGA = 'cold_taiga'
SNOWY_TAIGA_HILLS = 'cold_taiga_hills'
SNOWY_TAIGA_MOUNTAINS = 'cold_taiga_mutated'
SNOWY_TUNDRA = 'ice_plains'
SOUL_SAND_VALLEY = 'soul_sand_valley'
STONE_SHORE = 'stone_beach'
SUNFLOWER_PLAINS = 'sunflower_plains'
SWAMP = 'swampland'
SWAMP_HILLS = 'swampland_mutated'
TAIGA = 'taiga'
TAIGA_HILLS = 'taiga_hills'
TAIGA_MOUNTAINS = 'taiga_mutated'
TALL_BIRCH_FOREST = 'birch_forest_mutated'
TALL_BIRCH_HILLS = 'birch_forest_hills_mutated'
THE_END = 'the_end'
WARM_OCEAN = 'warm_ocean'
WARPED_FOREST = 'warped_forest'
WOODED_BADLANDS_PLATEAU = 'mesa_plateau_stone'
WOODED_HILLS = 'forest_hills'
WOODED_MOUNTAINS = 'extreme_hills_plus_trees'
class mcipc.rcon.be.Client(host: str, port: int, *, timeout: float | None = None, passwd: str | None = None)

Bases: Client

RCON client for the Bedrock Edition.

ability(player: str, ability: Ability | str | None = None, value: bool | None = None) → str

Sets or queries player with a specific ability.

property camerashake: CamerashakeProxy

Delegates to a mcipc.rcon.be.commands.camerashake.CamerashakeProxy

clear(player: str | None = None, item_name: str | None = None, data: int | None = None, max_count: int | None = None) → str

Clears items from player inventory, including items being dragged by the player. Bedrock Edition implementation.

clearspawnpoint(player: str | None = None) → str

Used to remove spawnpoints in the world.

clone(begin: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, end: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, *, mask_mode: MaskMode | str | None = None, clone_mode: CloneMode | str | None = None, tile_name: str | None = None, tile_data: int | None = None) → str

Clones blocks from one region to another.

connect(server_uri: str) → str

Connect to designated WebSocket server.

deop(player: str) → str

Revokes operator status from the respective player.

difficulty(difficulty: Difficulty | str | int) → str

Sets the difficulty.

effect(player: str, effect_or_clear: str, seconds: int | None = None, amplifier: int | None = None, hide_particles: bool | None = None) → str

Returns a proxy for available sub-commands.

enchant(player: str, enchantment: Enchantment | str | int, level: int | None = None) → str

Enchants the given player.

property event: EventProxy

Delegates to a mcipc.rcon.be.commands.event.EventProxy

property execute: ExecuteProxy

Delegates to a mcipc.rcon.commands.execute.ExecuteProxy

experience(amount: int, player: str) → str

Gives the player the specified amount of XP.

fill(from_: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, to: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, block: str, tile_data: int | None = None, old_block_handling: FillMode | str | None = None, replace_tile_name: str | None = None, replace_data_value: str | None = None) → str

Fills all or parts of a region with a specific block.

fog(victim: str) → FogProxy

Delegates to a mcipc.rcon.be.commands.fog.Proxy

function(name: Path | str) → str

Runs the given function.

gamemode(mode: GameMode | str | int, target: str | None = None) → str

Sets the game mode.

gamerule(rule: str, value: bool | int | None = None) → str

Sets or queries a game rule value.

give(target: str, item: str, amount: int | None = None, data: int | None = None, components: dict | None = None) → str

Gives an item to one or more players.

help(command_or_page: str | int | None = None) → str

Returns help about commands.

kick(player: str, *reasons: str) → KickedPlayer

Kicks the respective player.

kill(targets: str)

Kills the targets.

list() → str

Returns the players.

locate(structure: Structure | str) → str

Locates the respective structure.

me(message: str) → str

Sends a message from RCON in first-person perspective.

mixer() → str

Mixer control.

mobevent(event: str, value: bool | None = None) → str

Controls or queries what mob events are allowed to run.

msg(player: str, message: str) → str

Whispers a message to the respective player.

property music: MusicProxy

Delegates to a mcipc.rcon.be.commands.music.MusicProxy

op(player: str) → str

Makes the respective player an operator.

particle(effect: str, position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str) → str

Creates the respective particles.

playanimation(entity: str, animation: str, next_state: str | None = None, blend_out_time: float | None = None, stop_expression: str | None = None, controller: str | None = None) → str

Makes one or more entities play a one-off animation.

playsound(sound: str, player: str | None = None, position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, volume: float | None = None, minimum_volume: float | None = None) → str

Plays a sound.

reload() → str

Reloads data packs in Java Edition and functions in behavior packs in Bedrock Edition.

property replaceitem: ReplaceitemProxy

Delegates to a mcipc.rcon.be.commands.replaceitem.ReplaceitemProxy

ride(riders_or_rides: str) → RideProxy

Delegates to a mcipc.rcon.be.commands.ride.RideProxy

save(command: SaveCommand | str) → str

Issues the specified save command.

say(message: str) → str

Broadcast a message to all players.

property schedule: ScheduleProxy

Delegates to a mcipc.rcon.be.commands.schedule.ScheduleProxy

property scoreboard: ScoreboardProxy

Delegates to a mcipc.rcon.be.commands.scoreboard.ScoreboardProxy

send_url(player: str, url: str, text: str | None = None) → str

Sends a URL to the specified player. If no text is specified, it will default to the original URL.

setblock(position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, tile_name: str, tile_data: int | None = None, mode: SetblockMode | str | None = None) → str

Sets a block.

setmaxplayers(max_players: int) → str

Sets the maximally allowed players on the server.

setworldspawn(spawn_point: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None) → str

Sets the world spawn.

spawnpoint(player: str | None = None, spawn_pos: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None) → str

Sets the spawn point for a player.

spreadplayers(x: float | str, y: float | str, spread_distance: float, max_range: float, victim: str) → str

Spreads players.

stopsound(player: str, sound: str | None = None) → str

Stops playing a sound.

property structure: StructureProxy

Delegates to a mcipc.rcon.be.commands.structure.StructureProxy

summon(entity_type: str, spawn_pos: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, spawn_event: str | None = None, name_tag: str | None = None) → str

Summons an entity.

tag(targets: str) → TagProxy

Delegates to a command proxy.

teleport(*, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, victim: str | None = None, check_for_blocks: bool | None = None, y_rot: float | str | None = None, x_rot: float | str | None = None, look_at_position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, look_at_entity: str | None = None) → str

Teleports the player.

tell(player: str, message: str) → str

Whispers a message to the respective player.

tellraw(player: str, obj: dict) → str

Sends a message represented by a JSON-ish dict.

testfor(victim: str) → str

Counts entities matching specified conditions.

testforblock(position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, tile_name: str, data_value: int | None = None) → str

Tests whether a certain block is in a specific location.

testforblocks(begin: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, end: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str, match_mode: MatchMode | str | None = None) → str

Tests whether the blocks in two regions match.

property tickingarea: TickingareaProxy

Delegates to a mcipc.rcon.be.commands.tickingarea.TickingareaProxy

property time: TimeProxy

Delegates to a mcipc.rcon.be.commands.time.TimeProxy

title(player: str) → TitleProxy

Delegates to a mcipc.rcon.be.commands.title.TitleProxy

toggledownfall() → str

Toggles downfall.

tp(*, destination: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, victim: str | None = None, check_for_blocks: bool | None = None, y_rot: float | str | None = None, x_rot: float | str | None = None, look_at_position: tuple[Union[int, str, float], Union[int, str, float], Union[int, str, float]] | str | None = None, look_at_entity: str | None = None) → str

Teleports the player.

transferserver(server: str, port: int) → str

Transfer player to another server.

w(player: str, message: str) → str

Whispers a message to the respective player.

wb() → str

Toggles the world builder feature.

property weather: WeatherProxy

Delegates to a mcipc.rcon.be.commands.weather.WeatherProxy

property whitelist: WhitelistProxy

Delegates to a mcipc.rcon.commands.whitelist.WhitelistProxy

worldbuilder() → str

Toggles the world builder feature.

wsserver(server_uri: str) → str

Connect to designated WebSocket server.

xp(amount: int, player: str) → str

Gives the player the specified amount of XP.

class mcipc.rcon.be.Enchantment(value)

Bases: str, Enum

Available enchantments in the Bedrock Edition.

AQUA_AFFINITY = 'aqua_affinity'
BANE_OF_ARTHROPODS = 'bane_of_arthropods'
BLAST_PROTECTION = 'blast_protection'
CHANNELING = 'channeling'
CLEAVING = 'cleaving'
CURSE_OF_BINDING = 'binding'
CURSE_OF_VANISHING = 'vanishing'
DEPTH_STRIDER = 'depth_strider'
EFFICIENCY = 'efficiency'
FEATHER_FALLING = 'feather_falling'
FIRE_ASPECT = 'fire_aspect'
FIRE_PROTECTION = 'fire_protection'
FLAME = 'flame'
FORTUNE = 'fortune'
FROST_WALKER = 'frost_walker'
IMPALING = 'impaling'
INFINITY = 'infinity'
KNOCKBACK = 'knockback'
LOOTING = 'looting'
LOYALTY = 'loyalty'
LUCK_OF_THE_SEA = 'luck_of_the_sea'
LURE = 'lure'
MENDING = 'mending'
MULTISHOT = 'multishot'
PIERCING = 'piercing'
POWER = 'power'
PROJECTILE_PROTECTION = 'projectile_protection'
PROTECTION = 'protection'
PUNCH = 'punch'
QUICK_CHARGE = 'quick_charge'
RESPIRATION = 'respiration'
RIPTIDE = 'riptide'
SHARPNESS = 'sharpness'
SILK_TOUCH = 'silk_touch'
SMITE = 'smite'
SOUL_SPEED = 'soul_speed'
SWEEPING = 'sweeping'
THORNS = 'thorns'
UNBREAKING = 'unbreaking'
class mcipc.rcon.be.EntityEquipmentSlot(value)

Bases: str, Enum

Available entity equipment slots.

ARMOR_CHEST = 'armor.chest'
ARMOR_FEET = 'armor.feet'
ARMOR_HEAD = 'armor.head'
ARMOR_LEGS = 'armor.legs'
CONTAINER_SLOT = '<built-in method format of str object>'
ENDERCHEST_SLOT = '<built-in method format of str object>'
HORSE_ARMOR = 'horse.armor'
HORSE_CHEST = 'horse.chest'
HORSE_SADDLE = 'horse.saddle'
HORSE_SLOT = '<built-in method format of str object>'
HOTBAR_SLOT = '<built-in method format of str object>'
INVENTORY_SLOT = '<built-in method format of str object>'
VILLAGER_SLOT = '<built-in method format of str object>'
WEAPON = 'weapon'
WEAPON_MAINHAND = 'weapon.mainhand'
WEAPON_OFFHAND = 'weapon.offhand'
class mcipc.rcon.be.FillType(value)

Bases: str, Enum

Available fill types.

IF_GROUP_FITS = 'if_group_fits'
UNTIL_FULL = 'until_full'
class mcipc.rcon.be.Location(value)

Bases: str, Enum

Available locations.

BELOWNAME = 'belowname'
LIST = 'list'
SIDEBAR = 'sidebar'
class mcipc.rcon.be.MatchMode(value)

Bases: str, Enum

Available block matching modes.

ALL = 'all'
MASKED = 'masked'
class mcipc.rcon.be.Mirror(value)

Bases: str, Enum

Available mirror modes.

NONE = 'none'
X = 'x'
XZ = 'xz'
Z = 'z'
class mcipc.rcon.be.MusicRepeatMode(value)

Bases: str, Enum

Available music repeat modes.

LOOP = 'loop'
PLAY_ONCE = 'play_once'
class mcipc.rcon.be.Operator(value)

Bases: str, Enum

Available operators.

ADDITION = '+'
ASSIGN = '='
DIVISION = '/'
MAX = '>'
MIN = '<'
MODULO = '%'
MULTIPLICATION = '*'
SUBTRACTION = '-'
SWAP = '><'
class mcipc.rcon.be.Order(value)

Bases: str, Enum

Available orderings.

ASCENDING = 'ascending'
DESCENDING = 'descending'
class mcipc.rcon.be.ReplaceMode(value)

Bases: str, Enum

Available replace modes.

DESTROY = 'destroy'
KEEP = 'keep'
class mcipc.rcon.be.RideRules(value)

Bases: str, Enum

Available ride rules.

NO_RIDE_CHANGE = 'no_ride_change'
REASSIGN_RIDES = 'reassign_rides'
SKIP_RIDERS = 'skip_riders'
class mcipc.rcon.be.Rotation(value)

Bases: str, Enum

Available rotation modes.

DEG_0 = '0_degrees'
DEG_180 = '180_degrees'
DEG_270 = '270_degrees'
DEG_90 = '90_degrees'
class mcipc.rcon.be.SaveCommand(value)

Bases: str, Enum

Available save commands.

HOLD = 'hold'
QUERY = 'query'
RESUME = 'resume'
class mcipc.rcon.be.Structure(value)

Bases: str, Enum

Available structures in the Bedrock Edition.

BASTION_REMNANT = 'bastionremnant'
BURIED_TREASURE = 'buriedtreasure'
DESERT_PYRAMID = 'temple'
END_CITY = 'endcity'
FORTRESS = 'fortress'
IGLOO = 'temple'
JUNGLE_PYRAMID = 'temple'
MINESHAFT = 'mineshaft'
MONUMENT = 'monument'
OCEAN_RUINS = 'ruins'
PILLAGER_OUTPOST = 'pillageroutpost'
RUINED_PORTAL = 'ruinedportal'
SHIPWRECK = 'shipwreck'
STRONGHOLD = 'stronghold'
SWAMP_HUT = 'temple'
VILLAGE = 'village'
WOODLAND_MANSION = 'mansion'
class mcipc.rcon.be.StructureAnimationMode(value)

Bases: str, Enum

Available structure animations.

BLOCK_BY_BLOCK = 'block_by_block'
LAYER_BY_LAYER = 'layer_by_layer'
class mcipc.rcon.be.StructureSaveMode(value)

Bases: str, Enum

Available structure save modes.

DISK = 'disk'
MEMORY = 'memory'
class mcipc.rcon.be.TeleportRules(value)

Bases: str, Enum

Available teleportation rules.

TELEPORT_RIDE = 'teleport_ride'
TELEPORT_RIDER = 'teleport_rider'
class mcipc.rcon.be.TimeSpec(value)

Bases: str, Enum

Available time specifications.

DAY = 'day'
MIDNIGHT = 'midnight'
NIGHT = 'night'
NOON = 'noon'
SUNRISE = 'sunrise'
SUNSET = 'sunset'