cosmoquestx / rocket-bot Goto Github PK

The Bot of the New generation of explorers for the CosmoQuest server on Discord. Assembled with official APIs and documentation, originally created using the Github Students Program tools.

Home Page: https://CosmoQuest.org/x/

JavaScript 96.93% Dockerfile 1.44% HTML 1.63%

discord-js discord-bot discord-api nodejs botkit-discord nasa-api weather-api mathjs

rocket-bot's Introduction

🚀 Rocket Bot (v2.3.1 Stable)

Check out all the different commands, and maybe make some more. With version 2.3 of Rocket Bot, you can do a lot.

Introduction

This is a bot built for the CosmoQuest server on Discord, it is a replacement for the CosmoQuest One which was an outdated version of the robot.

History

The original Rocket Bot was created by CosmoQuest community member Kaio Duarte. The current version is being maintained primarily by TheRealFakeAdmin and KeeperOfMaps.

Application Programming Interface (APIs)

🌑 NASA's APOD: We use the NASA API to access the full history of Astronomy Picture of The Day

🌒 Flickr API: Get images from the latest JWST posts.

🌓 OpenWeatherMap: OpenWeatherMap is an API for obtaining weather information

🌔 AviationWeather.gov: Source for the METAR and TAF data

🌕 Discord API: For everything basically

Docker Instructions

Docker - First install

Starting in the Rocket-Bot directory

cd CosmoQuestBot-master
Edit .example-env using your preferred IDE or text-editor. Fill out all necessary details (DISCORD_TOKEN, NASA_API_KEY, & WEATHER_API_KEY)

Try nano .example-env
After making your changes, save the file as .env.
Run docker build . -t rocket-bot:v2.3.1

Docker - Usage instructions

Run docker run --name rocket-bot-231 -d rocket-bot:v2.3.1 from anywhere on the system to start the bot
- To auto-restart after a server reboot, add the tag --restart always
After the first install, there is no need to run the build command until the next update. All the necessary packages have already been installed.

Docker - Stopping the container

Eventually you might want to stop the container, run the following commands to accomplish this:

docker ps displays all running process; locate rocket-bot:v2.3.1 & note the Container ID
- if it returns no process, you need to change your context by running docker context list then docker context use <context_not_marked_with_*>
  - run step 1 again
docker stop rocket-bot

After a short time, it should return the Container Name you just entered, this means it stopped successfully.
docker rm <container_id> (optional)
- Use this before updating to a new version

Configuration

Options

Name	Default	Type	Description
`botName`	`N/A`	`<string>`	The name of the bot [does not need to match username]
`debug`	`false`	`[bool]`	Enables debug features.
`devId`	`N/A`	`[string]`	User ID of the bot owner.
`discord`	`N/A`	`<url-string>`	Sets the Discord invite link.
`github`	`N/A`	`<url-string>`	Sets the GitHub repo link.
`throwInvalid`	`false`	`[bool]`	Toggles the `!<command> is not a valid command.` error message.
`version`	`N/A`	`<array>`	Defines the version.

rocket-bot's People

Stargazers

Watchers

Forkers

therealfakeadmin

rocket-bot's Issues

Prep for releasing v2.2.0

Hey @TheRealFakeAdmin, could you clean up the README.md and related files in nightly in anticipation of releasing v.2.2.0, please? Thanks!

Weather station ID sources

From someone I know at ECCC:
_

From the website: Home | World Weather Information Service

I clicked on Support and selected Download which brought me to:Download | World Weather Information Service

And selecting option 1. I go to: https://worldweather.wmo.int/en/json/full_city_list.txt

Also this:

Oh, I also found this page that might help: World Weather Records

Update CHANGELOG

CHANGELOG does not currently have all the new features of v2.2.0. These need to be added.

Bot responds to @here

@here & presumably @everyone mentions the bot, and there is no check for those, so it responds.

It shouldn't.

cookie command needs to accommodate usernames without an at-sign

The cookie command should be able to handle a username that does not start with an @-sign.

This should resolve the following errors:

2022-10-29T06:38:38.182091604Z     at Object.exports.run (/usr/src/app/commands/cookie.js:12:19)
2022-10-29T06:38:38.182097835Z     at Client.<anonymous> (/usr/src/app/main.js:135:21)
2022-10-29T06:38:38.182103034Z     at processTicksAndRejections (node:internal/process/task_queues:96:5)

Update packages

Security updates needed, 1 Critical; many High. Will do a rolling update.

LICENSE needed

We have no license selected for Rocket Bot. Having no license could be very limiting to the free-use of Rocket Bot. I suggest we select one to allow for guilt free use by others.

Here are the top 2 I have in mind, though feel free to suggest more:

The MIT License is short and to the point. It lets people do almost anything they want with your project, like making and distributing closed source versions.
The GNU GPLv3 also lets people do almost anything they want with your project, except distributing closed source versions.

Honorable Mention:

Apache License 2.0 is a permissive license whose main conditions require preservation of copyright and license notices.

New command: !kerbals

!kerbals <number of days|months|years>|<date>

Returns the number of kerbal equivalent to the number of days/months/years or since/until the date.

Considerations: Needs to calculate the value of a kerbal each time as it is a continuously changing constant.

Random image command

I made a typo when issuing the !ping command and @starstryder commented "I now want png to be a random image".

After some discussion, it was decided that maybe the random image could be a random APOD.

TAF command

Similar to the metar command, a !taf command would return the most recently issued TAF for a specified airport.