Merge branch 'main' into feature/savegameinfo

Author: Starkku

README.md

@@ -1,12 +1,17 @@
+**CnCNet Spawner** is a project that allows CnCNet client application (like [XNA CnCNet Client](https://github.com/CnCNet/xna-cncnet-client)) to "spawn" (launch) the game right into a battle, skipping the menus and configuring game's own and CnCNet-specific things using a config file (`spawn.ini`).
+
+This particular spawner is written using a framework set up by [Ares](https://github.com/Ares-developers/Ares), [Phobos](https://github.com/Phobos-developers/Phobos) projects, uses [YRpp](https://github.com/Phobos-developers/YRpp) to interface with the game and is a rewrite of the original [YR patches](https://github.com/CnCNet/yr-patches) made by CnCNet team. It is built as a DLL loadable by [Syringe](https://github.com/Phobos-developers/Syringe).
+
 Downloads
 ---------
+
 - [Latest releases](https://github.com/CnCNet/yrpp-spawner/releases)
 
 Building manually
 -----------------
 
-1. Install **Visual Studio** (2022 is recommended, 2019 is minimum) with the dependencies listed in `.vsconfig` (it will prompt you to install missing dependencies when you open the project, or you can run VS installer and import the config). If you prefer to use **Visual Studio Code** you may install **VS Build Tools** with the dependencies from `.vsconfig` instead. Not using a code editor or IDE and building via **command line scripts** included with the project is also an option.
-2. Clone this repo recursively via your favorite git client (that will also clone YRpp and private submodule, if you have access).
+1. Install **Visual Studio** (2022 is required) with the dependencies listed in `.vsconfig` (it will prompt you to install missing dependencies when you open the project, or you can run VS installer and import the config). If you prefer to use **Visual Studio Code** you may install **VS Build Tools** with the dependencies from `.vsconfig` instead. Not using a code editor or IDE and building via **command line scripts** included with the project is also an option.
+2. Clone this repo either recursively, if you are a member of CnCNet org, or if you are not (you don't have access to private submodule) - clone non-recursively, then init-and-update the YRpp submodule only.
 3. To build the extension:
    - in Visual Studio: open the solution file in VS and build it (`Debug` build config is recommended);
    - in VSCode: open the project folder, hit `Run Build Task...` (`Ctrl + Shift + B`) and select the needed config;
@@ -17,12 +22,24 @@ Please note that you can build the hardened version only if you have access to i
 
 Credits
 -------
-- **[Belonit](https://github.com/Belonit)** - Porting and adapting
+
+- **[Belonit](https://github.com/Belonit)**
+  - Porting and adapting of the original spawner
+  - Further maintenance
+  - Fix for drawing maps smaller than the screen
 - **[Kerbiter (Metadorius)](https://github.com/Metadorius)**
   - Further maintenance
   - Event verification checks
   - Save button for multiplayer pause menu
   - Beacon crash fix for multiplayer save/load
+  - Game speed slider toggle
+  - Fake multiplayer flag
+- **[ZivDero](https://github.com/ZivDero)**
+  - Handicaps (difficulty & credits) support
+- **[Starkku](https://github.com/Starkku)**
+  - Allow customizing whether or not special house is ally to all players via spawn.ini option (#51)
+- **[RAZER](https://github.com/CnCRAZER)**
+  - Game speed slider toggle
 - **[TaranDahl](https://github.com/TaranDahl)**
   - Porting of multiplayer save/load
   - Porting of autosaves
@@ -36,6 +53,7 @@ Credits
 
 Legal and License
 -----
+
 [![GPL v3](https://www.gnu.org/graphics/gplv3-127x51.png)](https://opensource.org/licenses/GPL-3.0)
 
 This project is an unofficial open-source community collaboration project to patch the Red Alert 2 Yuri's Revenge engine for CnCNet support & compatibility purposes.
@@ -44,6 +62,7 @@ This project has no direct affiliation with Electronic Arts Inc. Command & Conqu
 
 Sponsored by
 ------------
+
 <a href="https://www.digitalocean.com/?refcode=337544e2ec7b&utm_campaign=Referral_Invite&utm_medium=opensource&utm_source=CnCNet" title="Powered by Digital Ocean" target="_blank">
     <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg" width="201px" alt="Powered By Digital Ocean" />
 </a>

src/Misc/Observers.cpp

@@ -73,12 +73,15 @@ DEFINE_HOOK(0x658473, RadarClass__658330_SetObserverFlag, 0x5)
 
 #pragma endregion HouseClass is Observer
 
-// Allow skirmish observer to control gamespeed
-// TODO: Allow control speed in skirmish if all human players is Observer
 DEFINE_HOOK(0x4E20BA, GameControlsClass__SomeDialog, 0x5)
 {
 	enum { AllowControlSpeed = 0x4E211A, ForbidControlSpeed = 0x4E20C3 };
 
+	if (Spawner::Enabled && Spawner::GetConfig()->DisableGameSpeed)
+		return ForbidControlSpeed;
+
+	// Allow skirmish observer to control gamespeed (vanilla game doesn't allow this)
+	// TODO: Allow control speed in skirmish if all human players is Observer
 	return (SessionClass::IsSkirmish() && Game::ObserverMode)
 		? AllowControlSpeed
 		: 0;

src/Spawner/Spawner.Config.cpp

@@ -85,6 +85,7 @@ void SpawnerConfig::LoadFromINIFile(CCINIClass* pINI)
 		MaxAhead         = pINI->ReadInteger(pSettingsSection, "MaxAhead", MaxAhead);
 		PreCalcMaxAhead  = pINI->ReadInteger(pSettingsSection, "PreCalcMaxAhead", PreCalcMaxAhead);
 		MaxLatencyLevel  = (byte)pINI->ReadInteger(pSettingsSection, "MaxLatencyLevel", (int)MaxLatencyLevel);
+		ForceMultiplayer = pINI->ReadBool(pSettingsSection, "ForceMultiplayer", ForceMultiplayer);
 	}
 
 	{ // Tunnel Options
@@ -109,6 +110,7 @@ void SpawnerConfig::LoadFromINIFile(CCINIClass* pINI)
 	// Extended Options
 	{
 		Ra2Mode                  = pINI->ReadBool(pSettingsSection, "Ra2Mode", Ra2Mode);
+		DisableGameSpeed         = pINI->ReadBool(pSettingsSection, "DisableGameSpeed", DisableGameSpeed);
 		QuickMatch               = pINI->ReadBool(pSettingsSection, "QuickMatch", QuickMatch);
 		SkipScoreScreen          = pINI->ReadBool(pSettingsSection, "SkipScoreScreen", SkipScoreScreen);
 		WriteStatistics          = pINI->ReadBool(pSettingsSection, "WriteStatistics", WriteStatistics);

src/Spawner/Spawner.Config.h

@@ -123,6 +123,7 @@ class SpawnerConfig
 	int MaxAhead;
 	int PreCalcMaxAhead;
 	byte MaxLatencyLevel;
+	bool ForceMultiplayer;
 
 	// Tunnel Options
 	int  TunnelId;
@@ -138,6 +139,7 @@ class SpawnerConfig
 
 	// Extended Options
 	bool Ra2Mode;
+	bool DisableGameSpeed;
 	bool QuickMatch;
 	bool SkipScoreScreen;
 	bool WriteStatistics;
@@ -196,6 +198,7 @@ class SpawnerConfig
 		, MaxAhead { -1 }
 		, PreCalcMaxAhead { 0 }
 		, MaxLatencyLevel { 0xFF }
+		, ForceMultiplayer { false }
 
 		// Tunnel Options
 		, TunnelId { 0 }
@@ -231,6 +234,7 @@ class SpawnerConfig
 
 		// Extended Options
 		, Ra2Mode { false }
+		, DisableGameSpeed { false }
 		, QuickMatch { false }
 		, SkipScoreScreen { Main::GetConfig()->SkipScoreScreen }
 		, WriteStatistics { false }

src/Spawner/Spawner.cpp

@@ -292,7 +292,7 @@ bool Spawner::StartScenario(const char* pScenarioName)
 	{ // Set SessionType
 		if (Spawner::Config->IsCampaign)
 			pSession->GameMode = GameMode::Campaign;
-		else if (Game::PlayerCount > 1)
+		else if (Game::PlayerCount > 1 || Spawner::Config->ForceMultiplayer)
 			pSession->GameMode = GameMode::Internet; // HACK: will be set to LAN later
 		else
 			pSession->GameMode = GameMode::Skirmish;

src/version.h

@@ -7,7 +7,7 @@
 #define _STR_(x) #x
 
 // Build number. Incremented on each released build
-#define BUILD_NUMBER 10
+#define BUILD_NUMBER 11
 
 // Indicates project maturity and completeness
 #define VERSION_MAJOR 0
@@ -16,7 +16,7 @@
 // Indicates minor changes, like vanilla bugfixes, unhardcodings or hacks
 #define VERSION_REVISION 0
 // Indicates YRpp-Spawner-related bugfixes only
-#define VERSION_PATCH 10
+#define VERSION_PATCH 11
 
 #if defined(IS_CNCNET_YR_VER) && defined(IS_HARDENED_VER)
 	#define PRODUCT_TYPE "(CnCNet YR, hardened)"