Would You Rather | Telegram Bot

Info

• 250 Default Would You Rather Questions. (https://improb.com/would-you-rather-questions/)
• Suggested questions are only visible to the channel/user where it was suggested.

Usage

Command (Case-insensitive)	Parameter	Alias	Description
/WouldYouRather		/WYR	Send a random Would You Rather question.
/WouldYouRather		/WYRSuggest /WYRS	Send a SUGGESTION message. Replay to that message to submit your suggestion. See format in the next section.
/WouldYouRatherMerge	ChannelId	/WYRMerge /WYRM	Merge Channel Questions to Default Questions. Command must be executed in MASTER_CONTROL channel. See Environment Variables below.

Suggestion Format

    Format:    (Would you rather)? Option1 or Option2

    Examples: Would you rather be free or be totally safe?

                     Be free or be totally safe?

Clone

$ git clone https://github.com/RobinPH/would-you-rather-telegram-bot.git
$ npm i
$ npm run start

Setup

Environment Variables	Description
MONGODB_URI	MongoDB URI
TOKEN	Authorization Token /token@BotFather
BOT_ID	First 10 numbers of TOKEN
MASTER_CONTROL	ChannelId of Group Chat

Importing Default Questions

• Make .txt file where each line is a question with the same format as Suggestion Format. See Example at ./DefaultQuestions/questions.txt
• Run node importDefault.js [txt path] [MONGODB_URI]. Wherein txt path is the path to the .txt file, and MONGODB_URI is the MongoDB URI.
• NOTE: importDefault.js splits the .txt file with \r\n.

Bot Settings

interface QuestionData {
  optionsIndex?: Array<number>,
}

interface BotSetting {
  messages?: {
    EXAMPLES?: Array<string>;
    INVALID?: string;
    FORMAT?: string;
    SUGGESTION?: string,
    ADDED_SUCCESSFUL?: string,
    NO_PERMISSION?: string,
    MERGE_USAGE?: string,
    MERGE_SUCCESS?: string,
    MERGE_FAILED?: string,
  },
  RegExp?: RegExp;
  questionData?: QuestionData;
  masterControl?: number;
}

EXAMPLES Array of Examples for /WouldYouRatherSuggest.

INVALID Message when User inputted wrong format in /WouldYouRatherSuggest.

FORMAT Message for format in /WouldYouRatherSuggest.

SUGGESTION Message for /WouldYouRatherSuggest.

ADDED_SUCCESSFUL Message for /WouldYouRatherSuggest when new question is added successfully.

NO_PERMISSION Message for No Permission for /WouldYouRatherMerge.

MERGE_USAGE Usage Message for /WouldYouRatherMerge.

MERGE_SUCCESS Message for successful merge.

MERGE_FAILED MEssage for failed merge.

RegExp Used to capture Option1 and Option2.

optionsIndex Array of number (index) of options in RegExpMatchArray.

masterControl Channel Id where /WouldYouRatherMerge can only be executed.