Merge pull request #163 from Entroper/dev

Merge dev to master (2.2.0)

Author: Entroper

.editorconfig

@@ -4,16 +4,16 @@ root = true
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[*.{cs,xaml}]
+[*.{cs,xaml,cshtml}]
 indent_size = 4
 indent_style = tab
 end_of_line = crlf
 
-[*.{config,csproj,yml,yaml}]
+[*.{csproj,yml,yaml}]
 indent_size = 2
 indent_style = space
 
-[*.{js,cshtml}]
+[*.{js}]
 indent_size = 4
 indent_style = tab
 end_of_line = lf

.gitignore

@@ -234,3 +234,6 @@ _Pvt_Extensions
 
 # FAKE - F# Make
 .fake/
+
+# ROM files -- never check these in
+*.nes

FF1Lib/BugFixes.cs

@@ -84,7 +84,7 @@ public void FixBBAbsorbBug()
 			PutInBank(0x0B, 0x9966, Blob.FromHex("2046D860"));
 			PutInBank(0x1F, 0xD846, CreateLongJumpTableEntry(0x0F, 0x8800));
 		}
-
+
 		public void FixEnemyElementalResistances()
 		{
 			// make XFER and other elemental resistance changing spells affect enemies
@@ -97,7 +97,7 @@ public void FixEnemyElementalResistances()
 			// move 3 byes from previous subroutine and save elemental resistance of the enemy
 			Put(0x336B5, Blob.FromHex("C89190AD7768A01291906000000000000000")); // extra room at the end for new code
 		}
-
+
 		public void FixEnemyAOESpells()
 		{
 			// Remove comparison and branch on equal which skips the caster when casting aoe spells

FF1Lib/EnemyFormations.cs

@@ -6,13 +6,22 @@ namespace FF1Lib
 {
 	public partial class FF1Rom : NesRom
 	{
+		public enum FinalFormation
+		{
+			WarMECHsAndFriends,
+			KaryAndTiamat,
+			TheFundead,
+			TimeLoop,
+		};
+
 		private const int FormationsOffset = 0x2C400;
 		private const int FormationSize = 16;
 
-		private const int FormationCount = 128;            // Total formations
-		private const int NormalFormationCount = 115;      // Number of formations before all the boss encounters.
-		private const int BossFormationCount = 13;         // Lichx2, Karyx2, Krakenx2, Tiamatx2, Chaos, Vampire, Astos, Pirates, Garland
-		private const int VanillaUnrunnableCount = 13;     // 13 of the Vanilla normal formations are unrunnable.
+		private const int FormationCount = 128;           // Total formations
+		private const int NormalFormationCount = 115;     // Number of formations before all the boss encounters.
+		private const int BossFormationCount = 13;        // Lichx2, Karyx2, Krakenx2, Tiamatx2, Chaos, Vampire, Astos, Pirates, Garland
+		private const int VanillaUnrunnableCount = 13;    // 13 of the Vanilla normal formations are unrunnable.
+		private const int ChaosFormationIndex = 123;      // Index of Chaos battle that preceeds The End
 
 		// Formation Data Offsets ripped straight from Disch's variables.inc
 		private const byte TypeOffset = 0x00;             // battle type (high 4 bits)
@@ -53,6 +62,63 @@ public void ShuffleSurpriseBonus(MT19337 rng)
 			formations = formations.Zip(chances, (formation, chance) => { formation[SurpriseOffset] = chance; return formation; }).ToList();
 			Put(FormationsOffset, formations.SelectMany(formation => formation.ToBytes()).ToArray());
 		}
+
+		public void TransformFinalFormation(FinalFormation formation)
+		{
+			Blob finalBattle = Get(FormationsOffset + ChaosFormationIndex * FormationSize, FormationSize);
+
+			switch (formation)
+			{
+				case FinalFormation.WarMECHsAndFriends:
+					finalBattle[TypeOffset] = 0x2C;         // Big/Small Enemy mix, and the Astos/Madpony/Badman/WarMECH patterns
+					finalBattle[GFXOffset] = 0x03;          // WarMECH Badman N/A N/A
+					finalBattle[IDsOffset + 0] = 0x76;      // WarMECH (battle stats, etc)
+					finalBattle[IDsOffset + 1] = 0x70;      // EvilMan
+					finalBattle[QuantityOffset + 0] = 0x22;
+					finalBattle[QuantityOffset + 1] = 0x66;
+					finalBattle[PalettesOffset + 0] = 0x2F;
+					finalBattle[PalettesOffset + 1] = 0x17;
+					finalBattle[PaletteAsignmentOffset] = 0x41; // Palette Assignment in top nibble, 1 in bottom for unrunnable.
+					break;
+				case FinalFormation.KaryAndTiamat:
+					finalBattle[TypeOffset] = 0x2B;         // Big/Small Enemy mix, and the Dragon2 pattern
+					finalBattle[GFXOffset] = 0x05;          // Dragon Dragon N/A N/A
+					finalBattle[IDsOffset + 0] = 0x7A;      // Kary2
+					finalBattle[IDsOffset + 1] = 0x7E;      // Tiamat2
+					finalBattle[QuantityOffset + 0] = 0x11;
+					finalBattle[QuantityOffset + 1] = 0x11;
+					finalBattle[PalettesOffset + 0] = 0x08;
+					finalBattle[PalettesOffset + 1] = 0x0A;
+					finalBattle[PaletteAsignmentOffset] = 0x41; // Palette Assignment in top nibble, 1 in bottom for unrunnable.
+					break;
+				case FinalFormation.TheFundead:
+					finalBattle[TypeOffset] = 0x24;         // Eye pattern
+					finalBattle[GFXOffset] = 0x0B;          // Eye / Geist
+					finalBattle[IDsOffset + 0] = 0x78;      // Lich2
+					finalBattle[IDsOffset + 1] = 0x33;      // Phantom
+					finalBattle[QuantityOffset + 0] = 0x22;
+					finalBattle[QuantityOffset + 1] = 0x44;
+					finalBattle[PalettesOffset + 0] = 0x03;
+					finalBattle[PalettesOffset + 1] = 0x17;
+					finalBattle[PaletteAsignmentOffset] = 0x41; // Palette Assignment in top nibble, 1 in bottom for unrunnable.
+					break;
+				case FinalFormation.TimeLoop:
+					finalBattle[TypeOffset] = 0x0B;         // 9Small + Garland pattern
+					finalBattle[GFXOffset] = 0x2A;          // Garland Garland Garland N/A
+					finalBattle[IDsOffset + 0] = 0x69;      // Garland
+					finalBattle[IDsOffset + 1] = 0x7F;      // Chaos
+					finalBattle[IDsOffset + 2] = 0x69;      // Garland
+					finalBattle[QuantityOffset + 0] = 0x08;
+					finalBattle[QuantityOffset + 1] = 0x11;
+					finalBattle[QuantityOffset + 2] = 0x88;
+					finalBattle[PalettesOffset + 0] = 0x00;
+					finalBattle[PalettesOffset + 1] = 0x00;
+					finalBattle[PaletteAsignmentOffset] = 0x01; // Palette Assignment in top nibble, 1 in bottom for unrunnable.
+					break;
+			}
+
+			Put(FormationsOffset + ChaosFormationIndex * FormationSize, finalBattle);
+		}
 	}
 
 }

