Docs

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Truman Kilen
+
+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.

README.md

@@ -0,0 +1,30 @@
+# drg-mod-integration
+3rd party mod integration tool to download and integrate mods completely
+externally of the game. This enables more stable mod usages as well as offline
+mod usages.
+
+```
+$ ./drg_mod_integration integrate --help
+Command line integration tool
+
+Usage: drg_mod_integration integrate [OPTIONS]
+
+Options:
+  -d, --drg <DRG>
+          Path to the "Deep Rock Galactic" installation directory. Only necessary if it cannot be found automatically
+
+  -u, --update
+          Update mods. By default all mods and metadata are cached offline so this is necessary to check for updates
+
+  -m, --mods [<MODS>...]
+          Paths of mods to integrate
+
+          Can be a file path or URL to a .pak or .zip file or a URL to a mod on https://mod.io/g/drg
+          Examples:
+              ./local/path/test-mod.pak
+              https://mod.io/g/drg/m/custom-difficulty
+              https://example.org/some-online-mod-repository/public-mod.zip
+
+  -h, --help
+          Print help (see a summary with '-h')
+```