Skip to content
This repository has been archived by the owner on May 14, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KarlOfDuty authored Oct 20, 2018
1 parent 023d2a2 commit d0db535
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# VPNShield
An anti-VPN plugin for servermod.
An Anti-VPN plugin for servermod. Also features blocking new Steam accounts who have not bought anything on Steam.

# Installation

Extract the release zip and place the contents in `sm_plugins`.

# Config

This plugin has it's own config which is placed in your global config folder when the plugin is run for the first time.

Default config:
```json
{
"block-vpns": true,
"iphub-apikey": "put-key-here",
"strictmode": false,
"block-new-steam-accounts": true
}
```

`block-vpns` - Turns blocking of VPNs on or off.
`iphub-api-key` - API key required for VPN blocking. Get one here: https://iphub.info/apiKey/newFree
`strictmode` - Turns on stricter VPN blocking. Not recommended as it may flag some players incorrectly.
`block-new-steam-accounts` - Blocks steam users who have not bought anything on steam as they are likely not real accounts.

# Command

`vs_reload` - Reloads the vs config.

0 comments on commit d0db535

Please sign in to comment.