From fc48875b879e2b7a815c908167aeb6c6afc2d40a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20Gr=C3=BCnwald?= Date: Thu, 28 Jan 2021 16:06:26 +0100 Subject: [PATCH] Add Readme and License --- LICENSE | 21 +++++++++++++++++++++ README.MD | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 LICENSE create mode 100644 README.MD diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8805abe --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Mike Lankamp and Alamo Engine Tools + +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. diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..1605510 --- /dev/null +++ b/README.MD @@ -0,0 +1,34 @@ +# Empire at War ModCheck + +The ModCheck tool for Empire at War and Forces of Corruption allows mod makers +to check their mods for errors, like missing text entries, references or corrupted +models or map files. + +The tool was originally developed by Mike Lankamp and is currently maintined by +the contributers to the Alamo Engine Tools GitHub organisation. + + +## Prerequisites + +- Operating System: Windows 7 or newer +- A functional installation of Star Wars: Empire at War and Star Wars: Empire at War: Forces of Corruption + +## Usage + +1. Place the binary next to the mod's data folder. +2. Run `./ModCheck.exe` with one of the following arguments from a command line: + `/FOC` for Forces of Corruption mods + `/EAW` for base game mods +3. Optionally add `>mod_check.log 2>&1` to write the report to a file (e.g. `./ModCheck.exe /FOC >mod_check.log 2>&1`) + +## Changelog + +- **2021-01-28 - Release 1.0.1: Legacy Release** + - **Fixes** + - Updated to the latest Visual Studio 2019 and fixes any compiler errors. + - Updates the support for sub-directory resolving. + - **Further Notes** + - The tool is released _as is_. It builds under current Windows versions and can be used to validate the legacy + versions of Empire at War and Forces of Corruption (Disc, gog.com, Origin). + - The Legacy release is _not_ officially supported. + - Any changes to the legacy release will have to be community driven.