https://github.com/animenosekai/takt
Power your discord calls with music 🎐
https://github.com/animenosekai/takt
arkayz-private bot discord music taktop
Last synced: 8 months ago
JSON representation
Power your discord calls with music 🎐
- Host: GitHub
- URL: https://github.com/animenosekai/takt
- Owner: Animenosekai
- License: mit
- Created: 2021-12-23T03:13:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T12:35:14.000Z (almost 2 years ago)
- Last Synced: 2025-05-07T21:46:36.357Z (about 1 year ago)
- Topics: arkayz-private, bot, discord, music, taktop
- Language: Python
- Homepage:
- Size: 2.42 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# takt
***Power your discord calls with music 🎐***
[](https://pypi.org/project/takt/)
[](https://pepy.tech/project/takt)
[](https://pypistats.org/packages/takt)
[](https://pypi.org/project/takt/)
[](https://pypi.org/project/takt/)
[](https://github.com/Animenosekai/takt/blob/master/LICENSE)
[](https://github.com/Animenosekai/takt)
[](https://github.com/Animenosekai/takt/actions/workflows/codeql-analysis.yml)
## Index
- [Index](#index)
- [Purpose](#purpose)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Option 1: From PyPI](#option-1-from-pypi)
- [Option 2: From Git](#option-2-from-git)
- [FFmpeg](#ffmpeg)
- [Usage](#usage)
- [CLI](#cli)
- [Running](#running)
- [Prefix](#prefix)
- [More](#more)
- [Invite](#invite)
- [Discord](#discord)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [Built With](#built-with)
- [Authors](#authors)
- [Licensing](#licensing)
## Purpose
`takt` is a simple, lightweight and privacy-focused music bot for your [Discord](http://discord.com) servers.
You are just a few seconds away from having your own private music discord bot !
## Getting Started
These instructions will get you a copy of the project up and running on your local machine.
### Prerequisites
You will need Python 3 to use this module
```bash
Minimum required versions: 3.8
```
Although the code itself is made compatible with Python >=3.6, the dependencies require at least Python 3.8.
Always check if your Python version works with `takt` before using it in production.
## Installing
### Option 1: From PyPI
```bash
pip install --upgrade takt
```
> This will install the latest version from PyPI
### Option 2: From Git
```bash
pip install --upgrade git+https://github.com/Animenosekai/takt.git
```
> This will install the latest development version from the git repository
You can check if you successfully installed it by printing out its version:
```bash
$ takt --version
1.0
```
### FFmpeg
You also need [`ffmpeg`](http://ffmpeg.org) installed on your computer to be able to run `takt` properly.
## Usage
### CLI
#### Running
Running takt is dead simple:
```bash
takt --token=
```
And this is even easier if you set the `TAKT_DISCORD_BOT_TOKEN` environment variable:
```bash
takt
```
> **Note**
> You could also try hosting your bot on Heroku directly by using this repository since it already has a [`Procfile`](https://github.com/Animenosekai/takt/blob/main/Procfile)
#### Prefix
You can set the bot's command prefix using the `--prefix` argument:
```bash
takt --prefix=">"
```
#### More
For more information, head over to your terminal and enter:
```bash
takt --help
```
### Invite
Here is the current invite URL for the public version:
>
You can create your own URL by replacing your Client ID:
```http
https://discord.com/api/oauth2/authorize?client_id=&permissions=274881055744&scope=bot%20applications.commands
```
This Client ID can be found on your Discord Developer Portal, after selecting your bot, under the *OAuth2* section.
> **Warning**
> The live public version of the bot is almost always down and shouldn't be used for anything other than development
### Discord
Here is a list of commands you can use:
- `+play `: Searches on YouTube and plays the first result
- `+play `: Play the given link
- `+playing`: Show the current song playing
- `+pause`: Pause the current song
- `+resume`: Resume the current song
- `+skip`: Skip the current song
- `+queue`: Show the current queue
- `+clear`: Clear the queue
- `+stop`: Stop the music and clear the queue
- `+loop`: Toggle looping
- `+loop `: Enable or disable looping
- `+looping`: Show the current loop status
- `+latency`: Show the current latency
- `+connected`: Show if the bot is connected to a voice channel
- `+help`: Show this message
- `+help `: Show specific command's help
> **Note**
> The `+` prefix is the default one and can be changed as explained in [*Prefix*](#prefix)
Head to your discord server and check `+help` or `+help ` for further details on the different commands (aliases, examples, etc.)
## Deployment
This module is currently in development and might contain bugs.
Feel free to report any issue you might encounter on takt's GitHub page.
## Contributing
Pull requests are welcome. For major changes, please open a discussion first to discuss what you would like to change.
## Built With
- [nasse](https://github.com/Animenosekai/nasse) - the logging system
- [discord.py](https://github.com/Rapptz/discord.py) - to use the discord API
- [discord-py-slash-command](https://github.com/interactions-py/interactions.py) - to create slash commands on discord
- [youtube-dl](https://github.com/ytdl-org/youtube-dl) - to retrieve sources to play in voice channels
- [youtube-dlp](https://github.com/yt-dlp/yt-dlp) - to retrieve sources to play in voice channels
- [ffmpeg](http://ffmpeg.org) - to process audio
## Authors
- **Animenosekai** - *Initial work* - [Animenosekai](https://github.com/Animenosekai)
## Licensing
This software is licensed under the MIT License. See the [*LICENSE*](./LICENSE) file for more information.