lifesfun / shine Goto Github PK

Shine
=====

An administration mod for Natural Selection 2.

Currently a work in progress.

The design goals are:
- Be easy to extend and maintain.
- Be easy for admins to use.
- Be completely modular, everything is optional.

If you wish to help out, feel free to send pull requests.

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 shine/plugins by default, you may change this if you wish in BaseConfig.json.

User data will be loaded locally by default, from the file 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. As long as what Shine is receiving is JSON data, it will load successfully. So if you want, you can point it to a PHP file that returns JSON data.

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