tdp-countdown-bot

Bot that counts down to/up from a specified date with custom text/images

Usage

Steps to set up this bot:

1. Download the latest release and extract it to a folder of your choice.

2. Replace the contents of src/config/config.json with your own countdowns.

3. Add your Platform API Keys for Twitter, Mastodon, Tumblr and Discord to src/config/credentials.env.test and rename the file to credentials.env.

4. Create a new table called pictures in a postgres database.

   CREATE TABLE
   public.pictures (
       id serial NOT NULL,
       filename character varying(255) NOT NULL,
       picture_data bytea NOT NULL,
       category character varying(255) NOT NULL
   );
   
   ALTER TABLE
   public.pictures
   ADD
   CONSTRAINT pictures_pkey PRIMARY KEY (id);

5. Add .jpg pictures to the table.

   filename should contain the picture's file name.

   picture_data should contain a hex byte array of the actual picture data.

   category should contain a keyword which is specified as pictureSlot in config.json to filter for specific groups of pictures.

6. For the bot to work, you need to install the latest version of Node.js for your OS from here.

7. Once Node.js is installed, open the CLI of your choice/OS and navigate to the root path of the copy of this repository you downloaded earlier (the folder containing the file package.json)

8. Type npm install to install all the dependencies the bot needs to work.

9. To run the bot, type npm run start.

Congrats! The bot should now be up and running!