Editing the Config - SilentChaos512/ScalingHealth GitHub Wiki

What You Need to Know

This is mostly for users new to editing config files. Basic computer literacy is assumed.

New Users:
Editing is easy! You can either click some buttons in Minecraft or edit a plain text file. No code, no hacking the JAR. Read on for details.

Pro Users:
There's a config GUI and the file is at config/scalinghealth/main.cfg (ignore asm.cfg if you see it). Server does not sync config settings with clients.

Introduction

Scaling Health is all about the options, so editing the config file is a must. This page covers the basics of editing the config file (both directly and with the in-game GUI). Every setting in Scaling Health should have a comment that explains what it does. Either hover over the setting name in the config GUI or check above the setting in the config file.

Most of this applies to almost any mod! Most mods have at least one config file in the config folder (or a sub-folder). Many, but not all have a config GUI as well.

IMPORTANT: If playing on a server, make sure the server and all players have matching config files! Just editing the config on your client (even when logged in) does not update the server's. And if the client's config does not match the server's, you may see incorrect values.

How to Edit

There are two ways to do this: editing the file directly or using the config GUI. The config GUI is recommend, as it is more user-friendly, prevents typos in some settings, and applies most changes instantly. For the server I recommend using the config GUI and testing in a singleplayer world, then uploading the file. But some server hosting services are weird so you may need to edit the file on the server. Check the limitations of your host first.

Config GUI (recommended)

How to access

  • From the main menu: Click "Mods", search for and select Scaling Health, click the "Config" button
  • From a loaded world: Press Escape to open the game menu, click "Mod Options", search for and select Scaling Health, click the Config button

Don't worry if you accidentally click the "Disable" button; the vast majority of mods cannot be disabled. Clicking does nothing.

Note: You will not be able to change a few settings while in a world. Open the config GUI from the main menu if you need to edit these. Changing these types of settings usually requires you to restart Minecraft. But you shouldn't need to do this often, these are usually just true/false values.

Directly edit the file

Scaling Health's only config file is located in config/scalinghealth and is named main.cfg (there was a second file at one point, but it was no longer needed).

Note: If you choose to edit the file directly, you must restart the client/server to apply changes. The config GUI can apply most settings immediately.

Where to find the file

The config files for most mods will be in the config folder, inside your Minecraft instance folder (the same place you can find the mods folder). If you don't know where this is, your launcher should contain a shortcut to open the instance folder.

  • On Twitch, click Mods then Minecraft. Right-click the profile image and click "Open Folder". Or open the profile, click the "..." button (top right), then "Open folder".
  • If using the vanilla launcher on Windows, check the default MC folder at %appdata%\.minecraft (not sure about the exact location, maybe in versions?)

How to open the file

After you locate the file, you can open this with any text editor. Something more advanced than Windows Notepad is recommend. Notepad will work, but it messes up line ending in some cases, making files difficult to read. For Linux users, gedit should not have any problems.

My recommended text editors

  • Notepad++ is great for quick edits and loads quickly. Not a lot of advanced features, but still much more useful than Notepad.
  • Atom makes working with the entire config folder a treat, as you can search for text in all the files. Very useful if you don't know which mod is doing that thing you don't like!

Other popular options are Sublime Text and Visual Studio Code. But use whatever you like.