Merge pull request #894 from Pax1601/release-candidate

v1.0.4

.github/workflows/build_package.yml

@@ -2,7 +2,7 @@ name: Build & package
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "release-candidate" ]
 
 permissions:
   contents: read
@@ -33,6 +33,13 @@ jobs:
     - name: Upload a Build Artifact
       uses: actions/[email protected]
       with:
-        name: latest
-        path: installer/Output/*.exe
+        name: development_build_not_a_release
+        path: ./package
+
+    - name: Upload a Build Artifact
+      uses: actions/[email protected]
+      with:
+        name: zip_only_package
+        path: ./zip
+
 

.github/workflows/documentation.yml

@@ -23,12 +23,12 @@ jobs:
         uses: actions/setup-node@v2
 
       - name: Install dependencies
-        run: npm ci
-        working-directory: ./client
+        run: npm install
+        working-directory: ./frontend/website
 
       - name: Create the docs directory locally in CI
-        run: npx typedoc --out ../docs/client @types/*.d.ts src/**/*.ts
-        working-directory: ./client
+        run: npx typedoc --out ../../docs/website @types/*.d.ts src/**/*.ts
+        working-directory: ./frontend/website
 
       - name: Install Doxygen
         uses: ssciwr/doxygen-install@v1

.gitignore

@@ -1,29 +1,42 @@
 bin
 .vs
 x64
-/src/vcpkg_installed
-*.user
 Output
-*.aps
 node_modules
-/client/TODO.txt
-/client/public/javascripts/bundle.js
-!client/bin
-/client/public/plugins
-/client/plugins/controltips/index.js
 hgt
-/client/public/databases/units/old
-/client/plugins/databasemanager/index.js
+
+/backend/vcpkg_installed
+
+/frontend/server/TODO.txt
+/frontend/server/public/javascripts/bundle.js
+/frontend/server/public/plugins
+/frontend/server/plugins/controltips/index.js
+/frontend/server/public/databases/units/old
+/frontend/server/plugins/databasemanager/index.js
 
 /src/html
 /src/latex
-client/public/stylesheets/leaflet/leaflet-gesture-handling.css
-client/public/javascripts/leaflet.nauticscale.js
-client/public/javascripts/L.Path.Drag.js
-/installer/archive/Scripts
-/installer/archive/Mods
-/installer/installer/DCSOlympus*.exe
+
+/package
+/build
+/DCS Olympus backups
+/zip
+
+*.user
+*.aps
 
 L.Path.Drag.js
 leaflet-gesture-handling.css
+leaflet.nauticscale.js
+leaflet.css
 package-lock.json
+
+!frontend/server/bin
+/mock-dcs
+/frontend/setup
+frontend/server/public/plugins/controltipsplugin/index.js
+frontend/website/plugins/controltips/index.js
+/frontend/server/public/maps
+*.pyc
+/scripts/**/*.jpg
+manager/manager.log

INSTRUCTIONS.txt

