Skip to content

Home

Jump to bottom
TNN edited this page Sep 29, 2024 · 2 revisions

Welcome to the stage_config wiki! This page gives a brief overview about the usage of the plugin. For more detailed information on the various features, see the pages linked on the side tab.

Getting Started

Downloading and Installing the Plugin

  1. Download the release.zip file from the latest release and extract it.
  2. Move the atmosphere folder from the extracted ZIP file onto the root of the microSD card.

The plugin should now be stored at sd:/atmosphere/contents/01006A800016E000/romfs/skyline/plugins/. Please note that this plugin should be treated as a dependency plugin and not one that is chainloaded from an ARCropolis mod folder.

Configuration

stage_config utilizes the TOML configuration file format.

Setting Up a Configuration File

Create a new text file and name it config_stage.toml. This configuration file should be placed within the target mod folder in sd:/ultimate/mods/ (e.g., sd:/ultimate/mods/<My Mod Name Here>/config_stage.toml). TOML files are text files, so they can be viewed and edited in any text editor.

Tables

Header Description
[new_dynamic_collisions] Enables a parent model to influence the transformation of a dynamic ground collision object.
[is_flat_stage] Enables/disables the flattening effect applied to various kinds of objects.
[gravity_param] Enables/disables the curvature of gravity and allows for specifying the gravitational center point.
[stage_additional_settings] Enables the use of stage settings from spirit battles outside of Spirits.
[gimmick_param] Enables/disables stage hazards for a particular stage.

Arrays

Name Description
discard_stage_code Discards any dedicated programming for a particular stage.

Stage IDs

Each stage and its alternate forms are associated with a unique identification number. This identification number is associated with a name for ease of human understanding. These names are used as the keys for each of the tables and as values for the arrays.

To find the stage ID, refer to the stage's name_id value in ui/param/database/ui_stage_db.prc. For a stage's Battlefield or Omega form, prepend Battle_ or End_ to the stage ID, respectively.

The stage ID should be copied exactly as listed. Incorrect spelling or casing will result in an error, causing the configuration file to be skipped. Errors can be checked with the Skyline logger.

Example

A real-world example of a configuration file may look like the following:

discard_stage_code = ["Sonic_Windyhill"]

[new_dynamic_collisions]
Sonic_Windyhill = ["dyr_windmill_set"]

[gravity_param]
Sonic_Windyhill = { is_gravity_normal = true }

This configuration file applies modifications exclusively to Windy Hill Zone. It discards its programming, enables the model named dyr_windmill_set to influence ground collision object transformations, and disables the curvature of gravity. The last modification may be unnecessary due to the use of discard_stage_code but is included for the sake of providing an example.

Clone this wiki locally