diff --git a/docs/images/manager1.jpg b/docs/images/manager1.jpg new file mode 100644 index 00000000..a3d346b0 Binary files /dev/null and b/docs/images/manager1.jpg differ diff --git a/docs/images/manager2.png b/docs/images/manager2.png new file mode 100644 index 00000000..02d842b1 Binary files /dev/null and b/docs/images/manager2.png differ diff --git a/docs/images/manager3.png b/docs/images/manager3.png new file mode 100644 index 00000000..90bd1b41 Binary files /dev/null and b/docs/images/manager3.png differ diff --git a/docs/images/manager4.png b/docs/images/manager4.png new file mode 100644 index 00000000..3881ef25 Binary files /dev/null and b/docs/images/manager4.png differ diff --git a/docs/images/manager5.png b/docs/images/manager5.png new file mode 100644 index 00000000..ff7f9e10 Binary files /dev/null and b/docs/images/manager5.png differ diff --git a/docs/images/manager6.png b/docs/images/manager6.png new file mode 100644 index 00000000..9736accf Binary files /dev/null and b/docs/images/manager6.png differ diff --git a/docs/user_guide.md b/docs/user_guide.md new file mode 100644 index 00000000..1262fe47 --- /dev/null +++ b/docs/user_guide.md @@ -0,0 +1,907 @@ +# Contents +See GitHub Contents on the right of the page. + + +# Introduction + +## What is Olympus? + +Olympus is a program designed and created by a small group of people who love DCS. We felt there are ways of playing DCS that could be more fluid, and involve less use of Lua, and to open up mission making to a greater group of people. + +This led to the creation of the Olympus program. A web-based app that does a lot of the thinking for a mission, then simplifies it and tells DCS what to do. Thus removing the mission editor (almost) entirely from the process. + +The user interface is key to this experience, and we have done our best to make it clear and fun to use. We have leveraged the conventions many of you may have gotten used to via other real-time strategy games as Olympus does turn DCS into a real-time strategy game. One in which a Game Master can create as complex a mission as they like, however they like, completely on the fly. Using Olympus requires a human to play it "live" like a game master; it is not a tool for pre-game mission creation or planning. However, it will work alongside any premade mission. + +## The Team + +| Handle | Contribution | +|-------------|-------------------------------------------| +| Veltro | Project originator and lead programmer | +| El Tonio | Concept originator and programmer | +| Dogma | Upside down UI Wizard | +| Peekaboo | Programmer | +| Wirt | Lua Consultant | +| Woods | Programmer | +| Shredmetal | Legal Eagle | +| Lovo | Dog's Body | + +# Basics + +## Olympus Requirements + +Olympus is built first and foremost for the open beta build of DCS, and does not support the stable version. While it may work for you periodically, you may experience bugs for which we will not be able to provide support. + +## Installing Olympus + +Download the latest release archive from the [Github releases page](https://github.com/Pax1601/DCSOlympus/releases). After downloading the archive, unpack it and follow these steps: + +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. +
+3) **Create a folder named "DCS Olympus"** in your "Saved Games" directory and extract all the contents of the downloaded archive into it. + NOTE: + a) Do not extract the contents of the archive directly in your Saved Games folder or in your DCS Saved Games folder. + b) Unlike previous version of Olympus, it is no longer necessary to copy the archived files into each DCS instance folder. +
+4) **Execute the "installer.bat"** script by double-clicking on it. It is located in the folder you created in step 3. 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). +
+5) 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** (see the dedicated section below for more information). +
+6) **Start DCS and run a mission. Make sure it is UNPAUSED**. +
+7) **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. +Dedicated server: users must first start the Olympus server from the provided desktop shortcut or using the "Expert view" mode of the Manager. +Then log in using any browser and visiting ```http:\\server_IP:frontend_port``` (frontend port is 3000 by default, but can be edited using the Manager) +
+8) 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 frontend 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**. + + +Once you have installed Olympus, it will run whenever you are playing a DCS local mission or hosting a multiplayer server. To control the action, open the Olympus client via the icon on your desktop or start menu. + +## Using the Manager +The Olympus Manager is used to install, update, and configure your Olympus installation. If you own a dedicated server and run multiple Olympus instances at the same time, the Manager allows you to conveniently handle them from a single location. + +**REMEMBER, after installing Olympus with step 4) of the installation process above, you will still need to add it to your DCS instance!** + +When you start the Manager for the first time, it will allow to choose between Basic and Expert mode. Basic mode is suggested for local only users, while Expert mode is tailored for dedicated server owners. You can change the mode at any time with the link in the toolbar at the top of the manager. Note that the choice of the Manager mode has no impact on the functionality of Olympus. Server owners can use Basic mode, or vice versa. + +### Basic mode + +Basic mode gives you access to an installation Wizard. To start it, click on "Add Olympus". If you have more than one DCS instance installed, the Wizard will allow you to select the one you want to add Olympus to. If only one instance is detected, this step will be skipped. + +**Should the Wizard fail at detecting your DCS instance, you can manually add it. To do so, open the ```\manager\options.json``` file and add the location of your DCS instance, between double quotes, in ```additionalDCSInstances```. Multiple values should be separated by a comma. Use double backslashes as separators** + +Once the DCS instance is selected, you will be prompted with a series of questions which will allow you configure your installation. The meaning of all the questions and the options is explained in the Manager itself, move your mouse cursor on the info icons for more information. + +### Expert mode + +Expert mode operates more as a dashboard rather than a Wizard. All DCS instances are presented to the user, and you will be able to install/configure/remove Olympus from a single page. + +The meaning of all the options is also explained by moving your mouse cursor on the info icon. + +In Expert mode, users are also capable of starting the Olympus client and server directly from the Manager. This is convenient if you have multiple installations. Once a client/server instance is running, the Manager allows you to monitor its state directly from the Expert view. + +## Logging into Olympus + +To login to Olympus, you need to enter a username and password. + +**The username field is used for logging purposes only and can be anything you choose. The password is the one you set during the installation.** + +If you forget a password or need to change them for security purposes, use the manager to configure it again, then restart the Olympus client\server and DCS mission. + +Please note that at the moment, ```configurator.exe``` is a feature which is not present in local installations created via the installer, but is present when Olympus is installed via any of the other methods. In order to reset the Olympus client passwords for local installations, you will need to reinstall Olympus. This will be addressed in a future update. + +You may notice there are `redCommander` and `blueCommander` passwords in the configurator. This is for missions where you would like to pit human Olympus players against one another, or have players not see everything on the other coalition. More details on this are in the "PvP Mode" section. + +# User Interface + +We have done our best to make the user interface (UI) as easy to understand as possible. Let's take a look at the overview. + +Olympus is also most optimized for the Chrome web browser. + +## Overview + +![Olympus Overview](https://github.com/Pax1601/DCSOlympus/assets/55553527/0bc2a99a-3e8d-4a8e-b2c1-6589a0d1ed16) + +### Map Options + +- **Map Tiles:** Found in the top left. Allows you to change how the map tiles look, like switching between satellite and map mode in Google Maps. Different map sources have different looks and detail based on the zoom level, so see what works best for you. + +![Map Tiles](https://github.com/Pax1601/DCSOlympus/assets/91024799/ddf28cf1-e09a-4998-a112-decd99a93cfb) + +- **Map Options:** Allows you to select what information you want displayed on the map. Notice there are key commands listed for some lines in parentheses. + +![Map Options](https://github.com/Pax1601/DCSOlympus/assets/66554898/36e5a729-1998-4259-a21e-1304a6ace2bb) + +### Show/hide options + Allows you to select what is displayed on the map. You can toggle visibility of human-controlled units, Olympus-controlled units, DCS-controlled units (i.e. units created using the mission editor and its triggers - note that taking control of these will break any link to the mission's logic), fixed-wing air units, rotary-wing air units, air defence units, naval units, ground units, airfield icons, and the three coalitions via these options. + +![Show/Hide Options](https://github.com/Pax1601/DCSOlympus/assets/55553527/aad714b6-7413-490c-8ef5-4385dced14ac) + +### The "Robot lock" +![Robot lock](https://github.com/Pax1601/DCSOlympus/assets/66554898/9af02ae4-7686-4781-8824-5fd159ad1641) + +This lock protects DCS-controlled units, which we refer to as "robots". These are the ones created and controlled by the mission editor. If any commands are given to a robot, it will become an Olympus-controlled unit and any triggers and scripts that rely on the mission having control of that unit will be broken. The mission may fail because of this - or even crash. In order to stop accidental breakage, this lock is in place. + +If you want to take control of a robot, unlock this control and give your command to the robot. It's best to place the lock back on so you don't accidentally delete your aircraft carrier! + +### Game Master Options +This shows the status and options for Olympus game master and coalition commander modes. These are intended for two or more people to compete using DCS Olympus and limit each side's visibility and ability to spawn certain units. More info in the PvP section. + +![Game Master Options](https://github.com/Pax1601/DCSOlympus/assets/91024799/3962589e-949e-4d9c-877b-95ff0f715c5e) + +### Minimap +This shows the overall theatre, an overview of units, and an orange box to represent the main map's field of view. You can click the minimap to snap to that location. + +![Minimap](https://github.com/Pax1601/DCSOlympus/assets/91024799/a21d16e4-4ccd-4ccf-9638-0600c7d99d5e) + +### Airfields +Every airfield in the area is shown with an airfield symbol, the colour of the symbol shows you which side the field belongs to, grey for Neutral, blue for Blue, and red for Red. This is live and will change if the field is overtaken in DCS. + +![Airfield](https://github.com/Pax1601/DCSOlympus/assets/66554898/50dc52db-3f32-4d02-966c-57be0d957293) + +Right-clicking on an airfield will give you an airfield overview. Hovering your mouse over a runway name (heading) and you will get the magnetic heading. Hovering over the "ILS" marker will give you the ILS frequency. You can also spawn AI hot from parking units at an airfield by clicking "Spawn". + +![Airfield summary](https://github.com/Pax1601/DCSOlympus/assets/66554898/4ab6a0c7-3f58-4ba3-acda-19bcd559d730) + +### Cursor Location Info: +This shows the location information of the mouse cursor in a variety of formats. Clicking the location formats (or pressing Z) will cycle them. + +| Full display | Lat-long | MGRS | Decimal | +|---|---|---|---| +| ![Cursor Location Info](https://github.com/Pax1601/DCSOlympus/assets/91024799/6931b4a8-9b2f-4a17-a69b-029e28e7bc7b) | ![Lat-long](https://github.com/Pax1601/DCSOlympus/assets/66554898/710f39c2-9f67-45c7-b9e2-39a69d96fcdf) | ![MGRS](https://github.com/Pax1601/DCSOlympus/assets/66554898/1160c85a-a028-47f3-a07e-0f07c4bd4c97)
[,] (comma) will reduce the accuracy
[.] (full stop) will increase the accuracy| ![image](https://github.com/Pax1601/DCSOlympus/assets/66554898/1f02a75e-9ffa-4ed5-a099-4ee4b59af4c6) | + +### Connection Status +This will show whether or not you have successfully connected to the server in question. This will work even if the server is paused, however, you cannot affect the game while it is paused. You will also see the Elapsed Time of the mission, which is how long the mission has been running. You can click this to toggle between that and Mission Time (local). + +| State | Example | +|---|---| +| Connected with elapse timed showing | ![Connected - elapsed time](https://github.com/Pax1601/DCSOlympus/assets/66554898/6b88ecc9-1e0b-439c-b58c-c327e4b4dd47) | +| Connected with location time showing | ![Connected - mission time](https://github.com/Pax1601/DCSOlympus/assets/66554898/b26952c1-2994-42fe-82a7-cf7df1063b5c) | +| Server paused (connected) | ![Server paused](https://github.com/Pax1601/DCSOlympus/assets/66554898/d831f3c1-c995-43d6-ba1a-dd1fef76d0a6) | +| Not connected | ![No Connection Status](https://github.com/Pax1601/DCSOlympus/assets/91024799/f82669ad-ed86-4385-812c-ca9296a4983c) | + +## Selected Unit Information + +When we select a unit, we will see further information and options. + +![Selected Unit Example](https://github.com/Pax1601/DCSOlympus/assets/91024799/ef2e70a2-d28b-4160-bfd5-0fb74d1460bc) + +### Selected Units Window +This window allows you to control the unit's parameters and settings. + +| | | +|:---------------------------------------------------------------------------:|-----| +| ![Selected Unit/s Name](https://github.com/Pax1601/DCSOlympus/assets/91024799/8dc319e6-5c8a-4078-b746-dc5bc10f8618) | **Selected Unit/s name**
The type is also displayed. | +| ![Flight Controls](https://github.com/Pax1601/DCSOlympus/assets/91024799/5e2f7f9e-0221-452d-81bb-8cfb5dd9e69a) | **Flight Controls**
Shows the instructed speed and altitude for the selected unit. You can toggle between ASL and AGL, as well as CAS and GS. This will grey out if multiple units are selected with differing instructed parameters. You can also see the upper and lower limits of the speed and altitude scales. | +| ![Rules of Engagement (RoE)](https://github.com/Pax1601/DCSOlympus/assets/91024799/80151289-5846-4deb-a028-c7ccbaf41d1e) | **Rules of Engagement (RoE)**
Shows the ways in which the unit will attack other units. The RoE options are: +| ![Reaction to Threat](https://github.com/Pax1601/DCSOlympus/assets/91024799/20794ba3-116f-485f-ab84-0c18e04f618f) | **Reaction to Threat**
Shows the ways in which the unit will behave when threatened. The options are: