Tom Nook Bot

This project is a Discord bot that can post to a channel within a server to announce new deals for free games available for PlayStation Plus. The bot can also check the Nintendo eShop and PlayStation Store for deals on tracked games.

The project is currently being developed in the two branches as there is also a version that can be deployed to Heroku.

The application is built using JavaScript as the core language and discord.js for connecting with Discord services for basic bot functionality.

Motivations

I decided to work on this project since I was looking to have a replacement for another bot that was forced through some changes because of Heroku. Rather than relying on compatability with the previous bot, which was more of an RSS bot, I started to work on this version to focus on my needs for deal tracking.

Installation

• Clone the repository
• Install Node
• npm install

Usage

• Create user and database that is compatible with Sequelize
• Create .env using the example as a starting point
• node index.js

Features

Epic Games Free Games

Weekly games given away by the Epic Games Store can be posted.

PlayStation Plus Free Games

Monthly games given away for the PlayStation Plus membership can be posted using articles from the official PlayStation Blog.

Game Tracking

Use a number based menu to view, add, and remove tracked games. Games currently on sale are denoated with the ON SALE text.

Game sales will also be posted when they are first detected being on sale.

At the moment only titles from the PlayStation Store and the Nintendo eShop can be tracked. Price checks are set in the config using a string compatible with node-schedule.

Help Menu

Config

Here is an explanation of the various config variables required for the bot to work:

• configIcon: Icon for various setting menus
• DATABASE_URL: Heroku database URL (Only needed for a Heroku instance)
• dbDialect: Database dialect (Read the documentation for Sequelize)
• dbName: Database name (Only needed for a local database)
• dbUser: Database user (Only needed for a local database)
• dbPass: Database user password (Only needed for a local database)
• epicFreeURL: URL that returns a JSON object with the Epic Games freebies
• epicGameURL: Base URL for an Epic Games product page
• epicIcon: Icon for an Epic Games post
• epicStoreURL: Base URL that returns a JSON object of an Epic Games product
• eshopImageURL: Base URL that returns a header image of a Nintendo product
• eshopIcon: Icon for a Nintendo eShop post
• eshopURL: Base URL that returns a JSON object of a Nintendo product
• prefix: Prefix used for bot commands
• psIcon: Icon for a PlayStation Store post
• psPlusIcon: Icon for a PlayStation Plus post
• psPlusURL: RSS feed for the PlayStation Plus articles
• psStoreURL: Base URL that returns a JSON object of a PlayStation product
• scheduleEpic: Schedule to search for the weekly freebies from Epic Games Store
• schedulePsPlus: Schedule to search for the announcement of monthly PS Plus games
• scheduleTracked: Schedule to check all tracked games from its digital storefront
• token: Discord bot token

Credits

• Epic Games Store: https://www.epicgames.com/store/
• Nintendo eShop: https://www.nintendo.com/games/buy-digital/
• PlayStation Store: https://store.playstation.com/

Images seen in the above demo screenshots are used only for demonstrational purposes and are not distributed in the source code. Any logos belong to their respective owners.

Dependencies

This software uses the following dependencies which are distributed under their respective licenses:

• discord.js - Apache-2.0 License
• dot-env - BSD-2-Clause
• node-fetch - MIT
• node-schedule - MIT
• pg - MIT
• rss-parser - MIT
• Sequelize - MIT