Merge remote-tracking branch 'dclamage/documentation'

Author: LocalIdentity

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+### Instructions to build a DLL
+1. Check out git to a new folder
+2. Open VS2019
+3. Choose the "Open a folder" option and choose the git checkout
+4. In the configurations dropdown, choose "Manage configurations..."
+5. Add a new x86-Release configuration and save the CMakeSettings.json file
+6. Choose this new x86-Release configuration in the configurations dropdown
+7. Go to Build->Build All and wait for the build to complete with no errors
+8. Find the new dll in out\build\x86-Release\SimpleGraphic.dll
+
+To use this DLL, simply copy it to your Path Of Building install location and restart Path Of Building

README.md

@@ -0,0 +1,31 @@
+# Path of Building Community SimpleGraphic.dll
+
+## Introduction
+
+SimpleGraphic.dll is the host environment for Lua. It contains the API used by the application's Lua logic, as well as a 2D OpenGL renderer, window management, input handling, and a debug console. It exports one symbol, RunLuaFileAsWin, which is passed a C-style argc/argv argument list, with the script path as argv[0].
+
+The Windows-specific code is contained in 5 files:
+- win\entry.cpp: Contains the DLL export. It just creates the system main module, and runs it.
+- engine\system\win\sys_main.cpp: The system main module; it initialises the application, and contains generic OS interface functions, such as input and clipboard handling.
+- engine\system\win\sys_console.cpp: Manages the debug console window that appears during the program's initialisation.
+- engine\system\win\sys_video.cpp: Creates and manages the main program window.
+- engine\system\win\sys_opengl.cpp: Initialises OpenGL.
+
+## Building
+
+SimpleGraphic.dll is currently built using Visual Studio 2019.
+
+The dll depends on a number of 3rd party libraries. Details and instructions for how to obtain them are in DEPENDENCIES.md.
+
+Once the libraries are obtained, follow these instructions to build the DLL:
+1) Open SimpleGraphic.sln in Visual Studio 2019
+2) Choose the `Release|x86` configuration.
+3) Build the solution
+4) The resulting `SimpleGraphic.dll` can be found in the `Release` directory.
+5) Copy `SimpleGraphic.dll` to the Path of Building install directory, replacing the existing file.
+
+## Debugging
+
+Since SimpleGraphic.dll is dynamically loaded by `PathOfBuilding.exe`, to debug it, run `PathOfBuilding.exe` and then attach to that process using the `Debug->Attach to Process...` menu option in Visual Studio.
+
+If debugging of the initialization is desired, then adding a MessageBox or some other pause at the start will give you time to attach and continue.