This project is licensed under the GNU General Public License v3.0. This basically means you can redistribute this product with modification, for patent or private use, as long as you accredit me and keep the license on your derivation of the project. You may NOT distribute the code as closed-source. Please follow the aforementioned link for more information.
This is a Discord bot that scrapes SEPTA's TrainView at regular intervals and returns delays for user-inputted train services (3 or 4 digit numbers) in the form of a rich embed. Its feed updates automatically every two minutes.
This bot is intended to be used in one server per host, posting messages to a locked channel, so as it is the only user that can post in the channel. Using this bot in a public channel or one that is unlocked to various people may be problematic.
Once you have downloaded the source, follow these instructions. (Most of these are things you'd do when setting up any Discord bot; it is assumed you have Discord developer mode turned on in settings)
- A file named 'config-template.json' is included in this download. Rename this to 'config.json'.
- Go to your Discord developer portal and create a new application.
- Enter the Bot tab and set up the bot. At this point, a token field will be present. Press the Copy button below it, and paste it into the config file, replacing "YOUR_BOT_TOKEN". (Keep the double quotes for this, and for all copy-pastes into the config file)
- Replace "YOUR_BOT_ID" with the Application ID, found in the General Information section with a Copy button below it.
- Replace "YOUR_SERVER_ID" with the ID of the server you will add the bot to.
- Replace "YOUR_CHANNEL_ID" with the ID of the channel you would like the bot to send messages to. (Refer to the About section for important info on this)
- 6.5. (OPTIONAL) Replace "["YOUR TRAINS HERE", "EACH SERVICE NUMBER", "SEPARATED BY COMMAS"]" with an array of train numbers you would like tracked right when the bot launches. Keep the double quotes AND the square brackets. Remember that this is not required as you can modify this list through bot commands.
- To add the bot to the server, go to the OAuth2 section of the developer's page. Scroll to the bottom. Under Scopes, you must tick 'bot' and 'applications.commands'. Under Bot Permissions, tick 'Administrator'.
- This gives you a link to add the bot to any server you manage. Follow Discord's on screen instructions after copying this link into your browser.
- Run 'startbot.bat' and the bot should go online.
- discord.js
- cron
- fs
- cheerio
- request-promise (currently deprecated, a future update will replace this with a more up-to-date library)
Massive thanks to the team behind SageV2, notably Ren Ross and Ben Segal, for their continued assistance and encouragement for development.
Got any bugs to report? Feature suggestions? Toss them in the issues section.