From 3d76bc15d44bc669613ffaed6579f0ebe2251dac Mon Sep 17 00:00:00 2001 From: PolyMars <51007356+PolyMarsDev@users.noreply.github.com> Date: Fri, 12 Jun 2020 20:15:28 -0500 Subject: [PATCH 1/5] Create README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f70e986 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# 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/PolMarsDev/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. From c9522a4362af6dcbbc6bcecf1bf65589c4e05fb4 Mon Sep 17 00:00:00 2001 From: PolyMars <51007356+PolyMarsDev@users.noreply.github.com> Date: Fri, 12 Jun 2020 20:15:51 -0500 Subject: [PATCH 2/5] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f70e986..22d323f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ 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) +![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. From 584cf828d529fcb5ea88581f8027aa65de1145ec Mon Sep 17 00:00:00 2001 From: PolyMars <51007356+PolyMarsDev@users.noreply.github.com> Date: Fri, 12 Jun 2020 20:16:34 -0500 Subject: [PATCH 3/5] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 22d323f..c3db728 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ Sokobot is a Discord bot written with [JDA](https://github.com/DV8FromTheWorld/J ## 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 From 9347174aeb610a732abc07e2fd78c115795b5f9a Mon Sep 17 00:00:00 2001 From: PolyMars <51007356+PolyMarsDev@users.noreply.github.com> Date: Fri, 12 Jun 2020 20:19:22 -0500 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c3db728..1324243 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Thanks to the power of Java HashMaps™️, multiple users can use the bot at th - ``!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/PolMarsDev/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. +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. From cf5e579e9d024662225dd8ebc61a96a50762ed21 Mon Sep 17 00:00:00 2001 From: PolyMars <51007356+PolyMarsDev@users.noreply.github.com> Date: Fri, 12 Jun 2020 20:19:47 -0500 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1324243..54916a7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Thanks to the power of Java HashMaps™️, multiple users can use the bot at th - ``!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. +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.