Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 1.92 KB

README.md

File metadata and controls

70 lines (44 loc) · 1.92 KB
Raw

Liff (Discord Bot)

A simple Discord Bot used in a small friend group server.

This repository contians Liff is a Discord bot implemented using the Hikari api and is used in a small friend group Discord server.

Some of its functions are as follows, maintain roles, play music, and provide simple commands; such as rolling a dice or randomly picking teams of the members within the server.

Installation

Prerequisites

Python version >3.8

pip

pip packages - Hikari, Hikari-lightbulb, youtubedl, dotenv, uvloop{if on a unix-like system}

ffmpeg

Liff's Discord client key in a .env file on root with the token labelled 'KEY'

python -m pip install -r requirements.txt

Linux & Mac:

git clone git@github.com:DavidByrne98/DiscordBot.git

Windows:

git clone git@github.com:DavidByrne98/DiscordBot.git

Usage example

The bot can be used to maintain roles within a server as well as grant special members a rare roll based on member voting. As well as providing simple commands such as rolling a die or providing a polling system for the server. The bot can also play youtube songs once requested by using the '!play' command along with either a search query or a url.

Development setup

Install git
Install python (3.8+)
Install pip packages
    Hikari, Hikari-lightbulb, uvloop, dotenv, youtubedl, pynacl
Install ffmpeg

Release History

  • 0.1.0
    • Current verison (work in progress)

Meta

David Byrne – @YourTwitter – sampleemail@gmail.com

Distributed under the MIT license. See LICENSE for more information.

https://github.com/DavidByrne98/Liff

Contributing

  1. Fork it (https://github.com/yourname/yourproject/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request