naka

module
v1.5.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2024 License: MIT

README

Naka

Naka is a discord bot to play song from youtube.

Naka's name is taken from japanese cuiser. Also, exists in Kantai Collection games and anime as a fleet's idol. To live up its name, this bot will 'sing' for you like an idol.

Features

  • Play song from youtube url.
  • Search song from youtube.
  • Song queue system.
    • Pause song.
    • Resume song.
    • Stop song.
    • Next song.
    • Previous song.
    • Skip/jump to specific song in queue.
    • Remove 1 or more song from queue.
    • Delete queue.

Requirement

Steps

  1. Git clone this repo.
git clone github.com/rl404/naka
  1. Rename .env.sample to .env and modify according to your configuration.
Env Default Description
NAKA_DISCORD_TOKEN* Discord bot token.
NAKA_DISCORD_PREFIX = Discord bot prefix command.
NAKA_CACHE_DIALECT inmemory Cache type (inmemory, redis).
NAKA_CACHE_ADDRESS Cache address.
NAKA_CACHE_PASSWORD Cache password.
NAKA_CACHE_TIME 24h Cache duration.
NAKA_YOUTUBE_KEY* Youtube API key.
  1. Run.
make

# or using docker
make docker
# to stop docker
make docker-stop
  1. Invite the bot to your server.
  2. Join a voice channel.
  3. Try =help.
  4. Have fun.

Bot Commands

Play Song
# Play song in queue.
=play

# Will put the song to queue and play.
=play https://www.youtube.com/watch?v=dQw4w9WgXcQ

# Will search, put the song to queue, and play.
=play suisei stellar
Queue Song
# See queue list.
=queue

# Will put the song to queue.
=queue https://www.youtube.com/watch?v=dQw4w9WgXcQ

# Will search and put the song to queue.
=queue suisei stellar
Other Commands
=join       # Bot join to voice channel.
=leave      # Bot leave voice channel.
=pause      # Pause song.
=resume     # Resume song.
=stop       # Stop song.
=next       # Go to next song in queue.
=prev       # Go to previous song in queue.
=skip 2     # Go to song number 2 in queue.
=remove 1 2 # Remove song number 1 and 2 from queue.
=purge      # Remove all songs from queue.

License

MIT License

Copyright (c) 2022 Axel

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL