Merge pull request #35 from tiemonl/feature/GH-34_repo_cleanup

Repo cleanup
tiemonl · Sep 3, 2019 · b6d8bab · b6d8bab
2 parents 26f395a + ba4e3bd
commit b6d8bab
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ Table of Contents
 * [Introduction](#introduction)
 * [How to use](#how-to-use)
   * [Windows](#windows)
+  * [Mac/Linux](#maclinux)
 * [Upcoming feature(s)](#upcoming-features)
 * [Feature request or bug report](#feature-request-or-bug-report)
 * [Donation](#Donation)
@@ -26,18 +27,16 @@ Pull requests are ***welcomed*** and ***encouraged***!
 
 ## How to use
 ### Windows
-The windows program features a GUI and more setup available. It is compatible with both Steam and Kongregate. For more information please view the [README in the csharp section.](csharp/README.md)
+The windows program features a GUI and more setup available. It is compatible with both Steam and Kongregate. For more information please view the [README in the csharp section.](./csharp)
 
 ### Mac/Linux
-This version relies on Java. Please make sure you have java downloaded on your machine. It is a CLI only tool currently. Download [bh-fisher.jar]((https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/releases) from the releases tab.
-
-To use it please make sure you are on the fishing start screen where your rod and bait are displayed. Then open up a terminal and `cd` to the directory in which bh-fisher.jar resides. To run the program use the command `java -jar bh-fisher.jar <bait>` where <bait> is replaced by the amount of bait you would like to use up.
+This version relies on Java. Please make sure you have java downloaded on your machine. It is a CLI only tool currently. Download [bh-fisher.jar](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/releases) from the releases tab. For more information please view the [README in the java section.](./java)
 
 This version is still in beta. If you come across any issues, please submit an [issue](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/issues) and be as detailed as possible. I will add another README in the java directory with more details on how to run the program.
 
 
 ## Upcoming feature(s)
-- Stop fishing after you catch a certain weight of fish to save bait for another event. i.e. Stop fishing if you catch a fish above 12 kg. (currently not working on this project, I may go back to finishing this in the summer when I have more time)
+- None currently
 
 ## Feature request or bug report
 To request a feature or report a bug, open up an [issue](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/issues) in GitHub.

diff --git a/csharp/README.md b/csharp/README.md
@@ -1,4 +1,4 @@
-# Bit Heroes Fishing Bot
+# Bit Heroes Fishing Bot -- Windows
 
 [![GitHub issues](https://img.shields.io/github/issues/tiemonl/Bit-Heroes-Fishing-Bot.svg)](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/issues)
 [![Github All Releases](https://img.shields.io/github/downloads/tiemonl/Bit-Heroes-Fishing-Bot/total.svg)](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/releases)
@@ -10,23 +10,14 @@ https://brianmacdonald.github.io/Ethonate/address#0xaD3c539d7bb5e3ce993ca87DEA85
 
 Table of Contents
 =================
-* [Introduction](#introduction)
 * [How to use](#how-to-use)
     * [First Steps](#first-steps)
 	* [Getting started with the program](#getting-started-with-the-program)
 	* [Setting up the program](#setting-up-the-program)
 	* [Fishing](#fishing)
-* [Upcoming feature(s)](#upcoming-features)
 * [Feature request or bug report](#feature-request-or-bug-report)
 * [Donation](#Donation)
 
-
-## Introduction
-
-This program allows you to automatically fish for a set amount of bait. Just pick the amount of bait you want to use and press start and let the bot fish for you. This program is not 100%, however, it will always be better than a human. I do not guarantee a 100% catch rate, but I do guarantee a very high catch rate for very little effort.
-
-Pull requests are ***welcomed*** and ***encouraged***!
-
 ## How to use
 ### First steps
 - To make sure this program runs correctly, a few setting settings need to be checked.
@@ -44,7 +35,7 @@ Pull requests are ***welcomed*** and ***encouraged***!
 ![Fisher GUI](https://i.imgur.com/cajbZ65.png)
 
 ### Setting up the program
-- Select Kongregate or Steam depending on which platform you are fishing in
+- Select Kongregate, Kartridge, or Steam depending on which platform you are fishing in
     - If you are using steam, make sure to set the window size to 800x600
 - Then select the rod you are using to fish
 - Enter the amount of bait you want to go through
@@ -57,10 +48,6 @@ Pull requests are ***welcomed*** and ***encouraged***!
 - Press Auto mode and let the program fish for you.
     - If you need to cancel Auto Mode for whatever reason, press cancel and the program will finish catching the current fish, before stopping.
 
-
-## Upcoming feature(s)
-- Stop fishing after you catch a certain weight of fish to save bait for another event. i.e. Stop fishing if you catch a fish above 12 kg. (currently not working on this project, I may go back to finishing this in the summer when I have more time)
-
 ## Feature request or bug report
 To request a feature or report a bug, open up an [issue](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/issues) in GitHub.
 
@@ -70,7 +57,3 @@ If this program as helped you save time fishing, please consider donating:
 https://brianmacdonald.github.io/Ethonate/svg/eth-donate-blue.svg)](
 https://brianmacdonald.github.io/Ethonate/address#0xaD3c539d7bb5e3ce993ca87DEA851B308326511a)
 [![Donate Paypal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9F2F5CFVSHK8G)
-
-<!--stackedit_data:
-eyJoaXN0b3J5IjpbLTIxNTU4NDM0NywxNTIwMTAxMzgzXX0=
--->
diff --git a/java/README.md b/java/README.md
@@ -0,0 +1,42 @@
+# Bit Heroes Fishing Bot -- Unix
+
+[![GitHub issues](https://img.shields.io/github/issues/tiemonl/Bit-Heroes-Fishing-Bot.svg)](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/issues)
+[![Github All Releases](https://img.shields.io/github/downloads/tiemonl/Bit-Heroes-Fishing-Bot/total.svg)](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/releases)
+[![Donate Paypal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9F2F5CFVSHK8G)
+[![Donate Ethereum](
+https://brianmacdonald.github.io/Ethonate/svg/eth-donate-blue.svg)](
+https://brianmacdonald.github.io/Ethonate/address#0xaD3c539d7bb5e3ce993ca87DEA851B308326511a)
+
+
+Table of Contents
+=================
+* [How to use](#how-to-use)
+  * [First Steps](#first-steps)
+  * [Setting up the game](#setting-up-the-game)
+  * [Fishing](#fishing)
+* [Feature request or bug report](#feature-request-or-bug-report)
+* [Donation](#Donation)
+
+## How to use
+### First steps
+- To make sure this program runs correctly, a few setting settings need to be checked.
+  - Make sure you have java installed by running `java -version` in the terminal.
+  - Download bh-fisher.jar from the [releases](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/releases) tab in GitHub.
+  - `cd` to the directory in which the file was downloaded. i.e. `cd ~/Downloads/`
+
+### Setting up the game
+- Navigate to the fishing starting screen on your ***primary*** monitor:
+![Calibration screen](https://i.imgur.com/8mJ0T4o.png)
+
+### Fishing
+- To start fishing use the command `java -jar bh-fisher.jar <bait>` and replace `<bait>` with the amount of bait you wish to use. i.e. `java -jar bh-fisher.jar 120`
+
+## Feature request or bug report
+To request a feature or report a bug, open up an [issue](https://github.com/tiemonl/Bit-Heroes-Fishing-Bot/issues) in GitHub.
+
+## Donation
+If this program as helped you save time fishing, please consider donating:
+[![Donate Ethereum](
+https://brianmacdonald.github.io/Ethonate/svg/eth-donate-blue.svg)](
+https://brianmacdonald.github.io/Ethonate/address#0xaD3c539d7bb5e3ce993ca87DEA851B308326511a)
+[![Donate Paypal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9F2F5CFVSHK8G)
diff --git a/java/bh-fisher/src/dev/garlicbread/Main.java b/java/bh-fisher/src/dev/garlicbread/Main.java
@@ -73,13 +73,13 @@ public static Point FindColor(Color c, BufferedImage screen) {
 				int screenRGB = screen.getRGB(x, y);
 				Color color = new Color(screenRGB);
 				if (c.equals(color)) {
-					System.out.println("found color!");
+					logger.log(Level.INFO, "Found starting button.");
 					helper.moveCursor(new Point(x - 60, y));
 					helper.mouseClick();
 					return new Point(x + 30, y);
 				}
 			}
-		System.out.println("did not find start button");
+		logger.log(Level.SEVERE, "Start button not found. Exit code 1");
 		return null;
 	}