Home

Shine is a modular administration mod for Natural Selection 2.

The Steam Workshop mod ID for Shine is: 706d242

If you are running NS2Stats there is no reason for Shine to conflict. Please let me know of any issues that arise with Shine and NS2Stats.

Please report all bugs either on the Workshop page or preferably here: https://github.com/Person8880/Shine/issues

Overview

Commands in Shine are prefixed by sh_. This sets them apart from other mods and the builtin commands of NS2.

Shine's user system works on an immunity system. Players are given an immunity number, guests have immunity 0 and can be targeted by anyone with a named rank. Ranks can target only those with immunity lower (or equal if you set it) to their own.

You may configure as many ranks as you like, and can either give them a list of commands they can use, or a list of commands they can't use.

For information on configuring Shine and its plugins, see the links below.

Latest changes

The latest changes to the mod will be listed here or on the workshop's change notes page.

• Changelog

Setting up

Shine has two base configuration files, BaseConfig.json and UserConfig.json. They are explained in the pages below. Plugins have their own configuration files stored separately.

• The base config
• Configuring users
• Plugin configs

General information

• Command syntax
• Using Shine with other mods

Plugin information

These are all the plugins that are shipped with Shine.

• Adverts
• AFK Kick
• Badges
• Bans
• Base commands
• Fun commands
• Logging
• Map vote
• Message of the day
• Name filter
• [NS2Stats] (https://github.com/BrightPaul/Shine/wiki/NS2Stats)
• Ping Tracker
• Pregame
• Ready Room
• Reserved Slots
• Server switch
• Tournamentmode
• Unstuck
• Vote random
• Vote surrender
• Welcome messages

For developers

If you want to create plugins for Shine, see these pages.

• Creating console commands
• Creating a plugin
• Datatables
• Extending the vote menu

Libraries

• Hook Library
• Player Library
• Timer Library