Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Wargamer-Senpai committed Mar 26, 2023
1 parent b97422b commit 42ba43c
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# teampy
a Bot for the teamspeak Matrix Chat
# teampy - teamspeak Matrix Chat Bot

# How to Setup

## Requirments
- Python 3.5 =<
- Linux/Windows (Linux not tested yet)

## Installation
- Download latest Release from [Release Page](https://github.com/Wargamer-Senpai/teampy/releases)
- Place folder to your desired location
- Open `config.py`
- Required:
- Enter matrix username and password (get these with the [TS5 Extractor](https://github.com/Gamer08YT/TS5Extractor))

- Optional:
- enter giphy api (can be optained freely from [developers gihpy](https://developers.giphy.com/dashboard/))

## Disclaimer
using this bot can result in breaking your account or getting it deleted (it shouldnt but can happen).
Dont use the bot to Spam, Troll or something else

0 comments on commit 42ba43c

Please sign in to comment.