HoloPomodoro

This is a fan made pomodoro timer bot. It encourages you as your Oshi VTuber and send you a clip while taking a break.

demo.mp4

Platforms

Try the bot on these chat platforms:

• Messenger (under verification)
• Telegram

Getting Started

You have to finish the Environments Setup before start developing.

Run the app in development mode with:

npm run dev

The command does two things:

1. Start a dev server up. It'll refresh automatically when codes changed.
2. Connect a HTTP tunnel to a https://xxx.t.machinat.dev endpoint. It's used to receive webhook requests from the chat platforms.

Environments Setup

Chat Platform Settings

You need to configure the platforms and fill the settings in .env file. Check .env.example file for guides and usage example.

Run Dev Server

Start the server with npm run dev command. It should work if all the required environments are filled at the last step.

Initiate Platform Bindings

Keep the dev server runnning and execute this command in a new command line tab:

npm run migrate

This register webhooks and other settings on the chat platforms. If you want to cancel these changes, use npm run migrate -- --down to revert.

Start Developing

Now you can go to the chat platforms and try your bot. Keep the dev server running while developing. The changes in codes will immediately reflect on the bot.

Learn More

Here are some resources to learn Machinat framework:

• Documents - complete guides by topics
• Tutorial - a step-by-step tutorial to make an app
• API references - detailed framework API

Special Thanks

• All the clip data is fetched from Holodex API