FOR PLAYERS: DOWNLOAD LATEST SCENARIO PACK HERE (v1.55b2)
FOR SCENARIO AUTHORS: DOWNLOAD LATEST RELEASE HERE (v1.55b2)
If you're a scenario author or player looking to convert a new or existing scenario for multiplayer use, you only need to download either the latest release or scenario pack using the links above.
This code repository is intended only for those who are curious about how IKE works internally, want to add more features, or want to localize the text for a language other than English. In other words, if you just want to create a PBEM scenario, you can just download the latest release and skip everything below.
If you're interested in localizing text: you don't have to build the system. You can just clone the English localization source CSV, translate the text into your language, and submit the changes by forking the repo and making a pull request, or else by creating a new Issue and attaching the file if you don't want to muck around with GitHub.
For all others interested: welcome! Pull requests and bug reports are greatly appreciated.
(Please note that IKE is licensed under GNU GPL v3, so if you intend to make and distribute changes, please make the source freely available or submit a pull request to this repository promptly.)
- Install the WSL
Open a new PowerShell window with Administrator privileges, and run the following command:
wsl --install
When complete, restart your computer.
- Install the prerequisites
From the Ubuntu Bash shell, run the following command:
sudo apt update && sudo apt-get install python3 npm && sudo npm install -g luamin
./build.sh
The compiled, minified Lua code will be placed in release/ike_min.lua. This is suitable for converting scenarios for PBEM play by pasting it into the Lua Code Editor and clicking RUN as the final step in the scenario creation process.
./build.sh debug
This will produce compiled but unminified Lua code in debug/ike_debug.lua. Do not use this in a released scenario. This is mostly useful to observe how the final released Lua is composed from the source files.
IKE works by injecting its own code into a CMO LuaScript event action which is executed upon every scenario load. The build process converts the IKE source into a minified, escaped string which is then re-embedded into its own code. (IKE-ception!)
IKE adds PBEM (Play by E-Mail) or Hotseat play to any Command: Modern Operations scenario, allowing you to engage in a turn-based multiplayer game with one or more opponents by exchanging .save files.
IKE...
- turns Command: Modern Operations into a WEGO-style multiplayer game in which players give orders in phases, then watch their units execute them.
- keeps track of turn order and length, and stops the scenario automatically when a player’s turn is over.
- provides a summary of any losses sustained or messages received during the last turn.
- supports either fixed turn lengths, or Harpoon-style variable turn lengths (Intermediate vs. Tactical)
- adds an (optional) Setup Phase, allowing players to configure loadouts, missions, and orders before the game begins.
- provides password protection for each player’s turn.
- allows players to either use the scenario’s recommended PBEM settings, or customize them at game start.
- maintains a consistent random seed, to discourage replaying turns for more advantageous results.
- prevents players from cheating by (optionally) disabling the Editor until the scenario has ended.
IKE is designed primarily for scenario authors who want to create a multiplayer version of their existing scenario, but it may also be used productively by players who want to convert their favorite scenario for use with a friend.
For detailed instructions, please refer to the manual included with the latest official release.
v1.55b2 (1/26/2023):
- added: message confirming autosave location at end of turn
- changed: minimum CMO build now 1307.0 (the "War Planner" update)
- changed: newer clients automatically update the save to current build
- changed: updated all scenarios to DB 498a
- changed: En Garde, 2013 - added neutral shipping
- fixed: fatal CMO version check bug in 1307
- fixed: autosave preferences taken into account
v1.55b1 (9/16/2022):
- added: initial support for "Tiny" (minimum build 1276.1)
- added: initial support for Pro users
- added: new action - Change user preferences
- added: new action - Share reference points with allied side
- added: manage creation and auto-deletion of RPs marking events
- added: option to autosave the game at the end of your turn
- changed: upgraded most scenarios to DB v496
- changed: old CMO builds prohibited during scenario creation
- fixed: new contacts from allied AI sides are reported
- fixed: string->number conversions no longer implicit
- removed: special action - Change posture (deprecated)
v1.54 (4/24/2022):
- added: The End of Françafrique, 2021 (@nukkxx)
- changed: updated Gaddafi's Legacy, 2024 (@nukkxx)
- changed: bumped minimum CMO build to 1147.45
- fixed: contact spam from friendy out-of-comms units
- fixed: contacts from friendly sides no longer disappear
- fixed: no delay on Special Messages when paused
- fixed: French and Spanish localization typos (@claudejdev)
v1.53 (3/6/2022):
- changed: bumped minimum CMO build to 1147.42
- changed: updated Gaddafi's Legacy, 2024 (@nukkxx)
- fixed: setup phase overrun
- fixed: turn skipping
- fixed: old action events removed
v1.52 (2/4/2022):
- added: new action - About IKE (for current version info)
- added: Bersama Lima, 2003 (Bridge/@nukkxx)
- added: Gaddafi's Legacy, 2024 (@nukkxx)
- added: Sahel Slugfest, 2021 (WarfareSims/@nukkxx) - DLC required
- fixed: blank scenario when loading game saved during setup phase
v1.51 (1/30/2022):
- added: fratricides from off-turn reported
- added: En Garde, 2013 (Molina/Perez/@nukkxx)
- changed: class of incoming weapon hits only reported if known
- changed: North Pacific Shootout - P-3C on AI-controlled USN side
- changed: North Pacific Shootout - Soviet Union goes first
- fixed: "never-ending-turn" loop in highest time compression
- fixed: fratricide not marked as "successful strike" or "kill"
- fixed: end message when scenario exceeds duration
v1.5 (12/21/2021):
- added: optional variable turn lengths
- added: new action - Offer a Draw
- added: new action - Resign
- added: new action - Change Password
- added: weapon strike report
- added: damage report for ships, subs, and facilities
- added: customizable event handler for end of Setup Phase
- added: Red-Blue Hawaii, 1985
- added: The Bear and the Eagle, 1987 (@Eskild)
- changed: Operation Soberania - added full airbases
- changed: Operation Soberania - Chilean loadouts changed
- fixed: some kills not reported
- fixed: first order phase message displayed correctly
- fixed: limited control in scenarios without a Setup Phase
- fixed: kill & contact records in wrong language (for real this time)
- fixed: Chinese language typos (@cristianwj)
- fixed: First Contact - end condition
- fixed: Operation Soberania - excessive fuel usage on CL Latorre
- removed: Unlimited Orders mode
v1.42 (11/20/2021):
- added: Chinese (Simplified) localization (thanks to @cristianwj!)
- added: Chinese (Simplified) translation of Scenario Author's Manual (thanks to @GolasYH 叶含!)
- added: Twin Head Dragon Exercise 2021 (by @cristianwj)
- changed: explicit message if game build is updated
- changed: various scenarios - Realistic Sub Comms disabled
- changed: various scenarios - civilian collective resp. disabled
- fixed: contact mirroring/register nils during heavy combat
- fixed: kill & contact records in wrong language
- fixed: score fixed after scenario's end
- fixed: order phases disappearing on 30x compression
- fixed: Event_Delete failure on self-destruct
v1.41 (11/7/2021):
- changed: no-editor check earlier in chain
- fixed: enemy contact detection info appearing in log
- fixed: ScenEdit_SpecialMessage behavior reverted
- fixed: exploits related to scenario end
- fixed: typo in French locale
v1.4 (10/30/2021):
- added: final order phase before the end of a turn in Limited Order mode
- added: French localization (thanks to @nukkxx!)
- added: Spanish localization (thanks to Jorge Arraya!)
- change: bumped minimum CMO build to Steam update for Red Tide DLC (1147.34)
- change: all scenarios - DB updated to v491
- change: Canary's Cage - Spanish airbases can be attacked
- fixed: RPs created between limited order phases now preserved & private
- fixed: ScenEdit_SpecialMessage no longer delayed until next frame
- fixed: replaced platform PRNG with pure Lua xorshift32
- fixed: error message reporting build number mismatch
- fixed: North Pacific Shootout - downed pilot names don't repeat
- fixed: various scenarios - weather reports restored
- fixed: various scenarios - critical RPs protected
- fixed: various scenarios - descriptions/briefings reworded
- fixed: various scenarios - late random teleportations
v1.31 (5/5/2021):
- change: host can now upgrade/downgrade CMO build
- change: older CMO clients (before 1147.17) are prohibited
- fixed: between order phases contacts will show correct posture
v1.3 (3/28/2021):
- added: new contacts from off-turn reported
- added: kills made on off-turn reported
- added: immediate and scheduled chat messages
- added: can set turn order for more than 2 playable sides
- added: Second Battle of Guadalcanal
- change: all players must use the same CMO build
- change: optional setup function must be registered
- change: losses show weapon class by which unit was killed
- change: dummy side name
- change: North Pacific Shootout - can pick up enemy pilots
- change: North Pacific Shootout - Soviet side can use sub for SAR
- fixed: contacts sometimes disappear in limited orders
- fixed: IKE wizard removes previous IKE installation
- fixed: scenarios in years 1900-1970 now work properly
- fixed: Shamal - kills give points to correct side
v1.21 (2/18/2021):
- fixed: API replacements
v1.2 (2/18/2021):
- added: limited order mode
- added: players can customize scenario settings
- added: option to prevent editor mode
- added: losses marked with RPs
- added: missed messages delivered next turn
- added: special action to change side posture
- added: localization support
- fixed: end of setup phase message
- fixed: API replacements clean themselves up
- fixed: workaround for broken ScenEnded trigger
- fixed: set clock precisely to turn boundaries
- fixed: special message order hiding IKE messages
- fixed: coop kills not reported as losses
- fixed: observed losses not reported next turn
- fixed: ScenEdit_PlayerSide() in limited order mode
- fixed: better random seed
v1.1 (2/1/2021):
- fixed: edge case for ScenEdit_SetTime()
- fixed: use os.date("!") to format scenario times
v1.0 (1/25/2021):
- Initial release.