Merge branch 'development' into browncoat-mission

Author: pawnishoovy

.gitignore

@@ -7,16 +7,17 @@
 *.vs
 *.APS
 *.user
-
+# IDE files
 /.idea
 
 compile_commands.json
-/.ccls-cache
+**/.ccls-cache
 
-/build*
+**/build*
 
 /enc_temp_folder
 
+.vs/
 /.idea
 /_Bin
 /NATPunchServer/Server/NATCompleteServer/Debug
@@ -72,6 +73,7 @@ luac.out
 *.bat
 CortexCommand
 CortexCommand_debug
+CortexCommand.AppImage
 
 # Debug databases
 *.pdb
@@ -84,10 +86,10 @@ CortexCommand_debug
 # MacOS stuff
 .DS_Store
 
-.vs/
-Screenshots/
+# CortexCommand user files
+Screen[sS]hots/
 Mods/
-Userdata/
+User[dD]ata/
 
 allegro.log
 AbortScreen.*

CHANGELOG.md

@@ -6,10 +6,43 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+<details><summary><b>Added</b></summary>
+
+- New music system, including a dynamic horizontal sequencing system, under the new music manager `MusicMan`.
+	`PlayDynamicSong(string songName, string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to play a new DynamicSong.
+	`SetNextDynamicSongSection(string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to queue a new DynamicSongSection for the currently playing song.
+	`PlayInterruptingMusic(SoundContainer soundContainer)` to start an interrupting piece of music which will pause any playing DynamicSong. Note that pause menu music happily overrides this currently.
+	`EndInterruptingMusic()` to end any playing interrupting music, and resume any paused DynamicSongs.
+	`EndDynamicMusic(bool fadeOut)` to end any currently playing dynamic music, optionally immediately fading it out. If not fading it out, the currently playing piece will play to completion.
+	`ResetMusicState()` to immediately end all music and return the MusicMan to a blank state.
+	
+- New entities `DynamicSongSection` and `DynamicSong` which are used for organizing music to play using the new system.
+	`DynamicSongSection` is made up of TransitionSoundContainers, SoundContainers, a string SectionType, and either randomnorepeat or shuffle SoundContainerSelectionCycleMode.
+	`DynamicSong` is a simple container of DynamicSongSections. It can have one DefaultSongSection and as many added sections as needed.
+	
+- New `SoundContainer` features.
+		Lua property `Paused` (R/W) to pause or unpause all sounds of a SoundContainer. Newly played sounds will not begin playback until unpaused.
+		Lua function `GetAudibleVolume` to get the real audible volume of a SoundContainer's sounds as a float from 0 to 1. This accounts for literally everything, including game volume.
+  
+</details>
+
 <details><summary><b>Changed</b></summary>
 
 - Conquest activities will once again fall-back to using base dropships and rockets if a random selection of the selected tech's craft can't find one capable of carrying passengers and/or cargo.
 
+- ALl music-related functionality from AudioMan has been removed due to the addition of the MusicMan. Generic DynamicSongs have been put in to use instead.
+	Mod activities that used to queue up all the vanilla music should now instead call, for example, `MusicMan:PlayDynamicSong("Generic Battle Music")`
+
+</details>
+
+<details><summary><b>Fixed</b></summary>
+
+- Fixed an issue where palette index 255 was incorrectly showing as black.
+
+- Fixed instances of `CameraMan:GetScrollTarget()` and `CameraMan:SetScrollTarget()` supplying a player index instead of a screen index. This could prevent the functions from working properly, or at all, when playing as a player other than 1, potentially screwing up camera effects.
+
+- Fixed a bug in Decision Day that could cause an error when trying to set the camera's scroll target, in addition to the previous issue.
+
 </details>
 
 ## [Release v6.2.2] - 2024/02/24

Data/Base.rte/Activities/BrainVsBrain.lua

@@ -42,6 +42,8 @@ function BrainvsBrain:StartActivity(isNewGame)
 	if self.CPUTeam ~= Activity.NOTEAM then
 		self.CPUTechID = PresetMan:GetModuleID(self.TechName[self.CPUTeam]);
 	end
+	
+	MusicMan:PlayDynamicSong("Generic Battle Music");
 
 	if isNewGame then
 		self:StartNewGame();
@@ -311,16 +313,11 @@ function BrainvsBrain:EndActivity()
 	if not self:IsPaused() then
 		-- Play sad music if no humans are left
 		if self:HumanBrainCount() == 0 then
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/udiedfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Defeat Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		else
-			-- But if humans are left, then play happy music!
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/uwinfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Victory Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		end
 	end
 end
@@ -410,8 +407,9 @@ function BrainvsBrain:UpdateActivity()
 							end
 						else
 							self:ResetMessageTimer(player);
-							FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
-							FrameMan:SetScreenText("Your brain has been destroyed!", self:ScreenOfPlayer(player), 2000, -1, false);
+							local screen = self:ScreenOfPlayer(player);
+							FrameMan:ClearScreenText(screen);
+							FrameMan:SetScreenText("Your brain has been destroyed!", screen, 2000, -1, false);
 						end
 					end
 				end

Data/Base.rte/Activities/BunkerBreach.lua

@@ -253,6 +253,8 @@ function BunkerBreach:StartActivity(isNewGame)
 			FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
 		end
 	end
+	
+	MusicMan:PlayDynamicSong("Generic Battle Music");
 
 	if isNewGame then
 		-- Because of game oddities, we need to set funds to match starting gold manually.
@@ -326,15 +328,11 @@ function BunkerBreach:EndActivity()
 	-- Temp fix so music doesn't start playing if ending the Activity when changing resolution through the ingame settings.
 	if not self:IsPaused() then
 		if self.WinnerTeam == self.CPUTeam then
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/udiedfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Defeat Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		else
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/uwinfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Victory Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		end
 	end
 end

Data/Base.rte/Activities/Harvester.lua

@@ -60,7 +60,7 @@ function Harvester:StartNewGame()
 		self.randomSpawnTime = 5000;
 	elseif self.Difficulty <= GameActivity.NUTSDIFFICULTY then
 		self.goldNeeded = 7500;
-		self.goldDisplay = "sevent thousand five hundred";
+		self.goldDisplay = "seven thousand five hundred";
 		self.baseSpawnTime = 8000;
 		self.randomSpawnTime = 4500;
 	elseif self.Difficulty <= GameActivity.MAXDIFFICULTY then
@@ -82,9 +82,9 @@ function Harvester:SetupHumanPlayerBrains()
 				-- If we can't find an unassigned brain in the scene to give each player, then force to go into editing mode to place one
 				if not foundBrain then
 					self.ActivityState = Activity.EDITING;
-					AudioMan:ClearMusicQueue();
-					AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/ccambient4.ogg", -1, -1);
+					MusicMan:PlayDynamicSong("Generic Ambient Music");
 				else
+					MusicMan:PlayDynamicSong("Generic Battle Music");
 					-- Set the found brain to be the selected actor at start
 					self:SetPlayerBrain(foundBrain, player);
 					self:SwitchToActor(foundBrain, player, self:GetTeamOfPlayer(player));
@@ -132,34 +132,35 @@ function Harvester:EndActivity()
 	if not self:IsPaused() then
 		-- Play sad music if no humans are left
 		if self:HumanBrainCount() == 0 then
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/udiedfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Defeat Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		else
 			-- But if humans are left, then play happy music!
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/uwinfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Victory Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		end
 	end
 end
 
 function Harvester:UpdateActivity()
 	if self.ActivityState ~= Activity.OVER and self.ActivityState ~= Activity.EDITING then
+		if not self.musicStarted then
+			self.musicStarted = true;
+			MusicMan:PlayDynamicSong("Generic Battle Music", "Default", true);
+		end
 		--Determine how much gold the players started with.
 		if self.humanTeamFundsAfterInitialEditingPhase == -1 then
 			self.humanTeamFundsAfterInitialEditingPhase = self:GetTeamFunds(Activity.TEAM_1);
 		end
 
 		for player = Activity.PLAYER_1, Activity.MAXPLAYERCOUNT - 1 do
 			if self:PlayerActive(player) and self:PlayerHuman(player) then
+				local screen = self:ScreenOfPlayer(player);
 				--Display messages.
 				if self.startMessageTimer:IsPastSimMS(3000) then
-					FrameMan:SetScreenText(self.goldNeeded - (math.ceil(self:GetTeamFunds(Activity.TEAM_1)) - self.humanTeamFundsAfterInitialEditingPhase) .. " oz of gold left", self:ScreenOfPlayer(player), 0, 1000, false);
+					FrameMan:SetScreenText(self.goldNeeded - (math.ceil(self:GetTeamFunds(Activity.TEAM_1)) - self.humanTeamFundsAfterInitialEditingPhase) .. " oz of gold left", screen, 0, 1000, false);
 				else
-					FrameMan:SetScreenText("Dig up " .. self.goldDisplay .. " oz of gold!", self:ScreenOfPlayer(player), 333, 5000, true);
+					FrameMan:SetScreenText("Dig up " .. self.goldDisplay .. " oz of gold!", screen, 333, 5000, true);
 				end
 
 				-- The current player's team
@@ -179,8 +180,8 @@ function Harvester:UpdateActivity()
 				if not MovableMan:IsActor(self:GetPlayerBrain(player)) then
 					self:SetPlayerBrain(nil, player);
 					self:ResetMessageTimer(player);
-					FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
-					FrameMan:SetScreenText("Your brain has been destroyed!", self:ScreenOfPlayer(player), 333, -1, false);
+					FrameMan:ClearScreenText(screen);
+					FrameMan:SetScreenText("Your brain has been destroyed!", screen, 333, -1, false);
 					-- Now see if all brains of self player's team are dead, and if so, end the game
 					if not MovableMan:GetFirstBrainActor(team) then
 						self.WinnerTeam = self:OtherTeam(team);
@@ -191,8 +192,8 @@ function Harvester:UpdateActivity()
 				--Check if the player has won.
 				if self:GetTeamFunds(Activity.TEAM_1) - self.humanTeamFundsAfterInitialEditingPhase > self.goldNeeded then
 					self:ResetMessageTimer(player);
-					FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
-					FrameMan:SetScreenText("You dug up all the gold!", self:ScreenOfPlayer(player), 333, -1, false);
+					FrameMan:ClearScreenText(screen);
+					FrameMan:SetScreenText("You dug up all the gold!", screen, 333, -1, false);
 
 					self.WinnerTeam = Activity.TEAM_1;
 
@@ -337,5 +338,6 @@ function Harvester:UpdateActivity()
 		end
 	else
 		self.startMessageTimer:Reset();
+		self.musicStarted = false;
 	end
 end

Data/Base.rte/Activities/KeepieUppie.lua

@@ -69,6 +69,8 @@ function KeepieUppie:StartNewGame()
 		self.randomSpawnTime = 4000;
 	end
 	self.enemySpawnTimeLimit = 2000;
+	
+	MusicMan:PlayDynamicSong("Generic Boss Fight Music");
 
 	for player = Activity.PLAYER_1, Activity.MAXPLAYERCOUNT - 1 do
 		if self:PlayerActive(player) and self:PlayerHuman(player) then
@@ -120,16 +122,11 @@ function KeepieUppie:EndActivity()
 	if not self:IsPaused() then
 		-- Play sad music if no humans are left
 		if self:HumanBrainCount() == 0 then
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/udiedfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Defeat Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		else
-			-- But if humans are left, then play happy music!
-			AudioMan:ClearMusicQueue();
-			AudioMan:PlayMusic("Base.rte/Music/dBSoundworks/uwinfinal.ogg", 2, -1.0);
-			AudioMan:QueueSilence(10);
-			AudioMan:QueueMusicStream("Base.rte/Music/dBSoundworks/ccambient4.ogg");
+			MusicMan:PlayDynamicSong("Generic Victory Music", "Default", true);
+			MusicMan:PlayDynamicSong("Generic Ambient Music");
 		end
 	end
 end
@@ -141,13 +138,14 @@ function KeepieUppie:UpdateActivity()
 		if self.ActivityState ~= Activity.OVER and self.ActivityState ~= Activity.EDITING then
 			for player = Activity.PLAYER_1, Activity.MAXPLAYERCOUNT - 1 do
 				if self:PlayerActive(player) and self:PlayerHuman(player) then
+					local screen = self:ScreenOfPlayer(player);
 					--Display messages.
 					self:ResetMessageTimer(player);
-					FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
+					FrameMan:ClearScreenText(screen);
 					if self.startMessageTimer:IsPastSimMS(3000) then
-						FrameMan:SetScreenText(math.floor(self.winTimer:LeftTillSimMS(self.timeLimit) / 1000) .. " seconds left", self:ScreenOfPlayer(player), 0, 1000, false);
+						FrameMan:SetScreenText(math.floor(self.winTimer:LeftTillSimMS(self.timeLimit) / 1000) .. " seconds left", screen, 0, 1000, false);
 					else
-						FrameMan:SetScreenText("Keep the rocket alive for " .. self.timeDisplay .. "!", self:ScreenOfPlayer(player), 333, 5000, true);
+						FrameMan:SetScreenText("Keep the rocket alive for " .. self.timeDisplay .. "!", screen, 333, 5000, true);
 					end
 
 					-- The current player's team
@@ -156,8 +154,8 @@ function KeepieUppie:UpdateActivity()
 					if not MovableMan:IsActor(self:GetPlayerBrain(player)) then
 						self:SetPlayerBrain(nil, player);
 						self:ResetMessageTimer(player);
-						FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
-						FrameMan:SetScreenText("Your rocket has been destroyed!", self:ScreenOfPlayer(player), 333, -1, false);
+						FrameMan:ClearScreenText(screen);
+						FrameMan:SetScreenText("Your rocket has been destroyed!", screen, 333, -1, false);
 						-- Now see if all brains of self player's team are dead, and if so, end the game
 						if not MovableMan:GetFirstBrainActor(team) then
 							self.WinnerTeam = self:OtherTeam(team);
@@ -170,8 +168,8 @@ function KeepieUppie:UpdateActivity()
 					--Check if the player has won.
 					if self.winTimer:IsPastSimMS(self.timeLimit) then
 						self:ResetMessageTimer(player);
-						FrameMan:ClearScreenText(self:ScreenOfPlayer(player));
-						FrameMan:SetScreenText("You survived!", self:ScreenOfPlayer(player), 333, -1, false);
+						FrameMan:ClearScreenText(screen);
+						FrameMan:SetScreenText("You survived!", screen, 333, -1, false);
 
 						self.WinnerTeam = player;