diff --git a/Setting-Up.md b/Setting-Up.md new file mode 100644 index 0000000..808f32f --- /dev/null +++ b/Setting-Up.md @@ -0,0 +1,19 @@ +To get started setting up Biscuit for your Discord server, grab the latest version from [here](https://git.fpghoti.com/thmsdy/Biscuit/releases). You can run this as a standalone Java application on your PC or server with ``java -jar ``. Additionally, if you have a Minecraft server running Spigot, you can place the Biscuit jar file in your plugins folder and it will run as a plugin on your Minecraft server. + +The first time you run Biscuit, the bot will generate a new config file and then crash. This is normal, as you have not yet assigned it a bot token. You need to create a bot user for your Discord bot: + +* First, go to the [Discord website](https://discord.com/) and login. +* Next, go to the [Developer application page](https://discord.com/developers/applications). +* Click "New Application". +* Fill in the name you want your bot to use. +* Click create. +* Go to the "Bot" tab and click "Add Bot". +* If you have an avatar picked out for your bot, you can set that here. +* Under "Privilaged Gateway Intents", enable the server members intent. You need this for the captcha to work. +* When you are ready, click the "Copy" button to copy your bot token. + +In your config.properties file, you should see an option called ``Bot-Token``. You want to paste the token you copied here. You may also want to take this oppertunity to configure your bot. Each option in the config is explained in the comments. You can also view the config [here](https://git.fpghoti.com/thmsdy/Biscuit/wiki/Config) if your comments are missing. + +**Note: If you want your bot to be able to log invite usage, you need to give the bot user the permission Manage Server.** + +Now, start up your bot. If you did everything correctly, you should see a link appear in your command line terminal. Visit this link to add your new bot to your Discord server. \ No newline at end of file