Update README with essential info

This commit is contained in:
Chev 2020-06-12 00:07:07 -07:00 committed by GitHub
parent 09a0ca79dd
commit f6e29d82f6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,2 +1,13 @@
# tf2-voice-ban-bots
Team Fortress 2 voice_ban.dt generator for bots
This is a Python script designed for Team Fortress 2 that will pull a list of known bots from [Pazer's TF2 Bot Detector](https://github.com/PazerOP/tf2_bot_detector/) and write their Steam IDs to a voice_ban.dt file.
Essentially what this allows for is the replacement of a user's current voice_ban.dt file, which is used to store a list of muted players. This will effectively mute most, if not all, known bots in-game, preventing them from spamming chat/voice chat.
Using this tool will not give you a VAC ban, nor should editing the list of muted players in your TF2 directory.
## How to use
Run the `tf2_voice_ban_bots.py` file. It will grab the list of bots and generate a voice_ban.dt file if you wish to do so.
## Requirements
Python 3.x or later
'requests' Python module