Add user installation information

docs/CONTRIBUTING.md

@@ -1,10 +1,11 @@
 ## Contributing
 
-If you find something you'd like to fix that's obviously broken, create a branch, commit your code, and submit a pull request. If it's a new or missing feature you'd like to see, add an issue, and be descriptive!
+If you find something you'd like to fix that's obviously broken, create a branch, commit your code, and submit a pull request.
+If it's a new or missing feature you'd like to see, add an issue, and be descriptive!
 
 If you'd like to help out and are not quite sure how, you can look through any open issues and tasks, or ask for tasks on our discord server.
 
 **As of Oct. 26, 2020 we will no longer be accepting pull requests that introduce lint errors.**
 
-We use `golangci-lint` to catch lint errors, and we require all contributors to install and use
-it. Installation instructions can be found [here](https://golangci-lint.run/usage/install/).
+We use `golangci-lint` to catch lint errors, and we require all contributors to install and use it.
+Installation instructions can be found [here](https://golangci-lint.run/usage/install/).

docs/development.md

@@ -7,5 +7,9 @@ The following extensions are recommended for working with this project:
 
 When you open the workspace for the first time, Visual Studio Code will automatically suggest these extensions for installation.
 
-Alternatively you can get to it by going to settings <kbd>Ctrl+,</kbd>, expanding `Extensions` and selecting `Go configuration`,
-then clicking on `Edit in settings.json`. Just paste that section where appropriate.
+Alternatively you can get to it by going to settings <kbd>Ctrl+,</kbd>, expanding `Extensions` and selecting `Go configuration`, then clicking on `Edit in settings.json`.
+Just paste that section where appropriate.
+
+We use `golangci-lint` to catch lint errors, and we require all contributors to install and use it.
+As of Oct. 26, 2020 we will no longer be accepting pull requests that introduce lint errors.
+Installation instructions can be found [here](https://golangci-lint.run/usage/install/).

docs/install.md

@@ -0,0 +1,53 @@
+# Install OpenDiablo2
+
+We currently provide binaries only for [Patreon supporters](https://www.patreon.com/bePatron?u=37261055) to [download and auto-update](https://www.patreon.com/posts/thanks-for-38407582).
+If you are not one of those, you need to follow the developer documentation for building the project using Go.
+
+Once you have an executable/binary of OpenDiablo2 (either provided via Patreon or building your own), then just launch it.
+
+### Error? It's expected!
+
+In case there is an error, it's most likely related to MPQ files.
+You need to modify `config.json`.
+
+Run the binary once; it should let your know where the location of this file is.
+For example:
+
+![Error is expected](./expectederror.png)
+
+In this specific case (MacOS) the file is located at: `~/Library/Application\ Support/OpenDiablo2/config.json`
+
+Make sure the file looks like this:
+
+```json
+{
+  "MpqLoadOrder": [
+    "patch_d2.mpq",
+    "d2exp.mpq",
+    "d2xmusic.mpq",
+    "d2xtalk.mpq",
+    "d2xvideo.mpq",
+    "d2data.mpq",
+    "d2char.mpq",
+    "d2music.mpq",
+    "d2sfx.mpq",
+    "d2video.mpq",
+    "d2speech.mpq"
+  ],
+  "MpqPath": "/Applications/Diablo II/",
+  "TicksPerSecond": -1,
+  "FpsCap": 0,
+  "SfxVolume": 1,
+  "BgmVolume": 0.3,
+  "FullScreen": false,
+  "RunInBackground": true,
+  "VsyncEnabled": true,
+  "Backend": "Ebiten"
+}
+```
+
+Pay attention to the `MpqPath` directory (you can also change this to whatever location your like).
+Now copy-and-paste the MPQ files from you Windows PC into that directory.
+Make sure the filenames are matching the ones from `config.json`,
+
+Now, launch OpenDiablo2 again and this time it should work!

docs/mpq.md

@@ -0,0 +1,8 @@
+# Locate MPQ files
+
+The MPQ files should be present at your Diablo II installation directory.
+The default directory is `C:\Program FIles(x86)\Diablo II`
+
+![MPQ Directory](./mpqdir.png)
+
+Once again make sure the you have the `1.14b` version of the game.

docs/play.md

@@ -1,5 +1,5 @@
 ## Configuration
 
-The engine is configured via the `config.json` file. By default, the configuration assumes that you have installed Diablo 2 and the
-expansion via the official Blizzard Diablo 2 installers using the default file paths. If you are not on Windows, or have installed
-the game in a different location, the base path may have to be adjusted.
+The engine is configured via the `config.json` file. 
+By default, the configuration assumes that you have installed Diablo 2 and the expansion via the official Blizzard Diablo 2 installers using the default file paths.
+If you are not on Windows, or have installed the game in a different location, the base path may have to be adjusted.

docs/profiling.md

@@ -1,7 +1,7 @@
 ## Profiling
 
 There are many profiler options to debug performance issues.
-These can be enabled by suppling the following command-line option and are saved in the `pprof` directory:
+These can be enabled by supplying the following command-line option and are saved in the `pprof` directory:
 
 `go run . --profile=cpu`
 
@@ -11,6 +11,6 @@ Available profilers:\
 You can export the profiler output with the following command:\
 `go tool pprof --pdf ./OpenDiablo2 pprof/profiler.pprof > file.pdf`
 
-Ingame you can create a heap dump by pressing `~` and typing `dumpheap`. A heap.pprof is written to the `pprof` directory.
+In game you can create a heap dump by pressing `~` and typing `dumpheap`. A heap.pprof is written to the `pprof` directory.
 
 You may need to install [Graphviz](http://www.graphviz.org/download/) in order to convert the profiler output.

docs/purchase.md

@@ -0,0 +1,46 @@
+# Purchase the official game
+
+1. Buy [Diablo II (2000)](https://eu.shop.battle.net/en-gb/product/diablo-ii).
+
+![Buy Diablo](./buydiablo.png)
+
+2. Write down your CD-Key and start downloading the game.
+
+![Get your CD-Key](./cdkey.png)
+
+3. The Blizzard Downloader works only with Windows. Find a Windows PC and download the game.
+
+![Download Diablo 2](./download.png)
+
+4. Save the installer setup executable somewhere temporarily in your disk (e.g. `C:/Diablo II`) and wait until the download is complete.
+
+![Wait](./wait.png)
+
+5. When the download is finished the setup will automatically start Diablo II Installer.
+
+![Install Diablo II](./installer.png)
+
+6. Begin the installation! Right after accepting the license, it will ask you to insert a name and copy-paste your CD-Key (from step 2).
+   In case you forgot to save it, there should be already an e-mail at your inbox about it.
+
+![Paste your CD-Key](./cdkey2.png)
+
+7. Select a directory to install the game. 
+   Ideally, use the default location: `C:\Program FIles(x86)\Diablo II`.
+   
+![Select installation directory](./installpath.png)
+
+8. Run the game.
+   If you are using `Windows 10` you will get a message prompt saying `Run the program without getting help`.
+   Next, click `Don't show this message again` to avoid future noise.
+   
+9. After the game launches make sure the version is **1.14b**.
+
+
+### Repeat the exact process for Diablo II: Lord of Destruction
+
+11. Buy [Diablo II: Lord of Destruction (2001)](https://eu.shop.battle.net/en-gb/product/diablo-ii-lord-of-destruction).
+
+![Buy Lord of Destruction](./lod.png)
+
+12. Repeat the steps **from 2 to 9** for Diablo II: Lord of Destruction.

docs/roadmap.md

@@ -1,4 +1,3 @@
 ## Roadmap
 
-There is an in-progress [project roadmap](https://docs.google.com/document/d/156sWiuk-XBfomVxZ3MD-ijxnwM1X66KTHo2AcWIy8bE/edit?usp=sharing),
-which will be updated over time with new requirements.
+There is an in-progress [project roadmap](https://docs.google.com/document/d/156sWiuk-XBfomVxZ3MD-ijxnwM1X66KTHo2AcWIy8bE/edit?usp=sharing), which will be updated over time with new requirements.

docs/status.md

@@ -2,7 +2,7 @@
 
 We are currently working on features necessary to play Diablo 2 in its entirety. After this is completed, we will work on expanding the project to include tools and plugin support for modding, as well as writing completely new games with the engine.
 
-At the moment (march 2021) the game starts, you can select any character and run around Act1 town.
+At the moment (March 2021) the game starts, you can select any character and run around Act1 town.
 You can also open any of the game's panels.
 
 Much work has been made in the background, but a lot of work still has to be done for the game to be playable.