witpqs -> RE: Introducing Intel Monkey (New Version: 0.4.0) (9/22/2012 2:06:06 AM)
There is a new version of Intel Monkey ready to use.
Here is the link, which I've also updated in my signature (I'm not sure how long that takes to update).
This version is 0.4.0, and includes the first cut of Combat Report functionality. For those of you upgrading from a previous version, read the bit below about running the included utility to generate a Bases.txt file for the scenario you are playing. It only takes a few seconds and is very easy for non-technical players to do.
Here is the documentation text:
Intel Monkey V0.4.0
Intel Monkey is a program for WITP-AE players to help facilitate digesting Intel provided in the various reports (SigInt, Combat, Operations, Events).
Intel Monkey is written in Python, beginning with Python version 3.2.3 and requires that version of Python or higher be installed in order to run Intel Monkey. It is technically independent of the Windows operating system, but as AE is a windows only program I doubt that Intel Monkey will be used on either Linux or Mac OS.
The program reads in the player's report files that AE archives every turn. Those files are located in "save/archive" (in AE's main folder find folder "save", inside that folder find folder "archive").
Your AE shortcut must have the "-archive" switch for AE to create those files every turn.
Requirement: Python version 3.2.3 or above. You may obtain this at
Sources: python.org (free and open source, and where I obtained it)
At the moment this is current version:
This is also free and a highly regarded distribution.
Install Python per the instructions. Also, although the instructions do not say so, on my system I had to reboot after installation so that the system's path was properly updated to run Python.
Intel Monkey currently consists of three program files (.py) and this documentation file. There are two copies of the main Intel Monkey program, and also a utility program called "GetBasesFromScenario.py" that you will need to get started. In addition, the .zip or .7z will also include "witploadAE.exe" and its documentation file.
- In your main WITP-AE folder there is a folder call "tools". Navigate into that folder. That is the place where tools like Staff Assistant and Tracker are typically installed, and is a good place for Intel Monkey.
- Create a folder there called "Intel Monkey".
- Navigate into the "Intel Monkey" folder that you just created.
- Copy the Intel Monkey files (and witploadAE) into the "Intel Monkey" folder. If they are in a .zip or .7z file then you might need to "Extract Files Here" as needed.
Intel Monkey is now installed, and you now need to create a "Bases.txt" file for the scenario you are playing. Run the program "GetBasesFromScenario.py" (by double-clicking on it). Then just tell it where your AE scenario folder is, (usually called "SCEN" under the main AE folder) where you Intel Monkey is (that will already be the default), and the 3-digit scenario number that you are playing. Press the 'Proceed' button and within a few seconds it will create the Bases.txt file you need.
The two .py files you see are identical except one (-A) is configured to read in the Allied reports and the other (-J) is configured to read in the Japanese reports. The easiest way to proceed is to create a shortcut to the version you plan to use, and put the shortcut with your other AE shortcuts. Note: Because the combat report functionality can provide information about both sides, you might want to use both 'your' Intel Monkey and the 'enemy' version so you can review what information the other side has been getting from the combat reports.
To create a shortcut just Right-click on the correct Intel Monkey version (-A or -J) and select "Create shortcut" from the menu. A shortcut will be created right there in the Intel Monkey folder. You can then move that shortcut to anyplace you wish. You can even rename it if you like.
Intel Monkey will also work with multiple AE installs, just like Tracker and other utilities. Simple install it once for each instance of AE.
Current State and Use Instructions:
The program reads files from AE's "save/archive" folder. Make certain you play AE with the "-archive" switch or else those files will not be created and there will be nothing to read.
Intel Monkey is still very new and has a very small set of functions compared to what is intended. Currently Intel Monkey processes all of the player's SigInt files and combat report files. Future versions will process other files as well.
- When started, Intel Monkey will display a small top level window with options for the various reports. Currently there are the Basic SigInt and Basic Combat Report functions implemented.
- When you click on the Basic SigInt button, Intel Monkey will take several seconds to read in all the SigInt files.
- A GUI window will open, where the information is displayed.
- Each line from each SigInt file has been made into its own record with the date at the front, and parsed into fields containing the various information. Note that some of the line come with four pieces of information (including the date) while others come with six (including the date).
- Buttons in the lower left corner allow the report to be sorted according to the criteria noted next to each button.
- You can click in the "Enter Search Text" box and type in something to search for. The first occurrence from the top (in the currently selected sort order) will be found and positioned at the top of the screen (unless too near the bottom of the report). The search is case insensitive (upper/lower case does not matter).
- The report can be scrolled using the scroll bars, or just click inside it to use the keyboard (PageUp, PageDown, etc.) or the mouse wheel if your mouse has one.
- You can select text in the report and copy it a) to some other program or text editor (useful if you are making notes for yourself), or b) into the search text entry area (useful to search for something you see now that causes you to want to change the sort order and look at all similar things).
- When finished, click on either the Exit button or the X in the upper right-hand corner to close the report you are viewing. When you do that to the top windown, Intel Monkey will close.
- The Basic Combat report displays very similarly to the SigInt report. There are some differences. First, the Combat Report takes longer to process than does the SigInt report. Second, The Combat Report has multiple options. Currently implemented are the options for Ship information and LCU information. Battle, Troop, and Aircraft information functions are not yet implemented.
- Note Well: While I believe that all ship location information is captured from the combat reports, the same is not true for LCU location information. Presently only Ground Combat locations for LCUs is captured. LCU locations revealed during combat reports of battle types of naval bombardment, air attacks, amphibious landings, and so on are not yet captured. Doing so is not straighforward because the combat report does not always provide clues as to which side the LCUs belong to. I look forward to increasing the amount of information captured with future versions.
There are many additional functions planned for Intel Monkey, including reading in and processing the other reports. The present functions are very useful already as they allow a player to see SigInt reports for a specific base, or all reports for a specific enemy unit, and so on.