Skip to content

Config Commands

Endor H edited this page Apr 4, 2023 · 5 revisions

Besides config menus, Simple Config also allows players to modify the configuration of mods through commands. It also allows other mods to name their own alias for their configuration command, but you can configure all mods using the global /config command.

Tip: The smart-completion mod can be very helpful when dealing with commands with many completion options.

Minecraft Forge already defines a /config showfile command which simply reports the path of the config file for a given mod. Simple Config adds 4 additional subcommands to the /config command:

Config command

/config get

Config get command

The /config get command lets you inspect the value of a certain configuration entry. You must specify the mod ID of the mod it belongs to, the config type it is for (client/server/common) (or server-common if you want to retrieve the common value stored in the server), and the config entry's path.

Config get command: Select path

The command will display in the chat the current value for the requested entry in YAML format. The shown value will be trimmed so it fits in one line, but hovering it will let you inspect its value, and clicking it will suggest you a command to reassign that same value. A small copy button will appear as well besides the value, so you can copy just the value to your clipboard.

Config get command result

/config set

Config set command

Very similar to the /config get command, the /config set command accepts an additional argument, which is the value you wish to assign to the selected entry, in the same YAML format that the /config get command uses.

The YAML format supports single line lists and maps using [brackets] and {braces}, so you can edit any type of config entry with this command.

Config set command result

Just like the get command, after the value is set, a message will report the change applied by the command, with an additional link to undo it. If you edit a server config with a command, other operators will also be able to see the change you made, the same way it happens when you do it through the config menu.

Config set executed by other player

As with config menus, only authorized players will be able to modify the server's configuration.

/config reset

While the /config set command will suggest you the default and current value for the entry you edit, as well as some other suggestions depending on the entry, a faster way to reset a few entries is using the /config reset command.

Config reset command

Just like the /config get command, it will accept a path to an entry. The only difference is it will also accept paths to entry groups, so you can reset many entries at once.

/config edit

The config edit command is just a convenient way to open the config menu of a specific mod. This way you only need to type its name, rather than searching for it in the mod list. If you edit a certain mod often, you may be interested in setting a config hotkey to open its config menu, within the client configuration for the Simple Config mod, under the Hotkeys category.

Config edit command


Missing commands

By default, Simple Config provides config commands to all mods using Forge's config system. However, this may be disabled in Simple Config's common config, both in your client and in the server.

In addition, if you're playing below Minecraft 1.18, config commands will only allow you to interact with server (and server-common) configs, and the /config edit command won't be available. This is because client-side commands weren't added until Minecraft 1.18.

Server config commands are only available in modded servers, while client config commands are always available, as long as you're playing on 1.18+.

Clone this wiki locally