FF1Lib/FF1Lib.csproj

@@ -14,13 +14,41 @@
     <TreatSpecificWarningsAsErrors />
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Remove="presets\beginner.json" />
+    <None Remove="presets\default.json" />
+    <None Remove="presets\full-npc.json" />
+    <None Remove="presets\improved-vanilla.json" />
+    <None Remove="presets\normal-npc.json" />
+    <None Remove="presets\tournament.json" />
+  </ItemGroup>
+
   <ItemGroup>
     <Content Include="DTETable.txt">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
+    <Content Include="presets\beginner.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <Content Include="presets\default.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <Content Include="presets\full-npc.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <Content Include="presets\improved-vanilla.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <Content Include="presets\normal-npc.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <Content Include="presets\tournament.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Newtonsoft.Json" Version="11.0.2" />
     <PackageReference Include="RomUtilities" Version="2.2.0" />
   </ItemGroup>
 

FF1Lib/FF1Rom.cs

@@ -12,7 +12,7 @@ namespace FF1Lib
 	// ReSharper disable once InconsistentNaming
 	public partial class FF1Rom : NesRom
 	{
-		public const string Version = "2.1.0";
+		public const string Version = "2.2.0";
 
 		public const int RngOffset = 0x7F100;
 		public const int RngSize = 256;
@@ -83,17 +83,20 @@ public void Randomize(Blob seed, Flags flags)
 			var rng = new MT19337(BitConverter.ToUInt32(seed, 0));
 
 			UpgradeToMMC3();
+			MakeSpaceIn1F();
 			EasterEggs();
 			DynamicWindowColor();
 			PermanentCaravan();
+			ShiftEarthOrbDown();
+
 			var overworldMap = new OverworldMap(this, flags);
 			var maps = ReadMaps();
 			var incentivesData = new IncentiveData(rng, flags, overworldMap.MapLocationRequirements);
 			var shopItemLocation = ItemLocations.CaravanItemShop1;
-			
+
 			if (flags.ModernBattlefield)
 			{
-				SetBattleUI(true);
+				EnableModernBattlefield();
 			}
 
 			if (flags.TitansTrove)
@@ -112,6 +115,11 @@ public void Randomize(Blob seed, Flags flags)
 				FixEnemyAOESpells();
 			}
 
