Edit A Plugin Config With The Configuration Editor

Every plugin on this site has a Configuration Editor built into its page. It reads the plugin's real config files and turns them into toggles, sliders, and text boxes. You never have to hand edit JSON, and you never have to worry about a missing comma. When you are done, you download the finished files and drop them on your server.

This page shows the whole loop: open the editor, change what you want, download, install.

Step 1, open the editor

Go to the plugin's page in the catalog. In the sidebar you will see two links under the plugin's name: Wiki & Docs and Configuration Editor. Docs explains every setting with its default. The editor is where you change them.

The editor loads the plugin's latest published config. Some plugins ship more than one file. A crates folder with one file per crate, a pools folder with shared reward lists, and a lang folder with one file per language. The editor shows them all, so you edit the whole folder in one place.

Step 2, change your settings

Every setting shows a control that matches what it is:

• A true or false setting shows a toggle.
• A number shows a slider with a number box next to it.
• A word or a path shows a text box.
• A list shows rows you can add and remove.

Settings that have notes in the plugin's commented config show those notes right under the control, so you know what you are changing without leaving the page.

The editor saves a draft in your browser as you go. Close the tab, come back tomorrow, and your work is still there. If you see a note that a draft was restored and you do not want it, press Reset everything to go back to the published file. Reset this file does the same for just the file you are looking at.

Step 3, save a template if you run more than one server

Press Save template with a name and the editor keeps your whole set of changes in your browser. Load it any time. This is handy when you run a cluster and want the same settings on every map, or when you like to test changes before putting them on the live server.

Step 4, download your files

Two buttons matter here:

• Export this file downloads only the file you are looking at.
• Download the folder downloads everything as one piece, ready for your server.

There is also a Copy button when you would rather paste the file somewhere yourself.

Step 5, install on your server

Put the files where the plugin expects them:

ArkApi/Plugins/<PluginName>/config.json

If the plugin ships crates, pools, or lang files, keep the folder shape exactly as downloaded, next to the config.json. Then reload the plugin or restart the server. Keep a backup of your old files before big changes, the same as always.

When something looks wrong

Open the plugin's Wiki & Docs page. Every setting is listed there with what it does and its default value, so you can compare what you changed against what the plugin expects. If you are still stuck, email [email protected] or ask in our Discord.

One last thing. If you write AsaApi plugins yourself and want your own plugin to draw real in game windows like ours do, read Interface Mod: Plugin Setup in our Developer Guides.