# Commands MCAV has many commands that you can use to interact with the library. This page will document all the commands, including each argument and its purpose. If you want to see the commands in-game, you can use the `/mcav help` command to get a tree of all the commands available to you. ## Permissions Permissions for each command are very simple. It's just `mcav.command.`. For example, the permission for the `/mcav screen` is just `mcav.command.screen`. You can use a permissions plugin like [LuckPerms](https://luckperms.net/), which will tab-complete the permission for you. ## General Commands | **Command** | `/mcav help` | |-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav help [command]` | | **Permission** | `mcav.command.help` | | **Description** | This command will show you a tree of all the commands available to you. It also shows some basic information about what each command does. | | **Arguments** | | |     `command` | (optional): The command you want to get help for. If not provided, it will show the entire command tree. | --- | **Command** | `/mcav screen ` | |-------------------------------------------|-----------------------------------------------------------------------------------------------------| | **Usage** | `/mcav screen ` | | **Permission** | `mcav.command.screen` | | **Description** | Brings up a menu to build a new map screen. Use the block width and height to construct the screen. | | **Arguments** | | |     `blockDimensions` | The dimensions of the map blocks (e.g., 3x2) | |     `mapID` | The ID of the map to use | |     `material` | The material to use for the screen frame | |     `location` | The location in the World to build the screen | --- | **Command** | `/mcav dump` | |-----------------|-----------------------------------------------------------------------------------------------------| | **Usage** | `/mcav dump` | | **Permission** | `mcav.command.dump` | | **Description** | Dumps your logs, system information, and other debugging information into a paste used for support. | | **Arguments** | None | --- ## Video Commands ```{note} If you set the video player to be `FFMPEG`, you can also specify directly a format and input to use. For example, you can stream OBS output by setting the `mrl` argument to be `dshow||video=OBS Virtual Camera` on Windows. ``` | **Command** | `/mcav video release` | |-----------------|-----------------------------------------------------------| | **Usage** | `/mcav video release` | | **Permission** | `mcav.command.video.release` | | **Description** | Releases/removes the video that was previously displayed. | | **Arguments** | None | --- | **Command** | `/mcav video pause` | |-----------------|-------------------------------------| | **Usage** | `/mcav video pause` | | **Permission** | `mcav.command.video.pause` | | **Description** | Pauses the currently playing video. | | **Arguments** | None | --- | **Command** | `/mcav video resume` | |-----------------|-------------------------------------| | **Usage** | `/mcav video resume` | | **Permission** | `mcav.command.video.resume` | | **Description** | Resumes the currently paused video. | | **Arguments** | None | --- | **Command** | `/mcav video hologram set` | |------------------------------------|----------------------------------------------------------| | **Usage** | `/mcav video hologram set ` | | **Permission** | `mcav.command.hologram.set` | | **Description** | Sets the location for displaying hologram video content. | | **Arguments** | | |     `location` | The location in the World to display the hologram | --- | **Command** | `/mcav video hologram disable` | |-----------------|--------------------------------------------------| | **Usage** | `/mcav video hologram disable` | | **Permission** | `mcav.command.hologram.disable` | | **Description** | Disables the hologram display for video content. | | **Arguments** | None | --- | **Command** | `/mcav video block` | |-------------------------------------------|----------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav video block ` | | **Permission** | `mcav.command.video.block` | | **Description** | Displays a video in blocks. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the video | |     `playerType` | The type of video player to use | |     `audioType` | The type of audio output to use | |     `videoResolution` | A resolution in width×height format (example, 640x360) | |     `location` | The location in the World to display the video | |     `flags` | Additional flags if the media will be parsed by yt-dlp (in format --yt-dlp{arg1=...,arg2,etc} | |     `mrl` | The Media Resource Locator pointing to the video | --- | **Command** | `/mcav video chat` | |-------------------------------------------|----------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav video chat ` | | **Permission** | `mcav.command.video.chat` | | **Description** | Displays a video in chat. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the video | |     `playerType` | The type of video player to use | |     `audioType` | The type of audio output to use | |     `videoResolution` | A resolution in width×height format (example, 640x360) | |     `character` | The character to use for rendering the video in chat | |     `flags` | Additional flags if the media will be parsed by yt-dlp (in format --yt-dlp{arg1=...,arg2,etc} | |     `mrl` | The Media Resource Locator pointing to the video | --- | **Command** | `/mcav video entity` | |-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav video entity ` | | **Permission** | `mcav.command.video.entity` | | **Description** | Displays a video as a TextDisplay entity. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the video | |     `playerType` | The type of video player to use | |     `audioType` | The type of audio output to use | |     `videoResolution` | A resolution in width×height format (example, 640x360) | |     `character` | The character to use for rendering the video | |     `location` | The location where to display the video entity | |     `flags` | Additional flags if the media will be parsed by yt-dlp (in format --yt-dlp{arg1=...,arg2,etc} | |     `mrl` | The Media Resource Locator pointing to the video | --- | **Command** | `/mcav video map` | |----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav video map ` | | **Permission** | `mcav.command.video.map` | | **Description** | Displays a video on a map screen. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the video | |     `playerType` | The type of video player to use | |     `audioType` | The type of audio output to use | |     `videoResolution` | A resolution in width×height format (example, 640x360) | |     `blockDimensions` | The dimensions of the map blocks | |     `mapId` | The ID of the map. This corresponds with the id you set in `/mcav screen` to create the map screen | |     `ditheringAlgorithm` | The algorithm used for dithering the video. Use FILTER_LITE for best results | |     `flags` | Additional flags if the media will be parsed by yt-dlp (in format --yt-dlp{arg1=...,arg2,etc} | |     `mrl` | The Media Resource Locator pointing to the video | --- | **Command** | `/mcav video scoreboard` | |-------------------------------------------|----------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav video scoreboard ` | | **Permission** | `mcav.command.video.scoreboard` | | **Description** | Displays a video in a scoreboard. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the video | |     `playerType` | The type of video player to use | |     `audioType` | The type of audio output to use | |     `videoResolution` | A resolution in width×height format (example, 640x360) | |     `character` | The character to use for rendering the video in the scoreboard | |     `flags` | Additional flags if the media will be parsed by yt-dlp (in format --yt-dlp{arg1=...,arg2,etc} | |     `mrl` | The Media Resource Locator pointing to the video | --- ## Browser Commands | **Command** | `/mcav browser interact` | |-----------------|---------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav browser interact` | | **Permission** | `mcav.browser.interact` | | **Description** | Activates browser interaction mode for the player. This allows players to send text and key input into the browser. | | **Arguments** | None | --- | **Command** | `/mcav browser release` | |-----------------|-------------------------------------------------------------| | **Usage** | `/mcav browser release` | | **Permission** | `mcav.browser.release` | | **Description** | Releases/removes the browser that was previously displayed. | | **Arguments** | None | --- | **Command** | `/mcav browser create` | |----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav browser create ` | | **Permission** | `mcav.command.browser.create` | | **Description** | Creates and displays a browser on a map. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the browser | |     `browserResolution` | A resolution in width×height format (example, 1280x720) | |     `quality` | Quality setting for the browser from 1 to 100, where 100 denotes higher quality | |     `nth` | How often frame snapshots are taken (1 means high frame rate, 2 means take a screenshot every other frame, etc) | |     `blockDimensions` | The dimensions of the map blocks | |     `mapId` | The ID of the map. This corresponds with the id you set in `/mcav screen` to create the map screen | |     `ditheringAlgorithm` | The algorithm used for dithering the browser. Use FILTER_LITE for best results | |     `url` | The URL of the webpage to display. **Must be the full URL**. | --- ## Virtual Machine Commands ```{warning} You must have QEMU installed and configured to use these commands. ``` | **Command** | `/mcav vm interact` | |-----------------|--------------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav vm interact` | | **Permission** | `mcav.vm.interact` | | **Description** | Activates VM interaction mode for the player. This allows players to send text and mouse input into the virtual machine. | | **Arguments** | None | --- | **Command** | `/mcav vm release` | |-----------------|--------------------------------------------------------| | **Usage** | `/mcav vm release` | | **Permission** | `mcav.vm.release` | | **Description** | Releases/removes the VM that was previously displayed. | | **Arguments** | None | --- | **Command** | `/mcav vm create` | |----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav vm create ` | | **Permission** | `mcav.command.vm.create` | | **Description** | Creates and displays a virtual machine on a map. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the VM | |     `vmResolution` | A resolution in width×height format (example, 1280x720) | |     `targetFps` | Target frames per second for the VM (minimum value: 1) | |     `blockDimensions` | The dimensions of the map blocks | |     `mapId` | The ID of the map. This corresponds with the id you set in `/mcav screen` to create the map screen | |     `ditheringAlgorithm` | The algorithm used for dithering the VM display. Use FILTER_LITE for best results | |     `architecture` | The CPU architecture to use for the VM | |     `flags` | Additional flags and options to pass to the QEMU VM (for example, ISO files, boot drives, memory, etc) | --- ## Image Commands | **Command** | `/mcav image release` | |-----------------|-----------------------------------------------------------| | **Usage** | `/mcav image release` | | **Permission** | `mcav.command.image.release` | | **Description** | Releases/removes the image that was previously displayed. | | **Arguments** | None | --- | **Command** | `/mcav image block` | |-------------------------------------------|-------------------------------------------------------------------------| | **Usage** | `/mcav image block ` | | **Permission** | `mcav.command.image.block` | | **Description** | Displays an image in blocks. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the image | |     `imageResolution` | A resolution in width×height format (example, 640x640) | |     `location` | The location in the World to display the image | |     `mrl` | The Media Resource Locator pointing to the image | --- | **Command** | `/mcav image chat` | |-------------------------------------------|-------------------------------------------------------------------------| | **Usage** | `/mcav image chat ` | | **Permission** | `mcav.command.image.chat` | | **Description** | Displays an image in chat. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the image | |     `imageResolution` | A resolution in width×height format (example, 640x640) | |     `character` | The character to use for rendering the image in chat | |     `mrl` | The Media Resource Locator pointing to the image | --- | **Command** | `/mcav image entity` | |-------------------------------------------|--------------------------------------------------------------------------------------| | **Usage** | `/mcav image entity ` | | **Permission** | `mcav.command.image.entity` | | **Description** | Displays an image as a TextDisplay entity. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the image | |     `imageResolution` | A resolution in width×height format (example, 640x640) | |     `character` | The character to use for rendering the image | |     `location` | The location where to display the image entity | |     `mrl` | The Media Resource Locator pointing to the image | --- | **Command** | `/mcav image map` | |----------------------------------------------|-----------------------------------------------------------------------------------------------------------| | **Usage** | `/mcav image map ` | | **Permission** | `mcav.command.image.map` | | **Description** | Displays an image on a map screen. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the image | |     `imageResolution` | A resolution in width×height format (example, 640x640) | |     `blockDimensions` | The dimensions of the map blocks | |     `mapId` | The ID of the map. This corresponds with the id you set int `/mcav screen` to create the map screen | |     `ditheringAlgorithm` | The algorithm used for dithering the image. Use FILTER_LITE for best results | |     `mrl` | The Media Resource Locator pointing to the image | --- | **Command** | `/mcav image scoreboard` | |-------------------------------------------|-------------------------------------------------------------------------------| | **Usage** | `/mcav image scoreboard ` | | **Permission** | `mcav.command.image.scoreboard` | | **Description** | Displays an image in a scoreboard. | | **Arguments** | | |     `playerSelector` | A selector for the players that can see the image | |     `imageResolution` | A resolution in width×height format (example, 640x640) | |     `character` | The character to use for rendering the image in the scoreboard | |     `mrl` | The Media Resource Locator pointing to the image |