Skip to content
forked from Person8880/Shine

An administration mod for Natural Selection 2.

Notifications You must be signed in to change notification settings

GhoulofGSG9/Shine

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shine

An administration mod for Natural Selection 2.

The design goals are:

  • Be easy to extend and maintain.
  • Be easy for admins to use.
  • Be completely modular, everything is optional.

Pull requests

If you wish to help out, feel free to send pull requests. Please see the style guidelines here: https://github.com/Person8880/Shine/wiki/Pull-Requests and make sure you are merging into the develop branch, not master.

Configuration

The mod will create its configuration files in config_path/shine.

The base config file will be called BaseConfig.json and will determine base settings and which plugins to load. Plugins will create their configs inside config_path/shine/plugins by default, you may change this if you wish in BaseConfig.json.

User Data

User data will be loaded locally by default, from the file config_path/shine/UserConfig.json. On first run a sample file will be created. If you set 'GetUsersFromWeb' to true and provide a correct URL to a JSON file in 'UsersURL', Shine will load its users from there instead.

Further documentation

Further documentation is available at: https://github.com/Person8880/Shine/wiki including default config files for each plugin and for the base config.

About

An administration mod for Natural Selection 2.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Lua 100.0%