Merge pull request #32 from gabeklavans/feature/update-start

Update start command to display explanatory welcome message

Author: gabeklavans

package-lock.json

@@ -39,6 +39,7 @@
     "@fastify/cors": "^8.4.0",
     "@fastify/swagger": "^8.12.0",
     "@fastify/swagger-ui": "^1.10.1",
+    "@grammyjs/parse-mode": "^1.10.0",
     "correct-frequency-random-letters": "^1.0.1",
     "date-fns": "^3.6.0",
     "dictionary-en": "^3.2.0",

package.json

@@ -1,18 +1,24 @@
-import { Bot, GrammyError, InlineKeyboard } from "grammy";
-import { GAME_LIST, GAME_START_BUTTON_TEXT } from "./constants";
+import { Bot, Context, GrammyError, InlineKeyboard } from "grammy";
+import { GAME_LIST, GAME_START_BUTTON_TEXT, WELCOME_MESSAGE } from "./constants";
 import { getSessionId, throwIfSessionExpired } from "./server/utils";
 import { SessionExpiredError } from "./server/errors";
+import { ParseModeFlavor, hydrateReply } from "@grammyjs/parse-mode";
 
 if (!process.env.BOT_API_KEY) {
 	console.error("environment misconfigured");
 }
 
 if (process.env.BOT_API_KEY == null) throw Error("Telegram bot API token is missing.");
-export const bot = new Bot(process.env.BOT_API_KEY!);
+export const bot = new Bot<ParseModeFlavor<Context>>(process.env.BOT_API_KEY!);
+
+bot.use(hydrateReply);
 
 const startingInlineKeyboard = new InlineKeyboard().game(GAME_START_BUTTON_TEXT);
 
-bot.command("start", (ctx) => ctx.reply("Welcome! Up and running."));
+bot.command(
+	"start",
+	async (ctx) => await ctx.replyFmt(WELCOME_MESSAGE, { link_preview_options: { is_disabled: true } }),
+);
 
 bot.command("game", async (ctx) => {
 	await ctx.replyWithGame(process.env.WORD_HUNT_SHORTNAME as string, {

src/bot.ts

@@ -1,3 +1,5 @@
+import { code, fmt, link } from "@grammyjs/parse-mode";
+
 export enum Game {
 	WORD_HUNT,
 }
@@ -21,7 +23,18 @@ export const TURN_MAX: { [key in Game]: number } = {
 	[Game.WORD_HUNT]: Number.MAX_VALUE,
 };
 
-export const GAME_START_BUTTON_TEXT = "Play now!"
+export const GAME_START_BUTTON_TEXT = "Play now!";
 
 export const MAX_SESSIONS = 10000;
 export const NUM_DAYS_SESSION_EXPIRED = 3;
+
+export const WELCOME_MESSAGE = fmt`Welcome!
+
+This bot is best used in ${link(
+	"Inline Mode",
+	"https://telegram.org/blog/inline-bots",
+)}. Just go to your chat then type the name of the bot with a space at the end: ${code(
+	"@gamejaybot ",
+)} and a list of games should show up! You can search through the games by continuing to type your search query. Then, tap on the one you want to start and it will send a new game to the chat you're in.
+
+Currently, Word Hunt Online is the only game available for GameJay, but more are planned to be added!`;