Skip to content

Commit

Permalink
Merge pull request #36 from Sebi94nbg/Various-cleanups
Browse files Browse the repository at this point in the history
Various changes
  • Loading branch information
Sebbo94BY authored Jan 25, 2023
2 parents 557cf54 + 9323cdb commit 8e97821
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 12 deletions.
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

9 changes: 4 additions & 5 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ Software:
3. Switch into the project directory: `cd teamspeak3-python-bot/`
4. List available versions: `git tag`
5. Switch to the latest version: `git checkout <version>`
6. Update the Git submodules: `git submodule update --init --recursive`
7. Create your own config file: `cp config.example.ini config.ini`
8. Adjust the config file: `vim config.ini` (see [configuration](/docs/CONFIGURATION.md#configuration) for further information)
6. Create your own config file: `cp config.example.ini config.ini`
7. Adjust the config file: `vim config.ini` (see [configuration](/docs/CONFIGURATION.md#configuration) for further information)

Instead of setting up the above Python virtual env, you can also skip the steps 4 and 5 and instead install the dependencies globally. However, this is not recommended as you could run other Python projects on the same system, which require then a different version of specific dependencies.

Expand All @@ -52,7 +51,7 @@ pip3 install -r requirements.txt
Then, simply start the bot:

```shell
./main
./main.py
```

You will not see any output, but when you check the `logs/` directory, you should see some log files. The bot should be also connected to your TeamSpeak server. Right now, it's just not doing anything as no plugin is configured yet.
Expand All @@ -62,7 +61,7 @@ You can stop the bot by aborting the above command using the key combination `Ct
If you want to run it like this, simply run the following command to put the process into the background:

```shell
./main &
./main.py &
```

## Advanced (recommended)
Expand Down
5 changes: 2 additions & 3 deletions docs/UPDATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ There might be some breaking changes, which will affect your installation. Pleas
5. Switch to the respective newer version: `git checkout <version>`
6. Confirm, that you are on the respective new version: `git branch` (marked with a star in front of the line)
7. If necessary, apply the necessary changes for the breaking changes from the release notes
8. Ensure, that you have the respective Git submodules installed: `git submodule update --init --recursive`
9. Ensure, that you have the respective Python requirements installed:
8. Ensure, that you have the respective Python requirements installed:
- The systemd unit does this automatically. This is only needed, when you run the bot different.
- Activate the Python virtual environment: `source venv/bin/activate`
- Install the requirements: `pip3 install -r requirements.txt`
10. Restart the bot: `sudo systemctl restart teamspeak-bot.service`
9. Restart the bot: `sudo systemctl restart teamspeak-bot.service`

That's it. Your bot should be updated now and connected to your TeamSpeak server again.
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
ts3API[ssh]
# https://github.com/Murgeye/teamspeak3-python-api
ts3API[ssh]==0.9.4

# Only for fixing this Pylint error: ModuleNotFoundError: No module named 'typing_extensions'
# See https://github.com/Sebi94nbg/teamspeak3-python-bot/actions/runs/3864557425/jobs/6587510172
Expand Down

0 comments on commit 8e97821

Please sign in to comment.