Project Refactoring #59

mzxrules · 2019-06-23T21:26:33Z

This expands on the code from #55

Split UI and business logic into separate projects "WinForms" and "MMR Lib" respectively
Changed WinForms to target .net Framework 4.8, and changed MMR Lib to target .net standard 2.0. This breaks XP support, but opens up the possibility of supporting non-Windows platforms
Rewrite MainForm.cs ui to be data driven, interfacing with the Settings object
The Settings object has been overhauled to support the data driven main form, save serialization, and seed "salting"
- MainForm settings can now be saved, as settings.json
  - Because of this, loading in a settings string has been temporarily removed
- Random is no longer initialized directly by the seed. Instead it is seeded by computing a hash of Setting's base class GenerationSettings, which stores all settings that should be used to force a new randomization
Refactor sequence randomization code to no longer use staticly defined lists
Refactor SEQ.txt to sequence.json

…ework 4.8)

…ects

…ttings saving/loading

ZoeyZolotova · 2019-06-24T23:41:50Z

mmr-lib/Enemies.cs

@@ -19,7 +19,7 @@ public class ValueSwap
        public static void ReadEnemyList()
        {
            EnemyList = new List<Enemy>();
-            string[] lines = Properties.Resources.ENEMIES.Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.None);
+            string[] lines = Resources.GetTextFile("ENEMIES.txt").Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.None);


Does this mean ENEMIES.txt (and other resource files) are now included as files instead of being part of the application? Not sure I like the idea of people fiddling with the resource files.

Yes. In general, I think most people will avoid touching them out of fear of breaking the program. I also haven't heard of it being a huge problem in OoTR, even though most releases have always distributed the entire source code because the program is coded in Python (though I also don't pay attention to the support channels at all, so I could be wrong on that).

Still, i could make it an embedded file and do some reflection magic to retrieve it

ZoeyZolotova · 2019-06-24T23:45:56Z

mmr-lib/Models/Settings/LogicMode.cs

+        Casual,
+        [Description("Glitched Logic")]
+        Glitched,
+        [Description("Vanilla Logic")]


is "Vanilla Logic" an appropriate name? the old name was "Vanilla Layout" which makes sense since none of the items are moved.

I changed it because it seemed like a consistency thing, but you're right. I think changing it to "Vanilla Item Placement" would be more descriptive.

mmr-lib/Models/Settings/LogicMode.cs

ZoeyZolotova · 2019-06-24T23:48:57Z

mmr-lib/Models/Settings/Settings.cs

