Readme and changelog updates to prepare release

CHANGELOG.md

@@ -6,34 +6,34 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
-- Older versions of war3 are still popular so now you can install scripts to the older editions of warcraft from within this version.
+- Older versions of war3 are still popular so now you can install scripts to the older editions of warcraft.
+  - New features and fixes can be automatically available for older versions.
+  - AMAI version `REFORGED/RFG` is now for the latest warcraft version while `ROC` and `TFT` are for the classic versions of warcraft.
   - (DevTools) AI Versions now maintain there own copy of warcraft API's and generated blizzard.j files. This allows a single copy of AMAI to build previous versions of AMAI.
 - Installer will now check to make sure AMAI scripts are in the correct location instead of just continuing to appear to work.
 - New English taunts and messages created from generated AI.
-- Ability to perform expansions using items (jzy-chitong56)
+- Ability to expand using the tiny great hall (jzy-chitong56)
 - Heroes will attempt to avoid/swap specific items from their inventory or when they already have a specific skill (jzy-chitong56)
   - (DevTools) Can be modified via the ItemCheck.txt
 - New commander mode "Joint Control" which allows the human players to control their AI allies units at the same time as AMAI.
   - This is like the "Computers Only" option where all human players units and buildings are removed at the start of the game but you have direct control.
-- (DevTools) Debug mode will give observers more visibility into the AI's units and hero abilities. (jzy-chitong56)
 - Commander Change strategy dialog now displays the strategy name you can pick for the AI where applicable instead of just a number.
 - Zepplins can now make use of fountains of power (jzy-chitong56)
 - New Gargoyle and Ghouls Strategy for undead (jzy-chitong56)
 - Added ability to commander to control the zoom level when you type into the chat window '-zoom3000' without the quotes. (jzy-chitong56)
 - (Classic editions) Zoom level can be controlled by the UP and DOWN keys and observers start zoomed out due to no built in controls in classic versions.
-- Added opportunities to attempt extreme save behaviour when the AI is struggling e.g Do a militia expansion or ancient expansion (jzy-chitong56)
-- Some improvements to handle multiple mines at the same base  (jzy-chitong56)
+- Added emergency actions where AI is struggling to try and recover e.g Do a militia expansion or ancient expansion (jzy-chitong56)
 - Use the cloak of shadows ability in micro actions (jzy-chitong56)
 - Maps with multiple mines at the starting location can now be handled. (jzy-chitong56)
-- Some expansions when far away or impossible to get to will be attempted with a zeppelin. (jzy-chitong56)
+- Some expansions when far away or impossible to get to will be attempted with a zeppelin, but only if there are no creeps (jzy-chitong56)
+- (DevTools) Debug mode will give observers more visibility into the AI's units and hero abilities. (jzy-chitong56)
 
 ### Changed
-- Latest version install scripts are now called REFORGED/RFG instead of TFT.
+- Installer now includes the latest scripts so you do not have to build or copy the scripts in yourself.
 - Bat scripts to install to a single map have more power to control install of commander by passing argument 1 or 0 to the script. No argument provided will install commander by default.
   - No Commander `./InstallROCToMap.bat "E:\Files\Documents\Warcraft III\Maps\AMAI\frozenthrone\community\(24)BrokenCity.w3x" 0`
 - Install to directory power script must now be passed the version to install `InstallToDir.pl REFORGED dir true`
 - Chinese Translation improvements. (jzy-chitong56)
-- (DevTools) Updated MPQEditor to 4.0.0.894 (jzy-chitong56)
 - Language dialog will be available on game start even when the commander is disabled (jzy-chitong56)
 - Updates for latest war3 1.36 version (jzy-chitong56)
 - Hero Skill Adjustments
@@ -46,6 +46,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - To reduce chat spam for players, chat messages from the AI are now rate limited to reduce screen spam especially in large player maps.
 - Team games ai's that are defeated will no longer destroy its base or do a desperation attack and instead will share control with its human allies.
   - When there is no human allies and two AI shares the same race it will give its units to that AI.
+- (DevTools) Updated MPQEditor to 4.0.0.894 (jzy-chitong56)  
 
 ### Removed
 - (DevTools) Old non-working installer has now been removed now we have new version in place.
@@ -54,7 +55,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Spirit Walkers key building should be the Tauren Totem (Slayer95)
 - Fix Goblin Tinker not learning abilities after picking the engineering skill. (jzy-chitong56)
 - Fix VSAI more than 12 players support (jzy-chitong56)
