using System; using System.Windows.Forms; using System.IO; using BizHawk.Client.Common; using BizHawk.Client.EmuHawk; using BizHawk.Emulation.Common; namespace HelloWorld { /// All of this is example code, but it's at least a little more substantiative than a simple "hello world". [ExternalTool("HelloWorld", Description = "An example of how to interact with EmuHawk")] // [ExternalToolApplicability.SingleRom(VSystemID.Raw.NES, "EA343F4E445A9050D4B4FBAC2C77D0693B1D0922")] // example of limiting tool usage (this is SMB1) [ExternalToolEmbeddedIcon("HelloWorld.icon_Hello.ico")] public partial class CustomMainForm : ToolFormBase, IExternalToolForm { /// /// RequiredServices are populated by EmuHawk at runtime. /// These remain supported, but you should only use them when there is no API that does what you want. /// [RequiredService] private IEmulator? _emu { get; set; } [RequiredService] private IMemoryDomains? _memoryDomains { get; set; } /// /// RequiredApis are populated by EmuHawk at runtime. /// You can have props for any subset of the available APIs, or use an to get them all at once. /// [RequiredApi] private IEmulationApi? _emuApi { get; set; } /// /// can be used as a shorthand for accessing the various APIs, more like the Lua syntax. /// public ApiContainer? _apiContainer { get; set; } private ApiContainer APIs => _apiContainer!; /// /// An example of a hack. Hacks should be your last resort because they're prone to break with new releases. /// private Config GlobalConfig => (_emuApi as EmulationApi ?? throw new Exception("required API wasn't fulfilled")).ForbiddenConfigReference; private WatchList? _watches; private WatchList Watches { get { WatchList CreateWatches() { var w = new WatchList(_memoryDomains, _emu?.SystemId ?? string.Empty); w.AddRange(new[] { Watch.GenerateWatch(_memoryDomains?.MainMemory, 0x40, WatchSize.Byte, WatchDisplayType.Hex, true), Watch.GenerateWatch(_memoryDomains?.MainMemory, 0x50, WatchSize.Word, WatchDisplayType.Unsigned, true), Watch.GenerateWatch(_memoryDomains?.MainMemory, 0x60, WatchSize.DWord, WatchDisplayType.Hex, true) }); return w; } _watches ??= CreateWatches(); return _watches; } } protected override string WindowTitleStatic => "HelloWorld"; public CustomMainForm() { InitializeComponent(); label_GameHash.Click += label_GameHash_Click; Closing += (sender, args) => APIs.EmuClient.SetClientExtraPadding(0, 0, 0, 0); Load += (_, _) => { APIs.EmuClient.BeforeQuickSave += (_, e) => { if (e.Slot != 0) return; // only take effect on slot 0 var basePath = Path.Combine(GlobalConfig.PathEntries.SaveStateAbsolutePath(APIs.Emulation.GetSystemId()), "Test"); if (!Directory.Exists(basePath)) Directory.CreateDirectory(basePath); APIs.EmuClient.SaveState(Path.Combine(basePath, e.Name)); e.Handled = true; }; APIs.EmuClient.BeforeQuickLoad += (_, e) => { if (e.Slot != 0) return; // only take effect on slot 0 var basePath = Path.Combine(GlobalConfig.PathEntries.SaveStateAbsolutePath(APIs.Emulation.GetSystemId()), "Test"); APIs.EmuClient.LoadState(Path.Combine(basePath, e.Name)); e.Handled = true; }; }; } /// This is called once when the form is opened, and every time a new movie session starts. public override void Restart() { APIs.EmuClient.SetClientExtraPadding(50, 50); var gi = APIs.Emulation.GetGameInfo(); if (!string.IsNullOrEmpty(gi?.Name)) { Watches.RefreshDomains(_memoryDomains, GlobalConfig.RamWatchDefinePrevious); label_Game.Text = $"You're playing {gi!.Name}"; label_GameHash.Text = $"Hash: {gi.Hash}"; } else { label_Game.Text = "You're playing... nothing"; label_GameHash.Text = string.Empty; } } public override void UpdateValues(ToolFormUpdateType type) { if (!(type == ToolFormUpdateType.PreFrame || type == ToolFormUpdateType.FastPreFrame) || string.IsNullOrEmpty(APIs.Emulation.GetGameInfo()?.Name) || Watches.Count < 3) { return; } Watches.UpdateValues(GlobalConfig.RamWatchDefinePrevious); label_Watch1.Text = $"First watch ({Watches[0].AddressString}) current value: {Watches[0].ValueString}"; label_Watch2.Text = $"Second watch ({Watches[1].AddressString}) current value: {Watches[1].ValueString}"; label_Watch3.Text = $"Third watch ({Watches[2].AddressString}) current value: {Watches[2].ValueString}"; } private void button1_Click(object sender, EventArgs e) => APIs.EmuClient.DoFrameAdvance(); private void label_GameHash_Click(object sender, EventArgs e) => Clipboard.SetText(APIs.Emulation.GetGameInfo()!.Hash); private void loadstate_Click(object sender, EventArgs e) { if (string.IsNullOrWhiteSpace(savestateName.Text)) return; APIs.EmuClient.LoadState(savestateName.Text); #if false static void Test(BinaryReader r) { var b = new System.Drawing.Bitmap(r.BaseStream); } BinaryStateLoader.LoadAndDetect($"{savestateName.Text}.State").GetLump(BinaryStateLump.Framebuffer, false, Test); #endif } private void saveState_Click(object sender, EventArgs e) { if (!string.IsNullOrWhiteSpace(savestateName.Text)) APIs.EmuClient.SaveState(savestateName.Text); } } }