+            {
+                SetField(ref useCustomItemList, value);
+
+                //Todo: enable/disable ui elements instead, then have a "validate" stage for generating settings


Is this an important todo to do?

Creating a "validate" stage right now is not super important because we only have the one gui for now, but technically with the core logic being in it's own library now, it should be more responsible in managing it's own state within the mmr lib, and not the gui.

Edit: i see the segment of code this comment is on. So the issue here is that ui wise toggling the UseCustomItemList element will cause the ui to forget the user's settings for the other options, which is unexpected and undesirable. A better way would be to instead make it so that toggling UseCustomItemList will toggle the dependent Enable properties on the UI to avoid altering the backing settings.

mmr-lib/Models/Settings/Settings.cs

mmr-lib/Templates/T4Extensions.cs

mmr-lib/Utils/SequenceUtils.cs

mmr-lib/Utils/SpoilerUtils.cs

ZoeyZolotova · 2019-06-25T00:12:15Z

winform/Forms/MainForm.Designer.cs

@@ -38,14 +38,17 @@ private void InitializeComponent()
            this.cUserItems = new System.Windows.Forms.CheckBox();
            this.tSettings = new System.Windows.Forms.TabControl();
            this.tabROMSettings = new System.Windows.Forms.TabPage();
-            this.cPatch = new System.Windows.Forms.CheckBox();
+            this.label9 = new System.Windows.Forms.Label();


Would prefer that labels have proper names.

i tried, but i'm not particularly motivated to give names to ui elements that aren't being altered programmatically.

winform/Forms/MainForm.Designer.cs

…tings deserialization

… previous purpose.

mzxrules added 27 commits June 13, 2019 00:56

Refactor program output

61b05e3

add back config files to the project files

9bf2cb8

Verify the rom earlier

9469542

zoey

60bfd0d

Move csproj to subfolder

74a66ab

Split project into MMR Lib (.net standard 2.0) and WinForm (.net fram…

8330571

…ework 4.8)

Move README into main solution folder

3766ac8

Convert SEQ.txt to sequences.json

fa07a82

Refactor Sequence manipulation code to have fewer unexpected side eff…

26e88d3

…ects

SettingsObject.cs -> Settings.cs

6a4d59b

Move settings to MMRando.Models namespace

fd74274

Rewrite MainForm to utilize databinding

147d3df

Clean-up unneeded event handlers

6b85242

Eliminate settings string, implement non-numeric seed, rudimentary se…

e4555a0

…ttings saving/loading

Tweak the manual

b2963ca

add missing auto-gen properties

d61f2a7

Add back User Logic selection

d5a8257

pull zoey

645f1fd

move settings

96e7d73

rename

bfb5a85

Update to fork

db43bc8

move into project proper

c0cae13

Fix compilation issues

f9f55d0

delete project file accidentally ported in

57183b3

zoey/dev

05e55ea

clean up more unused ui stuff

16f3f0e

pull zoey/dev

8031c08

ZoeyZolotova requested changes Jun 25, 2019

View reviewed changes

mzxrules added 2 commits June 26, 2019 11:49

Fix settings enum descriptions, resolve various zoey fixes, tweak set…

441478b

…tings deserialization

Re-Seed RNG when generating cosmetics

3cbac44

mzxrules added 8 commits June 30, 2019 10:51

Settings.ToString now outputs GenerationSettings hash, simulating the…

f312957

… previous purpose.

Fix patch file path not being updated properly

7d9a4b4

Chest Appearance Merge

2505822

Fix UI merge issues

a995b9f

merge zoey/dev

57bdb8c

Make ItemEditForm a modal dialog

2594846

merge

f94d55f

merge zoey/dev, added LogicUtils.cs

27f7a91

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Project Refactoring #59

Project Refactoring #59

mzxrules commented Jun 23, 2019 •

edited

Loading

ZoeyZolotova Jun 24, 2019

mzxrules Jun 29, 2019 •

edited

Loading

ZoeyZolotova Jun 24, 2019

mzxrules Jun 25, 2019 •

edited

Loading

ZoeyZolotova Jun 24, 2019

mzxrules Jun 29, 2019 •

edited

Loading

ZoeyZolotova Jun 25, 2019

mzxrules Jun 29, 2019

Project Refactoring #59

Are you sure you want to change the base?

Project Refactoring #59

Conversation

mzxrules commented Jun 23, 2019 • edited Loading

ZoeyZolotova Jun 24, 2019

Choose a reason for hiding this comment

mzxrules Jun 29, 2019 • edited Loading

Choose a reason for hiding this comment

ZoeyZolotova Jun 24, 2019

Choose a reason for hiding this comment

mzxrules Jun 25, 2019 • edited Loading

Choose a reason for hiding this comment

ZoeyZolotova Jun 24, 2019

Choose a reason for hiding this comment

mzxrules Jun 29, 2019 • edited Loading

Choose a reason for hiding this comment

ZoeyZolotova Jun 25, 2019

Choose a reason for hiding this comment

mzxrules Jun 29, 2019

Choose a reason for hiding this comment

mzxrules commented Jun 23, 2019 •

edited

Loading

mzxrules Jun 29, 2019 •

edited

Loading

mzxrules Jun 25, 2019 •

edited

Loading

mzxrules Jun 29, 2019 •

edited

Loading