diff --git a/INSTRUCTIONS.txt b/INSTRUCTIONS.txt index edbc3169..93123fbe 100644 --- a/INSTRUCTIONS.txt +++ b/INSTRUCTIONS.txt @@ -9,25 +9,49 @@ v{{OLYMPUS_VERSION_NUMBER}} +========================================== INSTALLATION INSTRUCTIONS 1) Close any applications which may interfere with installation, including Digital Combat Simulator (DCS) and previous versions of Olympus. 2) If you DO NOT have Olympus already installed, SKIP THIS STEP. If you have already installed Olympus, do the following: + NOTE: If you made any changes to your unit databases or mods.lua file (e.g. to support a third party mod) make a backup of the edited files before proceeding or changes will be lost; a) If you installed DCS Olympus v1.0.3 using the installer, simply remove it using Windows's "Add or remove programs" application. b) If you installed DCS Olympus v1.0.3 using the archived version, remove it by deleting the "...\Mods\Services\Olympus" folder. Do this for every DCS instance you installed Olympus in. - Remember to delete any shortcuts you created. Don't worry, they will be created automatically again by the installation script provided in this package + Remember to delete any shortcuts you created. Don't worry, they will be created automatically again by the installation script provided in this package. -3) Execute the "install.bat" script by double-clicking on it. Wait for the installation script to complete. - NOTE: depending on your Windows configuration, the script may be called "install" (without .bat at the end). +3) Extract all the contents of the DCS Olympus v{{OLYMPUS_VERSION_NUMBER}} archive in your "Saved Games" folder (NOTE: not your DCS Saved Games folder). + NOTE: Unlike previous version of Olympus, it is no longer necessary to copy the archived files into each DCS instance folder. -4) The new Olympus Manager will open. This will allow you to add/remove Olympus to individual DCS installations. +3) Execute the "installer.bat" script by double-clicking on it. Wait for the installation script to complete. Installation may take a couple of minutes, after which the Manager will start automatically. + NOTE: depending on your Windows configuration, the script may be called "installer" (without .bat at the end). + +4) The Olympus Manager will open. This will allow you to add/remove Olympus to individual DCS instances. Use the Olympus Manager and follow the instructions to install and setup Olympus. 5) Start DCS and run a mission. Make sure it is UNPAUSED. -6) Open Olympus via the shortcut and login using any username and the Gamemaster password set using the configurator. - Local installation: run the client from the provided shortcut, or visit "http://localhost:3000/" in a web browser (Google Chrome recommended). - Dedicated server: users must first start the Olympus server, then log in using any browser and visiting "http:\\:" (backend port is 3001 by default) +6) Open Olympus via the shortcut and login using any username and the Game Master password set using the Manager. (NOTE: not your DCS server password). + Local installation: run the client from the provided desktop shortcut or start it using the "View and manage instances" page of the Manager. + Dedicated server: users must first start the Olympus server from the provided desktop shortcut or using the "View and manage instances" page of the Manager. + Then log in using any browser and visiting "http:\\:" (client port is 3000 by default, but can be edited using the Manager) 7) You can use the manager at any time to change the ports and/or passwords. If you do, REMEMBER TO RESTART OLYMPUS AND DCS. + + +NOTES: +a) when launching the Manager you will be prompted to allow Electron to create a firewall rule. This is optional and can be denied without effect on the operation of the Manager; +b) if you are using Olympus on a dedicated server with a router, you must enable port forwarding on the client port (3000 by default); +c) unlike Olympus v1.0.3, running the netsh command is no longer required. It is also no longer required to create firewall rules or port forwarding for the backend port. (Optional) If you already performed this steps in the past you can delete the firewall and netsh rules. + + +========================================== +UPDATING INSTRUCTIONS + +IF YOU ARE UPDATING FROM DCS OLYMPUS v1.0.3, FOLLOW THE "INSTALLATION INSTRUCTIONS". + +To update your Olympus installation you have two options: +a) download the new archive from the GitHub releases page, delete the old unpacked archive folder, then follow the INSTALLATION INSTRUCTIONS; +b) run the Olympus Manager. If an update is available you will be given the option to automatically update Olympus from there. + +For either options a) or b), remember to close any applications which may interfere with installation, including Digital Combat Simulator (DCS) and previous versions of Olympus. \ No newline at end of file