skyscraperbot / skyscraper

Discord weather bot deployed to Heroku written in Java built with JDA and Gradle.

Skyscraper Discord Weather Bot

Are you ever curious about what the outside world feels like while you're inside gaming? Do you ever want to see into the future with a simple command? Then look no further! Made using JDA and the Gradle build tool, the Skyscraper discord bot is a super simple tool, that allows you to look at the realtime weather and forecast.

How can I add this to my Discord Server?

If you're interested in adding the Skyscraper Discord Weather Bot to your server, the most up-to-date version is always available to add by visiting our website and clicking Add to Discord.

What do I need to develop?

A discord bot token. Check out the Discord docs on how to get started developing Discord bots.

Getting Started

Getting started running the bot locally is very straight forward:

• Clone the repository from Github.

  git clone https://github.com/skyscraperbot/skyscraper

• Enter the project's directory.

  cd skyscraper/

• Build the project.

  ./gradlew clean build

• Run the project, using your discord bot token.

  ./gradlew run --args "your discord bot token here"

Having issues using gradlew? Read this.

Available Commands

Skyscraper provides four basic commands:

• /weather(city) Provides the current weather of the inputted city
• /forecast(city) Provides 12 hour tri-hourly forecast for inputted city
• /spc Provides nationwide weather radar for the entire country
• /aqi(city) Provides the Air Quality Index of the designated city

Learn More

Checkout our wiki for more detail about each command and more information on how to get your development environment setup to contribute.

skyscraper's Issues

Entering ZIP code into city returns incorrect result

Enter /forecast city:48130 should have returned Dexter, MI but it returned Bakio, Autonomous Community of the Basque County

Build Guideline Code

Provide guideline code samples to the main repository for members to refer to when designing their own code samples.

1. Clone repository
2. Create new local branch
3. Build sample code
4. Submit a pull request

Weekly forecast

Commands don't always register on build

There is a definite issue with the build process for the application that sometimes when it is ran some of the commands do that register upon build.

It happens in lines 42-45 of DiscordBot.java

            CommandListUpdateAction commands = discordBot.updateCommands();
            commands.addCommands(new AirQualityCommand().getCommandData()).queue();
            commands.addCommands(new WeatherCommand().getCommandData()).queue();
            commands.addCommands(new ForecastCommand().getCommandData()).queue();

Whichever command is currently last on that list sometimes doesn't register and sometimes does when the application launches.

Create a way to bookmark locations

Provide options to forward data to DMs on a routine basis
!location

Set up third-party host

Find a third-party hosting service to store and push our repository code to the bot.

Update README.md file

Update README.md file with details about the app

Impliment a embedded weather radar

Daily synopsis command

Command options have incorrect requirement

In weather, forecast, and city commands the city options is currently optional but should be required.

In the spc command the private option is currently optional but should be required.

Setup Wiki

Setup repository wiki page with how to use the app

Setup GitHub Page

Setup github page that shows up at skyscraperbot.github.io/skyscraper

Setup CICD pipeline

Create a CICID pipeline that will rune test, build the app, and deploy it to Heroku from the main branch of the repository.

Provide severe weather alerts