From feccbc05e66e5f3fa84460f1579fbe63a00cc54a Mon Sep 17 00:00:00 2001 From: Chris Plaatjes Date: Wed, 15 Feb 2023 14:12:00 -0500 Subject: [PATCH] Updated readme --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 429619b..ccc74d5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,33 @@ [![Build Status](https://ci.kizaing.ca/api/badges/kizaing/TeleTok/status.svg)](https://ci.kizaing.ca/kizaing/TeleTok) # TeleTok Telegram Bot +This bot will monitor any chats for TikTok links that are posted, and then will run the link through a [ProxiTok](https://github.com/pablouser1/ProxiTok) instance to generate a download link. The resulting video file will then get directly uploaded directly to your chat. -This bot is in early development, but the end goal is to have this bot automatically convert all tiktok links in a chat into a videofile that can be re-uploaded to the telegram chat \ No newline at end of file +## Building +Requirements: Dotnet SDK 6.0 + +Run `dotnet build` for a Debug instance +Run `dotnet publish` for a full release + +## Installation +### Requirements + * A telegram bot token + * A working [ProxiTok](https://github.com/pablouser1/ProxiTok) instance, either public or hosted yourself. (Please be kind and take bandwidth into account when using a public instance) + +### Binary + 1. Either build the application or download a release zip for your OS/architecture + 2. Edit the config.json and put your telegram bot token in the "token" field, and your chosen ProxiTok instance in the "ptInstance" field + 3. Run the TeleTok.exe/TeleTok executable + +### Docker + 1. You can build an image for yourself with `docker build teletok .` or you can pull a prebuilt image with `docker pull kizaing/teletok:latest` + 2. Copy the placeholder config.json from the repo to a location of your choosing + 3. Edit the config.json and put your telegram bot token in the "token" field, and your chosen ProxiTok instance in the "ptInstance" field + 4. Run the container with `docker run -v ${PWD}/config.json:/app/teletok/config.json -d kizaing/teletok:latest` + + +## To Do + - [x] Add better error and link handling + - [x] Process videos into telegram + - [ ] Add [Matrix](https://matrix.org) support + - [ ] Automate binary release publishing \ No newline at end of file