Skip to content

Configuration (Features)

Ali Hussain edited this page Sep 28, 2023 · 1 revision

Explanations

ARCropolis makes use of a configuration file located at sd:/atmosphere/contents/01006A800016E000/romfs/arcropolis.toml.
This file can be opened with any text editor and is generated on the first boot after installing ARCropolis. However, as of version 3.0.0 of ARCropolis, you can now edit this same configuration file in the configuration editor, found in the eShop icon of Smash's home menu under "Configuration editor." There will be fewer options to change than the raw configuration file, so keep that in mind.

What each field does

Infos

  • version The latest version that used this configuration file. No point in changing it.

Paths

  • arc
    The path used to locate files for the legacy method of patching. Defaults to rom:/arc.
  • umm
    The path used to locate mods for the Ultimate Mod Manager method of patching. Defaults to sd:/ultimate/mods/.
  • extra_paths
    Extra paths you can add that uses the Ultimate Mod Manager method of patching.

Updater

  • server_ip
    The IP of the server where ARCropolis checks for updates. This can be set to 0.0.0.0 if you never want to check for updates.
  • beta_updates
    Used to opt-in for beta updates of ARCropolis. They usually are released shortly before an official release and are mostly to confirm everything is in working order.
    They sometimes provide preview features that are going to be implemented.

Logger

  • logger_level
    Used to define the level of logging you want to see with the File Logger feature. Defaults to Info.
    The various levels are as such:
    • Off - Cut off all logs
    • Error - Only shows errors (this is currently unused as is no different from Off)
    • Warn - Warns you about some issues that are most likely not threatening to crash the game
    • Info - Default option, gives you warnings and mentions when a file is replaced
    • Debug - Unused so far
    • Trace - See every file being loaded by the game, replaced or not.

Miscellaneous

  • debug
    Unused for the time being. Defaults to false
  • region
    Due to complications in reading the region used by the game, you can specify your region in this field. Defaults to us_en.
    All available region names: jp_ja, us_en, us_fr, us_es, eu_en, eu_fr, eu_es, eu_de, eu_nl, eu_it, eu_ru, kr_ko, zh_cn, zh_tw

In-game configuration editor

The in-game version of editing your config file. Simply allows to edit some parts of your config file mentioned above.

Region

Allows you to change your region. The options offered include:

  • Japanese
  • US English
  • US French
  • US Spanish
  • European English
  • European French
  • European Spanish
  • European German
  • European German
  • European Dutch
  • European Italian
  • European Russian
  • Korean
  • Simplified Chinese (ZH_CN)
  • Traditional Chinese (ZH_TW)

The most common region is US English, and will have compatibility with the most amount of mods. If you wish to exit this menu, navigate to the top of the screen and hit A on the "Go back" option.

Logging level

Used to define the level of logging you want to see with the File Logger feature. Only use this feature if you really know what you're doing. Defaults to Warning. The various levels are as such:

  • Trace - See every file being loaded by the game, replaced or not.
  • Debug - Unused so far
  • Info - Default option, gives you warnings and mentions when a file is replaced
  • Warning - Warns you about some issues that are most likely not threatening to crash the game
  • Error - Only shows errors (this is currently unused as is no different from Off)
  • Off - Cut off all logs

If you wish to exit this menu, navigate to the top of the screen and hit A on the "Go back" option.

Beta updates

Select whether or not you want to participate in beta updates of ARCropolis, whenever applicable. The next time there is a beta update for ARCropolis, it will ask you to update. They may come with more features, but they also may be more unstable, as they are used to test bugfixes or add new work-in-progress elements to ARCropolis. Only check this option if you intend to use it for its primary purpose. Note that if this is off, the next time ARCropolis is updated with a stable version, it will prompt you to update. Off by default.

Use legacy mod discovery system

Select whether or not you want to use the previous system of having ARCropolis discover mods. New mods are not offered to be enabled when you start up the game when using this system, and you can disable mods manually by adding a period to the front of your folder when added. Off by default.

Debug

Enables debug mode. Only enable if you know what you are doing. Off by default.

Log to file

Enables ARCropolis to log to sd:/ultimate/arcropolis/logs. The "Logging level" option affects this command. Off by default.

Check for update on boot.

Enables ARCropolis to check the GitHub server for an update to the program. The "Beta updates" option affects this command. On by default.

Close

Closes the configuration editor. If any fields are changed, ARCropolis will prompt you to reboot your game.