-- Various memory leak and optimization fixes. (jzy-chitong56)
+- Various memory leak and optimization fixes to reduce lag on large maps (jzy-chitong56)
 - Various protection against division by 0 (jzy-chitong56)
 - Changing language more than once may not apply the english backup correctly. (jzy-chitong56)
 - More unicode fixes to languages (jzy-chitong56)

README.md

@@ -9,10 +9,8 @@ Official Release Links available from: https://www.hiveworkshop.com/threads/adva
 As was originally hosted on http://www.wc3campaigns.net/forumdisplay.php?f=601
 
 # Warcraft Requirements
-| AMAI Version    | War3 Support                   | Comments |
-| -----------|--------------------------------|---------------|
-| 3.3        | Min 1.36, Min 1.24 - 1.31 classic |  |
-| 2.5.4      | Min 1.24+ - Max 1.28 | Classic edition from 2008 |
+Min 1.36
+Min 1.24 - 1.31 for classic AMAI versions
 
 * Avoid v1.29 of Warcraft 3 as it breaks various things and prevents AMAI from chatting. This is just an issue with this version and you can downgrade or upgrade.
 
@@ -30,8 +28,6 @@ For Warcraft 1.30 onwards you need to use http://www.zezula.net/en/casc/main.htm
 ## AMAI installer
 - The installer has to be downloaded separately as its much larger compared to the AI package.
 - Unzip the contents of the installer to a folder of your choice.
-- After unzip, download the newest version of AMAI and unzip it in the folder `{your-amai-installer}/resources/AMAI`
-  - Minimum needed is the `Scripts` folder and `MPQEditor.exe` placed in the AMAI directory.
 - Double-click amai-electron-manager.exe to open the installer.
 - You can install to a single map or a whole directory.
 ![installer](installer.jpg)
@@ -66,33 +62,37 @@ Tested with strawbery perl 5.30 and Tk 804.034
 
 *You may need to run as an administrator if you have issues with maps not displaying any teams.
 
-## Build Requirements for Electron
+## Build Requirements for AMAI Installer (Via Electron)
 - node 14 or greater...
 - npm 6 or greater...
-- angular-cli 14 or greater...
+- angular-cli 16 or greater...
 
-## Running electron locally:
+### Running electron locally:
 - Go to the Electron folder inside the project and open the IDE of your choice.
 - first run `npm i` to install project dependencies
 - run `npm start` to open in development environment
 
-## Deploying the Electron Installer:
+### Deploying the Electron Installer:
 - run `npm run electron:build` inside Electron folder
+- You must have a built or downloaded copy of AMAI and unzip it in the folder `{your-amai-installer}/resources/AMAI`
+  - You only need to include the `Scripts` folder and `MPQEditor.exe` within the AMAI directory.
 - zip the contents of the release/win-unpacked folder and deploy this zipped file
 
 ### Notes about Electron Installer build process:
 - I'm working on doing the zip mentioned above in an automated way.
 - The build process creates the executable for the current operating system only. To create other executables, the process must be run on the corresponding operating system.
 - I will be working on the possibility of building the linux executable on windows.
 
-## Build Scripts
-- You need to use the various `make` bat files to create the AI scripts for various versions
+## Building Scripts
+- You need to use the various `make` bat files to create the AI scripts for various versions.
 - Run/double click *makeRFG.bat* to create the reforged scripts.
 - Then install like normal e.g from a command prompt type *InstallRFGToMap.bat "C:\mymap.w3m"* and press enter.
+- To use the installer you must copy the `Scripts` folder and `MPQEditor.exe` to the folder `{your-amai-installer}/resources/AMAI`
 - Run up a custom game and select the map to play.
 
 ## VS AI Build
-- This special version will make *odd* teams run with AMAI and *even* teams run with the standard blizzard AI.
+- This special version that must be built to use, will make *odd* teams run with AMAI and *even* teams run with the standard blizzard AI.
+- Useful for testing how much better AMAI is against the original AI.
 - Run/double click one of the `makeVAI` bat files e.g *makeVAITFT.bat* to create the AMAI vs AI scripts for the classic TFT version.
 - Then install like normal e.g from a command prompt type *InstallTFTToMap.bat "C:\mymap.w3m"* and press enter.