This repository has been archived by the owner on Mar 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Fixed commands - Fixed for mods to update in monitor if removed or added - Finished Read me with basic instructions - Minor fixes
- Loading branch information
Showing
2 changed files
with
68 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,60 @@ | ||
# Steam-Workshop-Monitor | ||
Discord bot to monitor collection of mods on the Steam Workshop and notify on update to selected discord server via Nextcordbot API. | ||
# Steam-Workshop-Monitor<br />![GitHub all releases](https://img.shields.io/github/downloads/UrekD/Steam-Workshop-Monitor/total?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/UrekD/Steam-Workshop-Monitor?style=for-the-badge) ![GitHub last commit](https://img.shields.io/github/last-commit/UrekD/Steam-Workshop-Monitor?style=for-the-badge) ![GitHub stars commit](https://img.shields.io/github/stars/UrekD/Steam-Workshop-Monitor?style=for-the-badge) | ||
|
||
Discord bot to monitor collection of mods on the Steam Workshop and notify on update to selected Discord channel via Nextcordbot API. | ||
# Requirements | ||
|
||
- Python 3.10 or later | ||
- Python pip -> requirements.txt | ||
- Discord bot token | ||
# Setup | ||
**Linux** | ||
```py | ||
git clone https://github.com/UrekD/Steam-Workshop-Monitor/ | ||
cd Steam-Workshop-Monitor/ | ||
pip3 install -r requirements.txt | ||
#Change vars on lines 10-15 of WorkshopMonitor.py | ||
python3 WorkshopMonitor.py | ||
#Wait till config fills then ctrl+c | ||
#Comment out line 13 and start again | ||
python3 WorkshopMonitor.py | ||
``` | ||
**Windows** | ||
```py | ||
Downloadn the repo and extract to an empty folder | ||
Open a CLI ex. CMD,PS,GitBash in the directory | ||
pip3 install -r requirements.txt | ||
#Change vars on lines 10-15 of WorkshopMonitor.py | ||
python3 WorkshopMonitor.py | ||
#Wait till config fills then ctrl+c | ||
#Comment out line 13 and start again | ||
python3 WorkshopMonitor.py | ||
``` | ||
Will relocate vars to a separate config file, then a .exe for Windows should be possible. | ||
# Commands | ||
**$ping** | ||
|
||
![image](https://user-images.githubusercontent.com/38784343/140180871-9647cb59-8bdd-4af5-bccf-f7864e572628.png) | ||
|
||
**$list** | ||
|
||
Returns a list of mods in a JSON object, format 'MODID#TIME'. | ||
Time format is in Unix epoch time https://www.epochconverter.com/ | ||
|
||
![image](https://user-images.githubusercontent.com/38784343/140181008-43802124-4154-461f-ad78-50a2a69f9425.png) | ||
|
||
**$remove** | ||
|
||
Firstly locate the mod via the ID and copy the whole format and remove it via the command. | ||
|
||
![image](https://user-images.githubusercontent.com/38784343/140181570-7d4b4d49-3468-4919-9571-febe9ccd0ad8.png) | ||
|
||
**$add** | ||
|
||
Add the mod with the following format MODID#000 ex. "$add 450814997#000" | ||
If you use 000 it should not trigger a update notification. | ||
|
||
![image](https://user-images.githubusercontent.com/38784343/140181637-731a1a32-6538-406e-8fcc-0e5eb925c143.png) | ||
|
||
# Example | ||
|
||
![image](https://user-images.githubusercontent.com/38784343/140175801-4395f62c-a4bf-4de5-9f50-59e4909336a2.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters