Release 1, update Readme

README.md

@@ -1,9 +1,69 @@
-# Scrap Mechanic Mapper
-
-A little tool which opens a Map-Window and is able to read the player position from Scrap Mechanics memory.
-
-All you need to know is are the memory addresses of the X and Z position. You can use CheatEngine for that. (Eventually this program may be able to find them for you without an external tool).
-
-Good with multi-monitors.
-
-*Still Work-In-Progress
+# Scrap Mechanic Mapper
+
+Tool to create 2D maps for Scrap Mechanic Survival.
+
+If you played a bit you probably got lost every now and then, and eventually noticed, that you find back home anyway. You gonna drive loooong rides to notice oh this was some until you see same places and even detect shortcuts. 
+You may notice that everything is/feels grid like and that there are repetitive tiles. You may wonder how your world actually looks like...
+
+But you now want a to see the big image - use this tool!
+
+This tool draws lines for you, wherever your player walks, there is a preset of colors, which you can use for different types of things in the world.
+But is this cheating or just enhanced locational awareness? The tool does not do the work for you, every line must be 'walked/driven in' by you.
+
+You need CheatEngine to get the player position's memory addresses, see instructions below.
+
+* Good with multi-monitors.
+* Good with an in game built scooter. For exploration.
+
+---
+
+This is how the actual tool looks like: (You can see my current world I am playing on)
+![This is how it looks like.](https://user-images.githubusercontent.com/18501527/84353825-1efa1d80-abc0-11ea-9ef3-3e41c34c1c75.png)
+
+### Usage:
+
+Install: Grab the latest [release](https://github.com/Ecconia/ScrapMechanicMapper/releases) (if any), or compile it yourself using e.g. IntelliJ or Maven (`mvn package`).
+
+Launch: You now have the .jar file, launch it `java -jar <filename>` to see your stored map (`save.txt` same folder as jar).
+ If your system supports it, just double-click the jar.
+
+Pre-requirements: You will need `CheatEngine` to know where your player-position is stored!!
+
+CheatEngine usage:
+- Select ScrapMechanic as the current program (button top left).
+- Start a new scan looking for `float` values.
+- You may filter that new scan from `-100000` to `100000` the beginner area (negative quadrant) of the island can be filtered with `-100000` to `-10`. But beware, that its an island you are walking on and it has the center at `0, 0`.
+- Walk with your player and scan for `changed values`. (Always walk diagonal, the world has a grid, place a block to see it).
+- Stand still with your player or just look around and scan for `unchanged values`.
+- Repeat the last two steps until you have roughly 120 or better under 100 memory addresses.
+- You will see the same two values over and over again, pick the one where you have at least 10 occurrences. Double-click a pair to have it highlighted by CheatEngine.
+- Copy the address into this tool, the higher address of a pair goes into the first filed (sry for this step). Please confirm somehow that a drawn slope matches your movement, else swap the two addresses.
+- Press `Done` and your position is now live transmitted.
+- Hint: Once you die in game with all the filter steps above done, Only about 10 addresses will be valid! Switch to them then! You may want to keep CheatEngine open while playing, in case that you die. But once died, you have more persistent memory addresses.
+
+Tool usage:
+- All fields and buttons have Tooltips (hover with mouse over them), use it.
+- The tool has a canvas (center) and a toolbar.
+- The canvas draws the map, you can zoom it and move it around. The `Center` button moves it back to player position.
+- The `Addr` button switches to the address-toolbar, the `Done` button switches back to the normal-toolbar.
+- Press the `+` and then on the map, to add a waypoint. It will ask you for a label, only `Ok/Enter` will place it.
+- By default, it doesn't draw lines, you have to select a color for that, if you don't want it to draw press `Off`.
+
+### TODOs
+
+Usability:
+- DON'T LET APPLICATION CRASH IF SCRAP MECHANIC IS NOT RUNNING (on attempt of entering addresses, not on launch).
+- Allow viewing, deleting and moving of all line-end-points also decoupling and merging them.
+- Allow changing color of path/line.
+- Allow selecting moving deleting renaming of waypoints.
+- Add different icons to waypoints (in general add icons and not circles).
+- Add another color for cliffs.
+- May somehow add biome areas (honestly no clue of how to yet).
+- Allow adding points and lines from/with the GUI.
+- Add guided memory-scanner to not rely on cheat engine.
+- Add world/file chooser, current default is `save.txt`.
+
+Technical:
+- Create a path instead of many lines (in memory at least).
+- Improve the file structure, something binary is quite possible.
+- Add clipping and bounds in the render routine.

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>de.ecconia.scrapmechanicmapper</groupId>
 	<artifactId>ScrapMechanicMapper</artifactId>
-	<version>0-WIP</version>
+	<version>1</version>
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>