Configuring and running

Configuring

Before you do anything, you need to create a bot user to host ghost2 on. Go to Discord's developer page, create a bot, and copy the token for it. See this guide if you need help.

To configure ghost2, you need to give it a properties file. Create ghost.properties next to your .jar file (or in src/main/resources, if you're a developer). As of right now, all you need to give ghost2 is your token, so open ghost.properties and add just the following line:

ghost.token=<your token here>

Save the file and you're done with configuration. Continue to the Running section.

Running

Running ghost2 differs depending on whether you downloaded a release or cloned the repository for development.

Running: for users

ghost2's public releases come bundled with a Java runtime, meaning that you don't need to install anything beforehand. Just unzip the release, configure ghost2, run the start script, and you're off.

Running: for developers

Open the Gradle menu on the right side of the IDE, then start the bootRun task (located under Tasks -> application -> bootRun). This is an extended version of Gradle's run task provided by Spring that enables Spring to perform configuration and setup before the actual application launches. You'll be using it every time you run the bot.