Skip to content

Configuration

YTG123 edited this page Nov 14, 2020 · 2 revisions

Proton uses the Tiny Config configuration library created by dzwdz.

Tiny Config uses a modular approach of Saveables.

Here's how to configure Proton

Using the Json file

  • The Proton configuration file is located in config/proton.json5.
  • Each Proton module has an Identifier. It's usually proton:module_name.
    • For example, proton:thatch
  • Each module identifier is a Json object inside the configuration file.
  • Each module's configurable fields are properties within the aforementioned Json object.
  • In the wiki page that documents a module, all the configurable fields are listed under Configuration.
    • Every module has an enabled field.
  • The field type in the documentation refers to the Java type of that field, the Json type may be different.
    • For the most part, it's the same.

Using the configuration screen

  • You can open the Proton configuration screen through the p button in the title screen or through ModMenu.
  • The configuration screen is divided up into module categories.
  • When you click on a category, the screen will show all modules in that category.
  • To change configurable values for a specific module, expand it by clicking on its name.
  • The configuration screen doesn't support arrays, while the Json file does.
  • Each module name and configurable field has a user-friendly name if the author of that module didn't forget to add it.

General

Categories

Clone this wiki locally