Stargate Interfaces

Caution

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

Introduction

Stargate Interfaces is an official module that adds a variety of new ways for users and administrators to interact with Stargates.

Although these features are often convenient and useful, many of the interfaces this module uses (such as commands) break gameplay immersion and are thus contrary to the Dinnerbone Principle.

SGI is recommended for administrators who seek to frequently change configuration-level stargate settings, from in-game, while their server is in operation. It is recommended for administrators seeking to granularily style portals in-game through SGI's integration with SGC (or seeking to provide their users with such capabilities). And it is recommended for administrators who value capability for their users over immersion.

Installation

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

config.yml

By default, the SGI configuration file should look like this; included within it are comments explaining all fields.

At this time, most of SGI's configuration is aesthetic (and determines the symbology used when communicating with users).
For this addon specifically, we feel that the configuration fields should be self evident; if you have any questions, please ask on discord.

format.yml

This file (an example of which may be found here) allows admins to tweak the layout and colour schemes of command outputs provided to users.

These tweaks are purely aesthetic, are explained in comments, and are (in our opinion) self evident; if you have any questions, please ask on discord.

Features

Commands (with Permissions)

sg.interfaces.config

/sgi config {key} {value} (default: none)
Allows one to change stargate configuration values in-game; a list of available config values available through tab complete.

sg.interfaces.info

/sgi info (default: op)
Provides info (including owner, destination name, origin name, portal type, etc. about the portal one is currently facing).

sg.interfaces.dial

/sgi dial {network name} {portal name} (default: op)
Allows one to arbitrarily connect two portals (the portal you are looking at opens to the portal specified in the dial command).

sg.interfaces.visualizer

/sgi visualizer {network name} (default: op)
Displays all portals that are part of a specified network, in a human-readable format.

sg.interfaces.style.<set/quickset/reset/quickreset>

/sgi style set {gate/global/material/network/portal} {name/ID/facing} {all/background/pointer/text} <hex/dyecolor> (default: op)
Allows one to set a specified group of objects' signs' colours and/or highlights to a specific colour.
If hex/dyecolor is omitted, an in-game interface (colorbukkit) is used.

/sgi style reset {gate/global/material/network/portal} {name/ID/facing} {all/background/pointer/text} (default: op)
Allows one to revert a specified group of objects' signs' colours and/or highlights to the server's defaults (clears custom formatting affecting it/them).

/sgi style quickset <gate/global/material/network/portal> <all/background/pointer/text> (default: op)
A shortcut that allows one to set the colours and/or highlights of the portal you are looking at, or that of an entire group of which the portal you are looking at is a member of. Omitting the first argument defaults to portal; omitting the second argument defaults to all. An in-game interface (colorbukkit) is used to specify a color.

/sgi style quickreset <gate/global/material/network/portal> <all/background/pointer/text> (default: op)
A shortcut that allows one to set the colours and/or highlights of the portal you are looking at, or that of an entire group of which the portal you are looking at is a member of (clears custom formatting affecting it/them). Omitting the first argument defaults to portal; omitting the second argument defaults to all.