Initial Commit

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67b6aa9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# No #TF2
+
+Kick players with "#___TF2" in their name
+
+## Requirements
+
+- Sourcemod and Metamod
+
+## Installation
+
+1. Download the file `notf2.smx` and place it in your `serverfiles/tf/addons/sourcemod/plugins` folder
+2. Restart the server or type `sm plugins load notf2` in the console to load the plugin.
+
+## Usage
+
+NoTF2 works automatically and will kick players if they have a TF2 related hashtag in their name. The regex pattern used to detect inappropriate names is: `#.*tf2` using [PCRE](https://pcre.org/), and is case insensitive. Some example hashtags that will be kicked include: `#SaveTF2`, `#savetf2`, `#KillTF2`, `#dpuashduawhd                  TF2`
+
+## ConVars
+
+```raw
+ntf_enabled <0/1>   (Default: 1) - Kick players with inappropriate names
+ntf_admins  <0/1>   (Default: 0) - Kick admins with inappropriate names
+```