+			if (flags.ItemMagic)
+			{
+				ShuffleItemMagic(rng);
+			}
+
 			if (flags.Shops)
 			{
 				var excludeItemsFromRandomShops = flags.Treasures
@@ -125,6 +133,16 @@ public void Randomize(Blob seed, Flags flags)
 				ShuffleTreasures(rng, flags, incentivesData, shopItemLocation, overworldMap.MapLocationRequirements);
 			}
 
+			if (flags.Treasures && flags.ShardHunt && !flags.ChaosRush)
+			{
+				EnableShardHunt(rng, flags.ExtraShards ? rng.Between(24, 30) : 16, maps, flags.NPCItems);
+			}
+
+			if (flags.TransformFinalFormation)
+			{
+				TransformFinalFormation((FinalFormation)rng.Between(0, Enum.GetValues(typeof(FinalFormation)).Length - 1));
+			}
+
 			if (flags.MagicShops)
 			{
 				ShuffleMagicShops(rng);
@@ -241,7 +259,7 @@ public void Randomize(Blob seed, Flags flags)
 				EnableBuyTen();
 			}
 
-			if (flags.EnemyFormationsUnrunnable || flags.WaitWhenUnrunnable)
+			if (flags.WaitWhenUnrunnable)
 			{
 				ChangeUnrunnableRunToWait();
 			}
@@ -276,6 +294,11 @@ public void Randomize(Blob seed, Flags flags)
 				FixBBAbsorbBug();
 			}
 
+			if (flags.ImproveTurnOrderRandomization)
+			{
+				ImproveTurnOrderRandomization(rng);
+			}
+
 			if (flags.EnemyElementalResistancesBug)
 			{
 				FixEnemyElementalResistances();
@@ -440,6 +463,23 @@ private void ExtraTrackingAndInitCode()
 			// Softlock fix
 			Put(0x7C956, Blob.FromHex("A90F2003FE4C008B"));
 			PutInBank(0x0F, 0x8B00, Blob.FromHex("BAE030B01E8A8D1001A9F4AAA9FBA8BD0001990001CA88E010D0F4AD1001186907AA9AA52948A52A48A50D48A54848A549484C65C9"));
+
+			// Change INT to MDEF in the Status screen
+			Put(0x388F5, Blob.FromHex("968D8E8F"));
+			Data[0x38DED] = 0x25;
+		}
+
+		public void MakeSpaceIn1F()
+		{
+			// 54 bytes starting at 0xC265 in bank 1F, ROM offset: 7C275
+			// This removes the code for the minigame on the ship, and moves the prior code around too
+			PutInBank(0x1F, 0xC244, Blob.FromHex("F003C6476020C2D7A520290FD049A524F00EA9008524A542C908F074C901F0B160EAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEA"));
+			// 15 bytes starting at 0xC8A4 in bank 1F, ROM offset: 7C8B4
+			// This removes the routine that give a reward for beating the minigame, no need for a reward without the minigame 
+			PutInBank(0x1F, 0xC8A4, Blob.FromHex("EAEAEAEAEAEAEAEAEAEAEAEAEAEAEA"));
+			// 28 byte starting at 0xCFCB in bank 1F, ROM offset: 7CFDB
+			// This removes the AssertNasirCRC routine, which we were skipping anyways, no point in keeping uncalled routines
+			PutInBank(0x1F, 0xCFCB, Blob.FromHex("EAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEAEA"));
 		}
 
 		public override bool Validate()

FF1Lib/FF1Text.cs

@@ -122,7 +122,7 @@ public static Blob TextToStory(string[] lines)
 			List<Blob> buffers = new List<Blob>();
 			for (int i = 0; i < lines.Length; ++i)
 			{
-				buffers.Add(TextToBytes(lines[i], useDTE: false, delimiter: Delimiter.Line));
+				buffers.Add(TextToBytes(lines[i], useDTE: true, delimiter: Delimiter.Line));
 			}
 
 			if (buffers.Count != 0)

