Make seeding main

.github/workflows/build.yml

@@ -20,6 +20,23 @@ jobs:
       with:
         path: randomiser
 
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.7
+
+    - uses: actions/cache@v4
+      with:
+        path: ~\AppData\Local\pip\Cache
+        key: ${{ runner.os }}-pip-a
+        restore-keys: |
+            ${{ runner.os }}-pip-
+
+    - name: Install python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pygit2
+
     - name: Check mod launcher version
       id: mod-launcher-version
       run: |
@@ -49,6 +66,12 @@ jobs:
       run: |
         Expand-Archive -LiteralPath '.\launcher.zip' -DestinationPath '.\mod-launcher'
 
+    - name: Upgrade Meta.ini
+      run: |
+        cd randomiser\Randomiser
+        python meta.py
+        del meta.py
+
     - name: Compile mod
       run: |
         & '.\mod-launcher\Lucas Simpsons Hit & Run Mod Launcher.exe' -ignoreloaderrors -mods ".\randomiser" -compile "Randomiser" -outputpath ".\" | Out-String

Randomiser/CustomFiles.ini

@@ -24,6 +24,7 @@ art/missions/*_doors.p3d=Resources/HandleLevelDoors.lua
 *.rms=Resources/HandleRMS.lua
 art/cars/*.p3d=Resources/HandleCarModel.lua
 art/frontend/scrooby/frontend.p3d=Resources/HandleFrontend.lua
+art/frontend/scrooby/ingame.p3d=Resources/HandleIngame.lua
 art/frontend/dynaload/images/license/licensePC.p3d=Resources/RandomLicense.lua
 scripts/cars/*.con=Resources/HandleCar.lua
 art/l*i*.p3d=Resources/HandleLevelInterior.lua

Randomiser/CustomFiles.lua

@@ -9,6 +9,7 @@ dofile(Paths.Resources .. "GlobalVariables.lua")
 dofile(Paths.Resources .. "GlobalFunctions.lua")
 dofile(Paths.Resources .. "lib/P3D.lua")
 dofile(Paths.Resources .. "lib/P3DFunctions.lua")
+dofile(Paths.Resources .. "lib/Seed.lua")
 
 GetFiles(RandomCharP3DPool, "/GameData/art/chars/", {".p3d"})
 local ExcludedChars = {["npd_m"]=true,["ndr_m"]=true,["nps_m"]=true}
@@ -50,9 +51,9 @@ if Settings.SpeedrunMode then
 	DebugPrint("Speedrun mode enabled, settings have been overridden")
 end
 
-dofile(Paths.Resources .. "MissionScripts/LoadModules.lua")
-
-Cache = {}
+if Settings.IsSeeded then
+	Seed.Init()
+end
 
 if Settings.UseDebugSettings then
 	if not Confirm("You have Use Debug Settings enabled. This allows a secondary mod to force certain randomisations and sometimes run code.\nAre you sure you want this enabled?") then
@@ -64,20 +65,6 @@ end
 
 DebugPrint("Debug settings enabled: " .. (Settings.UseDebugSettings and "true" or "false"))
 
-if #RandomCarPoolPlayer < 5 and Settings.RandomPlayerVehicles then
-	Alert("You have chosen less than 5 cars for the random player pool. You must choose at least 5 cars.")
-	os.exit()
-elseif #RandomCarPoolTraffic < 5 and Settings.RandomTraffic then
-	Alert("You have chosen less than 5 cars for the random traffic pool. You must choose at least 5 cars.")
-	os.exit()
-elseif #RandomCarPoolMission < 5 and Settings.RandomMissionVehicles then
-	Alert("You have chosen less than 5 cars for the random mission pool. You must choose at least 5 cars.")
-	os.exit()
-elseif #RandomCarPoolChase < 5 and Settings.RandomChase then
-	Alert("You have chosen less than 5 cars for the random chase pool. You must choose at least 5 cars.")
-	os.exit()
-end
-
 if Settings.VerboseDebug then
 	local OldOutput = Output
 	local OldRedirect = Redirect
@@ -112,9 +99,32 @@ if Settings.RandomDialogue then
 	dofile(Paths.Resources .. "RandomDialogue.lua")
 end
 
+if #RandomCarPoolPlayer < 5 and Settings.RandomPlayerVehicles then
+	Alert("You have chosen less than 5 cars for the random player pool. You must choose at least 5 cars.")
+	os.exit()
+elseif #RandomCarPoolTraffic < 5 and Settings.RandomTraffic then
+	Alert("You have chosen less than 5 cars for the random traffic pool. You must choose at least 5 cars.")
+	os.exit()
+elseif #RandomCarPoolMission < 5 and Settings.RandomMissionVehicles then
+	Alert("You have chosen less than 5 cars for the random mission pool. You must choose at least 5 cars.")
+	os.exit()
+elseif #RandomCarPoolChase < 5 and Settings.RandomChase then
+	Alert("You have chosen less than 5 cars for the random chase pool. You must choose at least 5 cars.")
+	os.exit()
+end
+
 DebugPrint("Loaded " .. #RandomCarPoolPlayer .. " cars for the random Player pool")
 DebugPrint("Loaded " .. #RandomCarPoolTraffic .. " cars for the random Traffic pool")
 DebugPrint("Loaded " .. #RandomCarPoolMission .. " cars for the random Mission pool")
 DebugPrint("Loaded " .. #RandomCarPoolChase .. " cars for the random Chase pool")
 DebugPrint("Using " .. RandomPedPoolN .. " pedestrians")
-DebugPrint("Using " .. #RandomCharP3DPool .. " characters")
+DebugPrint("Using " .. #RandomCharP3DPool .. " characters")
+
+dofile(Paths.Resources .. "MissionScripts/LoadModules.lua")
+
+-- Seed.NonModuleSeed
+if Settings.IsSeeded then
+	Seed.PrintSpoiler()
+end
+Cache = {}
+

Randomiser/Meta.ini

@@ -12,7 +12,7 @@ RequiredHack=FileSystemRCFs
 OptionalFramework=RandomiserDialogue
 OptionalFramework=RandomiserCars
 OptionalFramework=RandomiserChars
-Version=2.1-git
+Version=3.0-git
 SettingsHeight=601
 SettingsWidth=550
 RequiredLauncher=1.24
@@ -84,6 +84,90 @@ Name=Steve
 Credits=1
 Group=Testing
 
+[Setting]
+Name=SpeedrunMode
+Title=Speedrun Mode
+Type=TickBox
+Default=0
+Tooltip=Enables the speedrun settings viable for the leaderboards
+Page=General
+Group=Rulesets
+
+[Setting]
+Name=IsSeeded
+Title=Seeded Mode
+Type=TickBox
+Default=0
+Tooltip=Enables seeded mode for predictable randomness
+Page=General
+Group=Seedng
+
+[Setting]
+Name=Seed
+Title=Seed
+Type=Text
+Default=
+Tooltip=Seed to use for RNG, technically a base64 encoded 64-bit integer but short words work too. If blank a new seed is generated
+Page=General
+Group=Seedng
+
+[Setting]
+Name=SkipLocks
+Title=Remove car/costume requirements
+Type=TickBox
+Default=0
+Tooltip=Remove specific car/costume requirements from certain missions
+Page=General
+Group=Gameplay
+
+[Setting]
+Name=SkipFMVs
+Title=Skip cutscenes (except intro cutscene)
+Type=TickBox
+Default=0
+Tooltip=Remove all in-game cutscenes, including the ones at the end of levels. The intro cutscene can be skipped by enabling "No Introduction Movies"
+Page=General
+Group=Gameplay
+
+[Setting]
+Name=BoostHP
+Title=Increase HP for weak cars
+Type=TickBox
+Default=0
+Tooltip=Slightly increases HP for weak vehicles like the rocket car
+Page=General
+Group=Gameplay
+
+[Setting]
+Name=DebugLevel
+Title=Debug level
+Type=Number
+Integer=1
+Min=0
+Max=5
+Default=0
+Tooltip=Sets the debug level for console printing - 0 will print only the basics whilst 5 will print everything
+Page=General
+Group=Debugging
+
+[Setting]
+Name=VerboseDebug
+Title=Verbose debug
+Type=TickBox
+Default=0
+Tooltip=If enabled, outputs all modified files to the console. Not recommended unless bug testing specifically.
+Page=General
+Group=Debugging
+
+[Setting]
+Name=UseDebugSettings
+Title=Use debug settings
+Type=TickBox
+Default=0
+Tooltip=If enabled, allows a secondary mod to force certain parts of the randomiser.
+Page=General
+Group=Debugging
+
 [Setting]
 Name=RandomCouch
 Title=Random couch character
@@ -3945,64 +4029,26 @@ Tooltip=Attempts to randomise the UFO locations in levels.
 Page=Chaos Randomisations
 Testing=1
 
-[Setting]
-Name=SkipLocks
-Title=Remove car/costume requirements
-Type=TickBox
-Default=0
-Tooltip=Remove specific car/costume requirements from certain missions
-Page=Misc
-
-[Setting]
-Name=SkipFMVs
-Title=Skip cutscenes (except intro cutscene)
-Type=TickBox
-Default=0
-Tooltip=Remove all in-game cutscenes, including the ones at the end of levels. The intro cutscene can be skipped by enabling "No Introduction Movies"
-Page=Misc
-
-[Setting]
-Name=BoostHP
-Title=Increase HP for weak cars
-Type=TickBox
-Default=0
-Tooltip=Slightly increases HP for weak vehicles like the rocket car
-Page=Misc
-
-[Setting]
-Name=DebugLevel
-Title=Debug level
-Type=Number
-Integer=1
-Min=0
-Max=5
-Default=0
-Tooltip=Sets the debug level for console printing - 0 will print only the basics whilst 5 will print everything
-Page=Misc
-
-[Setting]
-Name=SpeedrunMode
-Title=Speedrun Mode
-Type=TickBox
-Default=0
-Tooltip=Enables the speedrun settings viable for the leaderboards
-Page=Misc
+[SettingCondition]
+Type=Setting
+Setting=RandomItemsIncludeChars
+Value=1
+ConditionSetting=RandomItems
+Operator=EqualTo
 
-[Setting]
-Name=VerboseDebug
-Title=Verbose debug
-Type=TickBox
-Default=0
-Tooltip=If enabled, outputs all modified files to the console. Not recommended unless bug testing specifically.
-Page=Misc
+[SettingCondition]
+Type=Setting
+Setting=RandomItemsIncludeCars
+Value=1
+ConditionSetting=RandomItems
+Operator=EqualTo
 
-[Setting]
-Name=UseDebugSettings
-Title=Use debug settings
-Type=TickBox
-Default=0
-Tooltip=If enabled, allows a secondary mod to force certain parts of the randomiser.
-Page=Misc
+[SettingCondition]
+Type=Setting
+Setting=RemoveOutOfCar
+Value=1
+ConditionSetting=RandomPlayerVehicles
+Operator=EqualTo
 
 [SettingCondition]
 Type=Setting
@@ -4564,6 +4610,13 @@ Value=1
 ConditionSetting=SuperRandomDialogue
 Operator=EqualTo
 
+[SettingCondition]
+Type=Setting
+Setting=Seed
+Value=1
+ConditionSetting=IsSeeded
+Operator=EqualTo
+
 ;[SettingWarning]
 ;Setting=RandomCarSounds
 ;Operator=EqualTo

Randomiser/Resources/CustomCars.lua

@@ -70,7 +70,7 @@ if IsModEnabled("RandomiserCars") then
 						end
 					end
 				else
-					DebugPrint("No carsound.spt found for Custom Car " .. customCarName .. ".")
+					DebugPrint("No carsound.spt found for Custom Car " .. customCarName .. ".", 3)
 				end
 			end
 		end

Randomiser/Resources/CustomText.lua

@@ -82,6 +82,12 @@ for k, v in pairs(ChaosSettings) do
 end
 
 local Values = os.date("[%Y-%m-%d]") .. "\n" .. ModName .. " v" .. ModVersion .. (Settings.SpeedrunMode and " (speedrun)" or "").. (Settings.UseDebugSettings and " (debug)" or "") .. "\n" .. string.format("Settings: Gameplay: %X, Graphics: %X, Chaos: %X", GameplayN, GraphicalN, ChaosN)
+if Settings.IsSeeded then
+	Values = Values .. string.format("\nSeed: %s, Check: %s", Settings.Seed, Seed.CheckWord())
+	if ChaosN > 0 then
+		Alert("Chaos randomisations are not seeded and should be disabled for consistent races")
+	end
+end
 
 local Chunk = P3D.P3DChunk:new{Raw = ReadFile(Path)}
 local BibleIdx = Chunk:GetChunkIndex(P3D.Identifiers.Frontend_Text_Bible)