Skip to content

Latest commit

 

History

History
112 lines (77 loc) · 3.18 KB

README.md

File metadata and controls

112 lines (77 loc) · 3.18 KB

MUNchkin

A discord bot for Model United Nations.

Installation

MUNchkin is running on Heroku. To add the bot to your own server, click here. Make sure MUNchkin has the correct roles needed to access any channels that it will use. The 'Chair' role is required to use Chair commands. Delegate commands can used by anyone.

Commands

MUNchkin has a variety of commands used to aid online MUN sessions in discord. To start a session, join a voice channel and write:

!startSession

This enables the rest of the commands for use.

MUNchkin has a help facility which can be used by calling !help to list all commands. More help on a certain command can be retrieved by calling:

!help [command name]

MUNchkin's default prefix is ! which can be changed using:

!prefix [new prefix]

Below is the list of help information for each command:

Chair Commands:

!startSession 
Enables all commands for a session and invites bot to voice channel.

!register [delegate name] [status]
Status can be present (p),present and voting(pv) or absent (a)

!viewRegister
Displays all registered delegations and their statuses.

!GS
Prints out the current general speakers list.

!popGS
Remove first delegate from general speakers list.
Used just after a speaker has finished.

!speak [delegate name] [time in seconds]
Yields the floor to the delegate. Starts a timer.

!propose mod [total time in min] [speakers time in sec] [country proposed] [topic]
Propose a moderated caucus.

!propose [unmod or other] [total time in min] [country proposed]
Propose an unmod or other type of caucus.

!mod [total time in min]
Starts a timer for Mod. Sending the word 'cancel' will cancel it, 'pause' will pause it. Plays a gavel sound when the timer is up (may not play if youtube cookies are not refreshed).

!unmod [total time in min]
Starts a timer for Unmod. Sending the word 'cancel' will cancel it, 'pause' will pause it. Plays a gavel sound when the timer is up (may not play if youtube cookies are not refreshed).

!voting [topic]
Starts a non-caucus vote. Useful for final vote or amendments.

!endSession
Disables session commands and disconnects bot from voice channel.
Clears GS list.

!chair [@member]
Gives chair role to another member.

!resume
Resume a previously paused caucus.

Delegate Commands:

!addGS
Adds your name to the general speakers list.

!tap
Alerts that you support the current debate.

!preamble
Displays list of phrases, useful for preambulatory clauses.

!operative
Displays list of phrases, useful for operative clauses.

!about
Provides information about MUNchkin.

!rules
Provides simplified ruleset for Harvard style MUN.

!notebook
Enable/disable notepassing for yourself.

!note [@user] message
Send a note to a user (you and them both need notepassing enabled).

Contributing

If you wish to contribute to this repository, join the support server and send a message there. Come back soon for updates, star and watch this repository.

Sponsorship

Consider donating to help maintain server resources for MUNchkin. It can be as low as $1!

License

GNU Affero General Public License v3.0