theprogrammershangout/lighthouse repository overview

⁠
⁠ ⁠ ⁠

A simple discord bot that allows members to alert staff.

⁠Required Permissions

• Read Messages
• Send Messages
• Embed Links
• Add Reactions

The bot will also either need the Mention @everyone, @here, and All Roles permission OR (suggested) a channel override for your configured alert channel.

⁠Commands

Refer to commands.md⁠ for a general list and explanation of all available commands. To learn about commands during runtime, use the help command!

⁠Getting Started ⚙️

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

⁠Requirements

• Docker
• Docker-Compose (compatible with docker-compose version 3.8)

Get the Docker version you need here⁠!

⁠Setup

Since this bot has a docker-compose.yml file and is hosted on DockerHub⁠, all you need to start your own version of Lighthouse locally is to clone this repository and set up the .env file.

The .env file is used to configure the bot token and owner id, in the following format:

BOT_TOKEN=<insert-bot-token>
BOT_OWNER=<insert-owner-id>

⁠For Linux and Mac run

$ cp .env.example .env

⁠For Windows run

> Copy-Item .env.example .env

Edit the .env file with your favourite editor, filling out the following properties:

• BOT_TOKEN (you can find the bot token under https://discord.com/developers/applications/bot-id/bot for an overview of all your bots visit https://discord.com/developers/applications⁠)
• BOT_OWNER (Where can I find my User/Server/Message ID?⁠)

Run the bot via docker-compose

$ docker-compose up --build --detach

⁠Versioning 🏷️

This project uses Semantic Versioning⁠ for versioning. For the versions available, see the tags⁠ on this repository.

⁠Authors 👤

• Moe Szyslak - Original Author - @Moe-Szyslak⁠

See also the list of contributors⁠ who participated in this project.

⁠Contributing 🤝

Contributions, issues and feature requests are welcome! Feel free to check the issues page⁠.

⁠Setup development environment 🛠️

For development you don't necessarily need Docker and Docker-Compose but Java

• clone this repository
• Open the project in your favourite Java / Kotlin IDE (JetBrains IntelliJ IDEA⁠ is the recommended IDE for Kotlin projects)
• For running the bot within your IDE you need to add your bot token as program argument or environment variable (You might have to figure out how to do that in your IDE. IntelliJ let's you do that under Run -> Edit Configurations...)

⁠Show your support ⭐️

Give a ⭐️ if this project helped you!

⁠License 📝

Copyright © 2020 Moe Szyslak⁠
This project is MIT⁠ licensed.