https://github.com/toxicmushroom/melijn

A powerful multi-purpose discord bot
https://github.com/toxicmushroom/melijn

bot discord discord-bot discord-bots jda jda-bot jda-discord-bot

Last synced: 11 days ago
JSON representation

A powerful multi-purpose discord bot

• Host: GitHub
• URL: https://github.com/toxicmushroom/melijn
• Owner: ToxicMushroom
• License: mit
• Created: 2017-10-16T21:53:09.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-11T22:52:22.000Z (27 days ago)
• Last Synced: 2024-10-14T18:51:43.880Z (24 days ago)
• Topics: bot, discord, discord-bot, discord-bots, jda, jda-bot, jda-discord-bot
• Language: Kotlin
• Homepage: https://melijn.com/
• Size: 18.2 MB
• Stars: 76
• Watchers: 3
• Forks: 23
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Melijn - being rewritten here https://github.com/Melijn/melijn-bot

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/60761596055e49e88d9b8db1ffa65fdf)](https://www.codacy.com/manual/ToxicMushroom/Melijn?utm_source=github.com&utm_medium=referral&utm_content=ToxicMushroom/Melijn&utm_campaign=Badge_Grade)

[![Discord Bots](https://discordbots.org/api/widget/servers/368362411591204865.svg?noavatar=true)](https://discordbots.org/bot/368362411591204865)

[![Discord Bots](https://discordbots.org/api/widget/status/368362411591204865.svg?noavatar=true)](https://discordbots.org/bot/368362411591204865)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FToxicMushroom%2FMelijn.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FToxicMushroom%2FMelijn?ref=badge_shield)

[![Bots for Discord](https://botsfordiscord.com/api/bot/368362411591204865/widget)](https://botsfordiscord.com/bots/368362411591204865)

[![Discord Boats](https://discord.boats/api/widget/368362411591204865)](https://discord.boats/api/widget/368362411591204865)

[![forthebadge](https://forthebadge.com/images/badges/works-on-my-machine.svg)](https://forthebadge.com)

If you want to use code from Melijn you have to credit me and all our contributors. 

Contact me on discord for more information ToxicMushroom#0001

(I do not support changing the source code nor helping to build the source code.)

## How to self-host using [docker](https://docs.docker.com/get-docker/)

1. Copy `example-docker-compose.yml` to `docker-compose.yml`

2. Copy `example-postgres.env` to `postgres.env`

3. Copy `example.env` to `.env`

4. Uncomment one of the volumes in the melijn-postgres service for persistant storage

5. Make sure all the passwords, usernames and database names match between your `.env` file and the postgres and redis services

6. Fill in all the fields you can in `.env`, bot token, id, name, etc... (If you don't have tokens for spotify ect then don't expect commands related to spotify to work)

> These 2 steps are optional (see notes)

>7. You can build your own image from the source-code using `sudo docker build -t username/melijn:version .`

>8. Replace `toxicmushroom/Melijn:version` in `docker-compose.yml` with your `username/melijn:version`

9. Start docker compose with `sudo docker-compose up -d` (Make sure you're in the same folder as docker-compose.yml)

NOTES: 

- username/melijn:version can be replaced by eg. `ShadowGamer/melijn:v1`

- if you want to use your image you built on another machine then read the docker docs about `docker login` and `docker push` (you can publish images for free on https://hub.docker.com/)

- You can also skip steps 7 and 8 and checkout what the latest tag is on https://hub.docker.com/r/toxicmushroom/melijn (currently this is `toxicmushroom/melijn:14e88d3ab1afe5bba3d7442488a768f13e3e0077`). Make sure to replace the example tag in the `docker-compose.yml` with the latest tag.

Note. If required you can copy this environment folder anywhere your like, rename it, ect.

Be aware that this contains the login information to the local postgres storage which might hold user data collected from your discord server by melijn.

You should never share your environment with others.

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FToxicMushroom%2FMelijn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FToxicMushroom%2FMelijn?ref=badge_large)