GitXplorerGitXplorer
Y

mermaidjs-discord

public
8 stars
1 forks
0 issues

Commits

List of commits on branch main.
Verified
a99a504182c0b0050e9862f535968c4c46c356a2

add setStatus feature to bot (#1)

aaf-chacon committed 3 years ago
Unverified
9d7d40eeb22de07b2bdee854860f3b31629e0ac0

chore: allow more themes

YYash-Singh1 committed 3 years ago
Verified
602797726e9463d42abaf313e15739d668447a31

chore: revert license change

YYash-Singh1 committed 3 years ago
Verified
615ee2649d18f921aa2f23e9cc7e0ba1209998e3

chore: Add installation and testing instructions (#2)

aaf-chacon committed 3 years ago
Unverified
10e9c26a813ef46f74f5bafc34056729628880ba

chore: reply to theme messages instead of just sending

YYash-Singh1 committed 3 years ago
Unverified
8bb36316100d62b72d5b6e02194adcad5853875e

feat: confirmation message for setTheme

YYash-Singh1 committed 3 years ago

README

The README file for this repository.

mermaidjs-discord

mermaidjs-discord is a discord bot that allows you to render Mermaid.js diagrams in your discord chats.

Server Installation instructions

Click here to invite the bot to your server.

Type in !mermaid-help for help on how to use this bot.


Running this bot locally

Installation


This installation asumes you have python3 installed on your machine and know how to use pip.

Run the following in the project root directory to get all the dependencies

pip install poetry
poetry install

Bot Token


After we have that installed, we need to grab a bot token from Discord.

Go to this url and create a new application.
Add a name for your local bot, something like: your-username-test-bot.

After you've made an application, you should be redirected to a page with all of the app's details on it. Scroll to the bottom of this page and press "create a bot user". You will then have a "click to reveal" link that shows you your bot's token.

Run the following in your terminal:

export TOKEN=[the token you copied above]

Make sure you make that bot private in that page.


Adding your Bot


  1. On the side tab go to OAuth2>URL Generator.

  2. Under scopes, select bot.

  3. Under permissions, select admin.

  4. Use the generated URL to add it to your personal discord server to test out that your code is working correctly.