Merge branch 'master' of https://github.com/PolyMarsDev/Sokobot

README.md

@@ -0,0 +1,32 @@
+# Sokobot
+
+Sokobot is a Discord bot written with [JDA](https://github.com/DV8FromTheWorld/JDA) that lets you play [Sokoban](https://en.wikipedia.org/wiki/Sokoban), the classic box-pushing puzzle game.
+
+## Screenshots
+![reaction controls](https://cdn.discordapp.com/attachments/670425377503707146/721169251498590218/sokobot_1.gif)
+
+![wasd command controls](https://cdn.discordapp.com/attachments/670425377503707146/721170521714196571/sokobot_2.gif)
+## Features
+### Infinite levels
+The maps in Sokobot are randomly generated, increasing in difficulty as you progress.
+### Varied controls
+Sokobot has multiple control options to improve the player's experience, including reactions and wasd commands!
+### Simulataneous games
+Thanks to the power of Java HashMaps™️, multiple users can use the bot at the same time without interfering with one another.
+### Commands
+- ``!play`` can be used to start a game if you are not currently in one.
+- ``!stop`` can be used to stop your active game at any time.
+- ``!info`` provides some useful details about the bot and rules of the game.
+## Usage
+Grab the [latest .jar](https://github.com/PolyMarsDev/Sokobot/releases) or [build it yourself](#compiling). Then, create a Discord Bot Application [here](https://discord.com/developers/applications/) and paste the bot token into ``token.txt``. Then, ensure the two files are in the same directory and run the .jar file.
+
+
+
+## Compiling
+
+Install [Java 8 JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) and [Gradle](https://gradle.org/).
+In the root folder of the project, execute ``gradlew shadowJar``.
+The compiled .jar file will be located in ``build/libs``.
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Feel free to create a fork and use the code for any noncommercial purposes.