Custom Museum Framework

Console Commands

Custom Museum Framework does come with a handful of console commands just in case you or the player may need them for debugging purposes. All of these commands will always be available to the player, regardless of what your museum data says, and cannot be disabled. This is intentional and will not be changed. However, as they are console commands and not intended to be used for general gameplay, don't feel like you need to plan around their usage. These are "break glass in case of emergency" commands.

Each command listed below should be written in the form of cmf <command>. If a parameter is wrapped in < > then it is a required parameter. If the parameter is wrapped in [] then it is an optional parameter. If the parameter has a + after it, that means you can provide multiple of that parameter separated by spaces.

COMMAND	DESCRIPTION
reset `[<MuseumId]>+` `[<Pop]>+`	Completely reset the museum with the given `MuseumId` by removing all of its donated items. If `Pop` (default `true`) is set to false, the items will be deleted. If set to `true` instead, the items will pop onto the ground inside the museum to be picked up by the player.
resetall `[<Pop]>+`	Completely reset all custom museums by removing all of their donated items. If `Pop` (default `true`) is set to false, the items will be deleted. If set to `true` instead, the items will pop onto the ground inside their respective museums to be picked up by the player.
resetvanilla `[<Pop]>+`	Completely reset the vanilla museum by removing all of its donated items. If `Pop` (default `true`) is set to false, the items will be deleted. If set to `true` instead, the items will pop onto the ground inside the museums to be picked up by the player.
retrieve `[<MuseumId]>+`	Open a chest menu containing every item inside the museum with the given `MuseumId`. See Item Retrieval. This command will work regardless of whether or not the museum allows item retrieval.
help `[<Command]>+`	Display information about each of the console commands made available by Custom Museum Framework. If the name of a command is provided (e.g. `cmf help reset`), then information will be shown for that command only.