Skip to content

Commit

Permalink
readme: improve installation + requirements docs (#537)
Browse files Browse the repository at this point in the history
* readme: improve installation + requirements docs

* readme: EndTouchFix note update

* readme: EndTouchFix note update
  • Loading branch information
markus-wa authored Nov 14, 2022
1 parent dcc3080 commit 7f2f942
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ Less bugs = better experience = more players for surf!
* Download and install [Metamod 1.11](https://www.sourcemm.net/downloads.php/?branch=stable)
* Download and install [SourceMod 1.10](https://www.sourcemod.net/downloads.php?branch=stable) (latest stable) or [SourceMod 1.11](https://www.sourcemod.net/downloads.php?branch=master&all=1) (required for some recommended plugins)
* Download latest [release](https://github.com/surftimer/SurfTimer/releases/latest) and upload all the files to your csgo server directory
* Set up A MySQL Database (MySQL 5.7, MySQL 8+, MariaDB supported)
* Set up A MySQL Database (MySQL 5.7, MySQL 8+, MariaDB supported) and [initialise a schema for surftimer](https://github.com/surftimer/SurfTimer/blob/master/scripts/mysql-files/fresh_install.sql)
* Add a MySQL database called surftimer to csgo/addons/sourcemod/configs/databases.cfg
* Ensure [End-Touch-Fix](https://github.com/rumourA/End-Touch-Fix) is loaded, this is required to ensure times are always accurate
* Ensure [End-Touch-Fix](https://github.com/rumourA/End-Touch-Fix) is loaded, this is required to ensure times are always accurate (note: this is included in the official SurfTimer release build and loaded automatically without installing separately unless you are compiling SurfTimer yourself)
* Ensure you have added all the requirements below

## Installation common errors
Expand Down Expand Up @@ -74,10 +74,15 @@ Run the following queries on your database:
## Requirements

**SourceMod Extensions**
* [DHooks](https://github.com/peace-maker/DHooks2)
* (\*) [DHooks](https://github.com/peace-maker/DHooks2)
* *(recommended)* [Cleaner](https://github.com/Accelerator74/Cleaner) - Suppresses server console warnings

(\*) *Already included with SourceMod 1.11.6820 and newer*

**SourceMod Libraries**

ℹ️ SourceMod Libraries are only required if you are compiling SurfTimer yourself

* [SMLib](https://github.com/bcserv/smlib/tree/transitional_syntax)
* [ColorLib](https://github.com/c0rp3n/colorlib-sm)
* [AutoExecConfig](https://github.com/Impact123/AutoExecConfig)
Expand Down

0 comments on commit 7f2f942

Please sign in to comment.