Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 6.19 KB

README.md

File metadata and controls

100 lines (70 loc) · 6.19 KB
Raw


SourceBans++

GitHub release License: CC BY-SA 4.0 GitHub issues GitHub pull requests GitHub All Releases Discord

Global admin, ban, and communication management system for the Source engine

Issues

If you have an issue you can report it here. To solve your problems as fast as possible fill out the issue template provided or read how to report issues effectively here.

Useful Links

Requirements

* Webserver
  o PHP 8.1 or higher
    * ini setting: memory_limit greater than or equal to 64M
    * GMP extension
  o MySQL 5.6 or MariaDB 10 and higher
* Source Dedicated Server
  o MetaMod: Source
  o SourceMod: Greater Than or Equal To 1.10

How to install a SourceBans++ release version

The easiest way of installing SourceBans++ is to use a release version, since those come bundled with all requiered code dependencies and pre-compiled sourcemod plugins.

The quickstart guide gives you a detailed walktrough of the installation process.

How to install the current master branch version

The master branch doesn't include the required dependencies or compiled plugins you need to run SourceBans++. Here is a quick summary of getting the master branch code up and running.

Installing webpanel dependencies

  • Follow the quickstart guide and upload the webpanel files to your web server
  • Install composer - Installation Guide
  • Go to the root of your SourceBans++ installation (where index.php is located)
  • run composer install

After successfully installing all dependencies you can procede with the quickstart guide.

PHP 8.1 major changes

Upgrade

If you ran the installer, this step is unnecessary.

Upgrading from 1.6/1.7, requires a new configuration value to be set. To do this, please run the upgrade.php script. Once done, delete it, as it may output sensitive information.

Smarty

Updated Smarty version dropped support for the {php} tag.

Custom themes must use the new {load_template} tag.

JWT Update

If you ran the installer or upgrade file, this step is unecessary.
JWT secrets are no longer stored in the database as they are generated using a secret key.

Compiling SourceMod plugins

Follow the Guide 'Compiling SourceMod Plugins' from the official SourceMod Wiki

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. Read SECURITY.md if you have a Security Bug in SourceBans++

Authors

  • GameConnect - Initial Work / SourceBans - GameConnect
  • Sarabveer Singh - Initial Work on SourceBans++ - Sarabveer
  • Alexander Trost - Continuing Development on SourceBans++ - Galexrt
  • Marvin Lukaschek - Continuing Development on SourceBans++ - Groruk

See also the list of contributors who participated in this project.

License

This SourceMod plugins of this project are licensed under the GNU GENERAL PUBLIC LICENSE Version 3 (GPLv3) License. The Web panel is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0) License.