mirror of
https://github.com/aNNiMON/ffmpegbot
synced 2024-09-19 22:54:20 +03:00
Add readme and license files
This commit is contained in:
parent
114586f5ff
commit
5915ffa798
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2023 aNNiMON
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
30
README.md
Normal file
30
README.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ffmpegbot
|
||||
|
||||
Telegram Bot for re-encoding media
|
||||
|
||||
## Features
|
||||
|
||||
- change a video resolution, bitrate, frame rate, speed
|
||||
- change an audio bitrate, volume, pitch
|
||||
- apply audio effects
|
||||
- extract or remove audio from the video
|
||||
- resend video note as a regular video, or video as an audio track
|
||||
|
||||
## Requirements
|
||||
|
||||
- Telegram bot username and token, [@BotFather](https://t.me/BotFather)
|
||||
- JRE 16+ or JDK 16+ (for build)
|
||||
- `ffmpeg` must be installed and available in `PATH`.
|
||||
- `yt-dlp` for `/dl` command.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Build
|
||||
./gradlew shadowJar
|
||||
# Config
|
||||
cp ffmpegbot.yaml.template ffmpegbot.yaml
|
||||
vim ffmpegbot.yaml
|
||||
# Run
|
||||
java -jar ./build/libs/ffmpegbot-1.0-SNAPSHOT-all.jar
|
||||
```
|
Loading…
Reference in New Issue
Block a user