Merge pull request #342 from ME3Tweaks/Beta

Stable update: 6.1 -> 6.2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -16,6 +16,8 @@ A clear and concise description of what the bug is.
 **To Reproduce**
 Be specific. Reports must include tool names, filenames, export numbers and more so that we can reproduce the issue. **Do not use generic "use any file" or "any tool". Be specific. If specific reproducible steps are not included, we may simply close the issue as not reproducible.**
 
+When giving a file name, please specify which game it's from (ME1/ME2/ME3/LE1/LE2/LE3), and whether it's in the base game or in a DLC.
+
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'

.gitignore

@@ -222,3 +222,7 @@ Release_x64/
 /LegendaryExplorer/.idea
 /LegendaryExplorer/.editorconfig
 /LegendaryExplorer/global.json
+
+# Ignore Doxygen working folder and Doxygen output
+/Documentation/Output
+/Documentation/Doxygen

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "LegendaryExplorer/submodules/WwiseTools"]
+	path = LegendaryExplorer/submodules/WwiseTools
+	url = https://github.com/ME3Tweaks/WwiseTools.git

Documentation/DoxygenConfigManual

@@ -0,0 +1,23 @@
+# Doxyfile 1.9.2
+
+# Use this Doxygen configuration file to build documentation manually. 
+# This configuration will use all values from the AzurePipelines file, and override it with anything defined here
+# Run Doxygen from the folder containing this file to build it correctly
+
+@INCLUDE               = DoxygenConfigAzurePipelines
+
+PROJECT_NUMBER         = 6.1
+OUTPUT_DIRECTORY       = .\Output
+INPUT                  = ..\LegendaryExplorer\LegendaryExplorerCore
+
+# This file needs to be in the INPUT folder (LegendaryExplorer\LegendaryExplorerCore project folder) - Relative paths don't seem to work
+USE_MDFILE_AS_MAINPAGE = documentation_homepage.md
+
+HTML_HEADER            = header.html
+HTML_FOOTER            = footer.html
+HTML_EXTRA_STYLESHEET  = doxygen-awesome.css
+HTML_EXTRA_FILES       = doxygen-awesome-darkmode-toggle.js
+
+# Uncomment the following line to include the entire source code as part of the documentation. Docs will be around 100mb with this enabled. 
+# Seems like we should include it for stable releases so we have an accessible reference of what the state of the code was.
+# SOURCE_BROWSER         = YES

Documentation/doxygen-awesome-darkmode-toggle.js

@@ -0,0 +1,108 @@
+/**
+Doxygen Awesome
+https://github.com/jothepro/doxygen-awesome-css
+MIT License
+Copyright (c) 2021 jothepro
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+class DoxygenAwesomeDarkModeToggle extends HTMLElement {
+    static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode"
+    static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode"
+
+    static _staticConstructor = function() {
+        DoxygenAwesomeDarkModeToggle.darkModeEnabled = DoxygenAwesomeDarkModeToggle.userPreference
+        DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
+        // Update the color scheme when the browsers preference changes
+        // without user interaction on the website.
+        window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
+            DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
+        })
+        // Update the color scheme when the tab is made visible again.
+        // It is possible that the appearance was changed in another tab 
+        // while this tab was in the background.
+        document.addEventListener("visibilitychange", visibilityState => {
+            if (document.visibilityState === 'visible') {
+                DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
+            }
+        });
+    }()
+
+    constructor() {
+        super();
+        this.onclick=this.toggleDarkMode
+    }
+
+    /**
+     * @returns `true` for dark-mode, `false` for light-mode system preference
+     */
+    static get systemPreference() {
+        return window.matchMedia('(prefers-color-scheme: dark)').matches
+    }
+
+    /**
+     * @returns `true` for dark-mode, `false` for light-mode user preference
+     */
+    static get userPreference() {
+        return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) || 
+        (DoxygenAwesomeDarkModeToggle.systemPreference && !localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey))
+    }
+
+    static set userPreference(userPreference) {
+        DoxygenAwesomeDarkModeToggle.darkModeEnabled = userPreference
+        if(!userPreference) {
+            if(DoxygenAwesomeDarkModeToggle.systemPreference) {
+                localStorage.setItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey, true)
+            } else {
+                localStorage.removeItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)
+            }
+        } else {
+            if(!DoxygenAwesomeDarkModeToggle.systemPreference) {
+                localStorage.setItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey, true)
+            } else {
+                localStorage.removeItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey)
+            }
+        }
+        DoxygenAwesomeDarkModeToggle.onUserPreferenceChanged()
+    }
+
+    static enableDarkMode(enable) {
+        let head = document.getElementsByTagName('head')[0]
+        if(enable) {
+            document.documentElement.classList.add("dark-mode")
+            document.documentElement.classList.remove("light-mode")
+        } else {
+            document.documentElement.classList.remove("dark-mode")
+            document.documentElement.classList.add("light-mode")
+        }
+    }
+
+    static onSystemPreferenceChanged() {
+        DoxygenAwesomeDarkModeToggle.darkModeEnabled = DoxygenAwesomeDarkModeToggle.userPreference
+        DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
+    }
+
+    static onUserPreferenceChanged() {
+        DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
+    }
+
+    toggleDarkMode() {
+        DoxygenAwesomeDarkModeToggle.userPreference = !DoxygenAwesomeDarkModeToggle.userPreference
+    }
+}
+
+customElements.define("doxygen-awesome-dark-mode-toggle", DoxygenAwesomeDarkModeToggle);