Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/olian04/discord-sometimes-helpful-bot

A discord chat bot that provides tools for organizing and managing events.
https://github.com/olian04/discord-sometimes-helpful-bot

bot discord-bot discord-chat-bot discordjs discordjs-bot

Last synced: 9 days ago
JSON representation

A discord chat bot that provides tools for organizing and managing events.

Host: GitHub
URL: https://github.com/olian04/discord-sometimes-helpful-bot
Owner: Olian04
License: mit
Created: 2019-06-30T11:31:19.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-03-04T04:15:37.000Z (over 1 year ago)
Last Synced: 2024-05-01T14:53:42.051Z (7 months ago)
Topics: bot, discord-bot, discord-chat-bot, discordjs, discordjs-bot
Language: TypeScript
Homepage:
Size: 5.42 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # discord-sometimes-helpful-bot

A discord chat bot that provides tools for organizing and managing events.

## `!event [title]`

State that you are planning an event, then ppl may react with :thumbsup: / :thumbsdown: or :grey_question: depending on if they plan to attend or not. The event comment will update with a list of the ppl who have responded & in the order they responded.

Reacting with a :wrench: will alow you to change the title of the event. The bot the sends a DM to the user providing further instructions.

![](assets/event_demo_2.png)

![](assets/event_demo.png)

## `!poll [title]; [option0]; (option1); (option2); .... (option9)`

Create a poll with the given title and a range of up to 10 different vote options. The title and each option (excluding the last) needs to end with a semicolon `;`.

![](assets/poll_demo.png)

## `!roll [diceString]`

Rolls a set of dice. See [@olian/dice-roller](https://github.com/Olian04/dice-roller) for further reference.

## `!list`

Will PM you a list of all commands you have access to in the current channel. Buy default this list is empty.


_**Note:** Admins have access to all commands in all channels._

## `!enable [cmd_name]`

Will enable a command in the current channel to be used by all members who can send messages in that channel.


_**Note:** Admins can use all command in all channel, no matter if they are enabled in the channel or not._

## `!disable [cmd_name]`

Running `!disable my_command` will remove any privileges previously grated by running `!enable my_command`.

## Prerequisite

* [nodejs](https://nodejs.org)

* [npm (included in newer versions of nodejs)](https://github.com/npm/cli/releases/tag/v6.10.0)

* [firebase account](https://firebase.google.com/)

## Install & Run

1. Make sure you have installed all prerequisite software

2. Grab your firebase [service account](https://firebase.google.com/docs/admin/setup) credentials.

3. Grab your discord-bot secret from the [discord developer portal](https://discordapp.com/developers/applications)

4. Setup environment variables as seen in `.env.example`

5. Start the bot: `npm run start:prod`