FF1Lib/Flags.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Newtonsoft.Json;
 
 namespace FF1Lib
 {
@@ -39,14 +40,20 @@ public class Flags : IIncentiveFlags, IMapEditFlags
 		public bool RandomLoot { get; set; } // Planned 2.x feature - random non-quest-item treasures
 
 		[FlagString(Character = ALT_GAME_MODE, FlagBit = 1)]
-		public bool OrbHunt { get; set; } // Planned 2.1 or 2.2 features - shard hunt
+		public bool ShardHunt { get; set; }
+		[FlagString(Character = ALT_GAME_MODE, FlagBit = 2)]
+		public bool ExtraShards { get; set; }
+		[FlagString(Character = ALT_GAME_MODE, FlagBit = 4)]
+		public bool TransformFinalFormation { get; set; }
 
 		[FlagString(Character = MAGIC, FlagBit = 1)]
 		public bool MagicShops { get; set; }
 		[FlagString(Character = MAGIC, FlagBit = 2)]
 		public bool MagicLevels { get; set; }
 		[FlagString(Character = MAGIC, FlagBit = 4)]
 		public bool MagicPermissions { get; set; }
+		[FlagString(Character = MAGIC, FlagBit = 8)]
+		public bool ItemMagic { get; set; }
 
 		[FlagString(Character = ENCOUNTERS, FlagBit = 1)]
 		public bool Rng { get; set; }
@@ -190,6 +197,8 @@ public class Flags : IIncentiveFlags, IMapEditFlags
 		public bool EnemySpellsTargetingAllies { get; set; }
 		[FlagString(Character = ENEMY_BUG_FIXES, FlagBit = 4)]
 		public bool EnemyElementalResistancesBug { get; set; }
+		[FlagString(Character = ENEMY_BUG_FIXES, FlagBit = 8)]
+		public bool ImproveTurnOrderRandomization { get; set; }
 
 		[FlagString(Character = 17, Multiplier = 0.1)]
 		public double EnemyScaleFactor { get; set; }
@@ -201,7 +210,7 @@ public class Flags : IIncentiveFlags, IMapEditFlags
 		public int ExpBonus { get; set; }
 		[FlagString(Character = 21, Multiplier = 1)]
 		public int ForcedPartyMembers { get; set; }
-		
+
 		public bool ModernBattlefield { get; set; }
 		public bool FunEnemyNames { get; set; }
 		public bool PaletteSwap { get; set; }
@@ -266,11 +275,6 @@ public static Dictionary<string, FlagStringAttribute> GetFlagStringAttributes()
 								.FirstOrDefault() as FlagStringAttribute);
 		}
 
-		public string GetString()
-		{
-			return EncodeFlagsText(this);
-		}
-
 		// ! and % are printable in FF, + and / are not.
 		private const string base64CharString = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-!";
 		public static string EncodeFlagsText(Flags flags)
@@ -308,12 +312,14 @@ public static Flags DecodeFlagsText(string text)
 			foreach (var inputChar in inputCharacters)
 			{
 				var charFlagValue = base64CharString.IndexOf(inputChar);
-				var flagAttributesForChar = flagAttributes[index];
+				var flagAttributesForChar = flagAttributes[index++];
 				if (flagAttributesForChar.Any(x => x.Value.FlagBit < 1))
 				{
 					var multiplierAttribute = flagAttributesForChar.First(x => x.Value.FlagBit < 1);
+
 					var outputValue = charFlagValue * multiplierAttribute.Value.Multiplier;
-					typeof(Flags).GetProperty(multiplierAttribute.Key).SetValue(result, outputValue);
+					var property = typeof(Flags).GetProperty(multiplierAttribute.Key);
+					property.SetValue(result, Convert.ChangeType(outputValue, property.PropertyType));
 					continue;
 				}
 				foreach (var flagAttribute in flagAttributesForChar)
@@ -324,6 +330,14 @@ public static Flags DecodeFlagsText(string text)
 			}
 			return result;
 		}
+
+		private class Preset
+		{
+			public string Name { get; set; }
+			public Flags Flags { get; set; }
+		}
+
+		public static Flags FromJson(string json) => JsonConvert.DeserializeObject<Preset>(json).Flags;
 	}
 
 	public class FlagStringAttribute : Attribute
@@ -346,7 +360,6 @@ public string ToVueComputedPropertyString()
 			$"set:function(newValue){{while(this.flagString.length <= {Character})this.flagString += base64Chars[0];" +
 			$"var scaledValue = (newValue / {Multiplier}).toFixed() % base64Chars.length;" +
 			$"this.flagString = this.flagString.substr(0,{Character}) + base64Chars[scaledValue] + this.flagString.substr({Character + 1});}} }}";
-
 		}
 	}
 }