@@ -0,0 +1,59 @@
+  _____   _____  _____    ____  _                                 
+ |  __ \ / ____|/ ____|  / __ \| |                                
+ | |  | | |    | (___   | |  | | |_   _ _ __ ___  _ __  _   _ ___ 
+ | |  | | |     \___ \  | |  | | | | | | '_ ` _ \| '_ \| | | / __|
+ | |__| | |____ ____) | | |__| | | |_| | | | | | | |_) | |_| \__ \
+ |_____/ \_____|_____/   \____/|_|\__, |_| |_| |_| .__/ \__,_|___/
+                                   __/ |         | |              
+                                  |___/          |_|              
+
+{{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 "...<DCS Saved Games folder>\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 package into it.
+	NOTE:
+    	a) Do not extract the contents of the package 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 packaged 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.
+
+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 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:\\<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.
+
+
+==========================================
+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 package from the GitHub releases page, delete the old unpacked package 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.

README.md

@@ -9,8 +9,6 @@
 
 # DCS Olympus
 
-![alt text](https://github.com/Pax1601/DCSOlympus/blob/main/client/sample.png?raw=true)
-
 ### What is this?
 DCS: Olympus is a free and open-source mod for DCS that enables dynamic real-time control through a map interface. The user is able to spawn units/groups, deploy a variety of effects such as smoke, flares, or explosions, and waypoints/tasks can be given to AI units in real-time in a way similar to a classic RTS game. 
 
@@ -23,18 +21,30 @@ Even better it requires no client mods be installed if used on a server
 The full feature list is simply too long to enumerate in a short summary but needless to say Olympus offers up a lot of unique gameplay that has previously not existed, and enhances many other elements of DCS in exciting ways 
 
 ### Installing DCS Olympus
-A prebuilt installer will soon be released and available here
+Check the [Wiki](https://github.com/Pax1601/DCSOlympus/wiki) for installation instructions
 
 # Frequently Asked Questions
-### Can I join up and help out with the project? ###
-We are currently running towards first release in the very near future so we are not looking to add more people to the core team for the moment. However that does not mean we are not open to collaborations and help going forward, if you want to help for now we are committed to the free and open source model so feel free to check out the github, familiarize yourself with the project and maybe even start submitting pull requests for open issues.
 
-Post-release we will be more interested in developing partnerships/collaborations with other teams/projects and potentially bringing in more team members, we will update this after release on how that will be managed!
+### I need troubleshooting guidance, please help? ###
+Read through the [Installation Guide](https://github.com/Pax1601/DCSOlympus/wiki) to ensure you have setup Olympus correctly.
 
-### Can I be a beta/alpha-tester? ###
-With first public release planned for the very-near future we are fully committed to the final sprint, as such we will not be formally recruiting more people to test pre-release. 
+Read through [Setup Troubleshooting](https://github.com/Pax1601/DCSOlympus/wiki/Setup-Troubleshooting) for common issues and solutions.
+
+Read through the [Olympus User Guide](https://github.com/Pax1601/DCSOlympus/wiki/2.-User-Guide) to learn how to use Olympus.
 
-Post-release we will be eager to hear feedback of all forms and take in bug-reports, at this time after release we will begin considering bringing in more team members to test in development versions as we go.
+If you're still having issues after trying the steps above, please post in the ⁠community-support channel with the following:
+
+A detailed description of your issue
+Your Olympus log file \user home folder\AppData\Local\Temp\Olympus_log.txt for some it might be in \DCS Saved Games folder\Logs\Olympus_log.txt
+Your DCS log file \DCS Saved Games folder\Logs\dcs.log
+
+Screenshots of any relevant screens or issues and any other pertinent information.
+
+### Can I join up and help out with the project? ###
+Absolutely, join the discord and ping any of the developers to get briefed.
+
+### Can I be a beta/alpha-tester? ###
+Same as above!
 
 ### Do you have a roadmap? ###
 We do not have a roadmap no, we have a laundry list of things we are hoping to do. 
@@ -71,9 +81,5 @@ A and B never communicate when you connect the client you download the web page
 Olympus by itself should not have a noticeable impact on server performance, however the ability for the user to spawn arbitrary units and command engagements means Olympus can be used in such a way that brings the game to it's knees.
 
 Be cognizant of how you play, whether it's done through Olympus or the mission editor 500 MLRS units firing at once is not going to go over well with most servers
-
-
-
-
 
 

src/core/core.rc → backend/core/core.rc

@@ -61,7 +61,7 @@ LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_UK
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,0,3,0
+ FILEVERSION 1,0,4,0
  PRODUCTVERSION 1,0,3,0
  FILEFLAGSMASK 0x3fL
 #ifdef _DEBUG
@@ -79,12 +79,12 @@ BEGIN
         BEGIN
             VALUE "CompanyName", "DCS Olympus"
             VALUE "FileDescription", "DCS Olympus"
-            VALUE "FileVersion", "1.0.3.0"
+            VALUE "FileVersion", "1.0.4.0"
             VALUE "InternalName", "core.dll"
             VALUE "LegalCopyright", "Copyright (C) 2023"
             VALUE "OriginalFilename", "core.dll"
             VALUE "ProductName", "DCS Olympus"
-            VALUE "ProductVersion", "1.0.3.0"
+            VALUE "ProductVersion", "1.0.4.0"
         END
     END
     BLOCK "VarFileInfo"

src/core/core.vcxproj → backend/core/core.vcxproj

@@ -110,26 +110,26 @@
   </ImportGroup>
   <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
     <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-	<Import Project="..\DCSOlympus.props" />
+    <Import Project="..\DCSOlympus.props" />
   </ImportGroup>
   <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
     <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-	<Import Project="..\DCSOlympus.props" />
+    <Import Project="..\DCSOlympus.props" />
   </ImportGroup>
   <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-	<Import Project="..\DCSOlympus.props" />
+    <Import Project="..\DCSOlympus.props" />
   </ImportGroup>
   <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
     <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-	<Import Project="..\DCSOlympus.props" />
+    <Import Project="..\DCSOlympus.props" />
   </ImportGroup>
   <PropertyGroup Label="UserMacros" />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <OutDir>.\..\..\bin\$(Platform)\$(Configuration)\</OutDir>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
-    <OutDir>.\..\..\bin\</OutDir>
+    <OutDir>.\..\..\build\backend\bin\</OutDir>
   </PropertyGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
     <ClCompile>
@@ -212,4 +212,4 @@
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>
-</Project>
+</Project>

src/core/include/datatypes.h → backend/core/include/datatypes.h

@@ -152,6 +152,7 @@ struct SpawnOptions {
 	string unitType;
 	Coords location;
 	string loadout;
+	string skill;
 	string liveryID;
 };
 

src/core/src/commands.cpp → backend/core/src/commands.cpp

@@ -46,7 +46,9 @@ string SpawnGroundUnits::getString()
             << "unitType = " << "\"" << spawnOptions[i].unitType << "\"" << ", "
             << "lat = " << spawnOptions[i].location.lat << ", "
             << "lng = " << spawnOptions[i].location.lng << ", "
-            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << " }, ";
+            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << ", "
+            << "skill =  \"" << spawnOptions[i].skill << "\"" << "}, ";
+
     }
 
     std::ostringstream commandSS;
@@ -70,7 +72,8 @@ string SpawnNavyUnits::getString()
             << "unitType = " << "\"" << spawnOptions[i].unitType << "\"" << ", "
             << "lat = " << spawnOptions[i].location.lat << ", "
             << "lng = " << spawnOptions[i].location.lng << ", "
-            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << " }, ";
+            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << ", "
+            << "skill =  \"" << spawnOptions[i].skill << "\"" << "}, ";
     }
 
     std::ostringstream commandSS;
@@ -95,7 +98,8 @@ string SpawnAircrafts::getString()
             << "lng = " << spawnOptions[i].location.lng << ", "
             << "alt = " << spawnOptions[i].location.alt << ", "
             << "loadout = \"" << spawnOptions[i].loadout << "\"" << ", "
-            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << " }, ";
+            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << ", "
+            << "skill =  \"" << spawnOptions[i].skill << "\"" << "}, ";
     }
 
     std::ostringstream commandSS;
@@ -122,7 +126,8 @@ string SpawnHelicopters::getString()
             << "lng = " << spawnOptions[i].location.lng << ", "
             << "alt = " << spawnOptions[i].location.alt << ", "
             << "loadout = \"" << spawnOptions[i].loadout << "\"" << ", "
-            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << " }, ";
+            << "liveryID = " << "\"" << spawnOptions[i].liveryID << "\"" << ", "
+            << "skill =  \"" << spawnOptions[i].skill << "\"" << "}, ";
     }
 
     std::ostringstream commandSS;