Stargate Customizations

Caution

This documentation pertains to an official module.
Features described herein are NOT part of the core.

Introduction

Stargate Customizations is an official module that adds support for highly granular aesthetic and thematic customisations to Stargate Rewritten.

Although it affords a high degree of customisation, SGC accomplishes this by providing highly involved configuration files and other similar user interfaces. Frequently, these configurations are too lengthy, cumbersome, or niche to otherwise be included in the core (see SG's design philosophy).

SGC is recommended for experienced administrators and other advanced users seeking to influence the look and feel of their Stargate deployments beyond the limits of what is available in the core module.

Installation

To install SGC, simply download the latest release from here and drag/drop it into your instance's plugins folder as you would any other plugin. SGC will take care of importing all existing stargate data, and will create a StargateCustomizations subfolder containing a config.yml and a color.yml.

config.yml

By default, the SGC configuration file should look like this; included within it are comments explaining all fields.
For this addon specifically, we feel that the fields should be self evident; if you have any questions, please ask on discord.

colors.yml

Note

This file is only used if style_source is set to FILE in config.yml (it defaults to NONE; THEME would use a ColourWizard export code).

Important

The default file includes a section break (---) on line 25, below which everything is ignored!
For explanatory purposes, this file contains two sections: a real example section, and an ignored documentation/explanation section.

For users wishing to avoid using SGC's ColourWizard, colors.yml is a file-based method to specify advanced configurations.

This is a recursive format that, from top to bottom, identifies portals matching filters and applies content (see the comments in the colors.yml for details and examples). By default, the SGC's colour configuration file looks like this.

Please note that we recommend populating a blank file (as opposed to the prepopulated tutorial file).

Permissions

SGC has no relevant user facing permission nodes.

Features

Theme Specification

It is possible to separately change the background, pointer, error, and network name colours on the signs of portals.

These changes are selectively affective based on various filters (owner, destination, world, network, gate design, etc. among other options).

These changes may be specified in a configuration file (colors.yml), via a web user interface (colorwizard), or in-game through the SGI module (/sgi style {}). Colours may be specified in RGB, HEX, or DyeColor; they may also be used to override the core's default sign luminosity offsets.

Animations

Caution

NOT YET IMPLEMENTED

Custom gate opening and closing animations, including particles, may be specified using this module.