0.5.0 (#23)

- Fixed example items loaded when not enabled #22
- Moved modded save data to a separate JSON file #21
- Fixed disaster button not working
- Added a mod menu for users to edit configs with.
- Revamped configs for mod menu
- New mod maker features
    - Custom bait items
    - Conversation POIs (Inspect, Explosive (WIP), and Auto Move)
    - Harvest Zones (for getting fish with net or crabs with pot)
    - Abilities
    - World Events
    - Dialogue and Characters
    - Shops
    - Dock Data and Dock POIs
        - Destinations (Character, Market, Shipyard, Upgrade, and Constructable)
    - Quests and Steps (WIP)
    - Quest Grid Configs
    - Upgrades (WIP)
        - Hulls
        - Slots
    - Recipes
        - Items
        - Abilities
        - Hulls (WIP)
        - Buildings
    - Boat Flags and Paints
- Separated durable items into durable and thawable.
- Now possible to grab modded assets with code.
- Fixed bug where if a mod was using `ApplyPatches` it would make the game get stuck on black screen when starting up.

.editorconfig

@@ -0,0 +1,210 @@
+# editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Default settings:
+# A newline ending every file
+# Use 4 spaces as indentation
+[*]
+insert_final_newline = false
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[project.json]
+indent_size = 2
+
+# Generated code
+[*{_AssemblyInfo.cs,.notsupported.cs}]
+generated_code = true
+
+# C# files
+[*.cs]
+# Diagnostics
+dotnet_diagnostic.CS0649.severity = suggestion
+dotnet_diagnostic.CS1587.severity = suggestion
+dotnet_diagnostic.CS8600.severity = suggestion
+dotnet_diagnostic.CS8601.severity = suggestion
+dotnet_diagnostic.CS8602.severity = suggestion
+dotnet_diagnostic.CS8603.severity = suggestion
+dotnet_diagnostic.CS8604.severity = suggestion
+dotnet_diagnostic.CS8618.severity = suggestion
+dotnet_diagnostic.CS8619.severity = suggestion
+dotnet_diagnostic.CS8620.severity = suggestion
+dotnet_diagnostic.CS8625.severity = suggestion
+
+# Style
+dotnet_diagnostic.IDE1006.severity = suggestion
+
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = one_less_than_current
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+# avoid this. unless absolutely necessary
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+
+# Types: use keywords instead of BCL types, and permit var only when the type is clear
+csharp_style_var_for_built_in_types = false:suggestion
+csharp_style_var_when_type_is_apparent = false:none
+csharp_style_var_elsewhere = false:suggestion
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+# name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds   = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+# internal fields should be camelCase
+dotnet_naming_rule.camel_case_for_internal_fields.severity = suggestion
+dotnet_naming_rule.camel_case_for_internal_fields.symbols  = internal_fields
+dotnet_naming_rule.camel_case_for_internal_fields.style    = camel_case_style
+dotnet_naming_symbols.internal_fields.applicable_kinds = field
+dotnet_naming_symbols.internal_fields.applicable_accessibilities = internal
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+# private static fields should have _ prefix
+dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
+dotnet_naming_rule.static_fields_should_have_prefix.symbols  = static_fields
+dotnet_naming_rule.static_fields_should_have_prefix.style    = static_prefix_style
+dotnet_naming_symbols.static_fields.applicable_kinds   = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_symbols.static_fields.applicable_accessibilities = private, private_protected
+dotnet_naming_style.static_prefix_style.required_prefix = _
+dotnet_naming_style.static_prefix_style.capitalization = camel_case
+
+# private fields should be _camelCase
+dotnet_naming_rule.camel_case_for_private_fields.severity = suggestion
+dotnet_naming_rule.camel_case_for_private_fields.symbols  = private_fields
+dotnet_naming_rule.camel_case_for_private_fields.style    = camel_case_underscore_style
+dotnet_naming_symbols.private_fields.applicable_kinds = field
+dotnet_naming_symbols.private_fields.applicable_accessibilities = private
+dotnet_naming_style.camel_case_underscore_style.required_prefix = _
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+# Code style defaults
+csharp_style_namespace_declarations = file_scoped:warning
+csharp_using_directive_placement = outside_namespace:suggestion
+dotnet_sort_system_directives_first = true
+csharp_prefer_braces = true:silent
+csharp_preserve_single_line_blocks = true:none
+csharp_preserve_single_line_statements = false:none
+csharp_prefer_static_local_function = true:suggestion
+csharp_prefer_simple_using_statement = false:none
+csharp_style_prefer_switch_expression = true:suggestion
+dotnet_style_readonly_field = true:suggestion
+
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_methods = true:silent
+csharp_style_expression_bodied_constructors = true:silent
+csharp_style_expression_bodied_operators = true:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = true:silent
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Other features
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = false:none
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = do_not_ignore
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Xml project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
+indent_size = 2
+
+[*.{csproj,vbproj,proj,nativeproj,locproj}]
+charset = utf-8
+
+# Xml build files
+[*.builds]
+indent_size = 2
+
+# Xml files
+[*.{xml,stylecop,resx,ruleset}]
+indent_size = 2
+
+# Xml config files
+[*.{props,targets,config,nuspec}]
+indent_size = 2
+
+# YAML config files
+[*.{yml,yaml}]
+indent_size = 2
+
+# Shell scripts
+[*.sh]
+end_of_line = lf
+[*.{cmd,bat}]
+end_of_line = crlf
+

Winch.Examples/DisasterButton/Assets/Localization/en.json

@@ -1,3 +1,5 @@
 {
-  "notification.disaster-button": "A sudden chill runs down your spine."
+	"notification.disaster-button": "A sudden chill runs down your spine.",
+	"disasterbutton.key.title": "Disaster Button Key",
+	"disasterbutton.key.tooltip": "The name of the key you should press to trigger a random world event"
 }

Winch.Examples/DisasterButton/DisasterButton.cs

@@ -2,31 +2,31 @@
 using Winch.Config;
 using Winch.Core;
 
-namespace DisasterButton
+namespace DisasterButton;
+
+public class DisasterButton : MonoBehaviour
 {
-    class DisasterButton : MonoBehaviour
-    {
-        private static System.Random rnd = new System.Random();
-        private static string DisasterKey = ModConfig.GetProperty("DisasterButton", "DisasterButtonKey", "delete");
+    private static System.Random rnd = new System.Random();
+    private static ModConfig Config => ModConfig.GetConfig();
+    private static string DisasterKey => Config.GetProperty<string>("DisasterButtonKey");
 
-        private void Update()
-        {
-            if(Input.GetKeyDown(DisasterKey))
-                OnPress();
-        }
+    public void Update()
+    {
+        if(Input.GetKeyDown(DisasterKey))
+            OnPress();
+    }
 
-        private void OnPress()
-        {
-            if (GameManager.Instance == null || GameManager.Instance.DataLoader == null || GameManager.Instance.WorldEventManager == null)
-                return;
+    private void OnPress()
+    {
+        if (GameManager.Instance == null || GameManager.Instance.DataLoader == null || GameManager.Instance.WorldEventManager == null)
+            return;
 
-            WinchCore.Log.Debug("DisasterButton initialized.");
-            int index = rnd.Next(GameManager.Instance.DataLoader.allWorldEvents.Count);
-            WorldEventData worldEvent = GameManager.Instance.DataLoader.allWorldEvents[index];
-            WinchCore.Log.Debug($"Spawning event No. {index}: {worldEvent.name}");
-            GameManager.Instance.WorldEventManager.DoEvent(worldEvent);
+        WinchCore.Log.Debug("DisasterButton initialized.");
+        int index = rnd.Next(GameManager.Instance.DataLoader.allWorldEvents.Count);
+        WorldEventData worldEvent = GameManager.Instance.DataLoader.allWorldEvents[index];
+        WinchCore.Log.Debug($"Spawning event No. {index}: {worldEvent.name}");
+        GameManager.Instance.WorldEventManager.DoEvent(worldEvent);
 
-            GameManager.Instance.UI.ShowNotificationWithColor(NotificationType.SPOOKY_EVENT, "notification.disaster-button", GameManager.Instance.LanguageManager.GetColorCode(DredgeColorTypeEnum.CRITICAL));
-        }
+        GameManager.Instance.UI.ShowNotificationWithColor(NotificationType.SPOOKY_EVENT, "notification.disaster-button", GameManager.Instance.LanguageManager.GetColorCode(DredgeColorTypeEnum.CRITICAL));
     }
-}
+}

Winch.Examples/DisasterButton/DisasterButton.csproj

@@ -1,16 +1,15 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
 		<TargetFramework>net48</TargetFramework>
+		<LangVersion>latest</LangVersion>
+		<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 		<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
 		<AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
 		<CopyLocalLockFileAssemblies>false</CopyLocalLockFileAssemblies>
-	</PropertyGroup>
-
-	<PropertyGroup>
-		<DebugType>none</DebugType>
+		<DebugType>portable</DebugType>
 		<OutputPath>./bin</OutputPath>
-		<AssemblyVersion>1.0.*</AssemblyVersion>
+		<VersionPrefix>2.0.0</VersionPrefix>
 		<Deterministic>False</Deterministic>
 	</PropertyGroup>
 
@@ -25,10 +24,6 @@
 		</ProjectReference>
 	</ItemGroup>
 
-	<ItemGroup>
-		<PackageReference Include="DredgeGameLibs" Version="1.4.2" />
-	</ItemGroup>
-
 	<ItemGroup>
 		<None Include="DisasterButton.csproj.user" />
 		<None Update="Assets\Localization\de.json">
@@ -37,6 +32,9 @@
 		<None Update="Assets\Localization\en.json">
 			<CopyToOutputDirectory>Always</CopyToOutputDirectory>
 		</None>
+		<None Update="default_config.json">
+		  <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+		</None>
 		<None Update="mod_meta.json">
 			<CopyToOutputDirectory>Always</CopyToOutputDirectory>
 		</None>

Winch.Examples/DisasterButton/Loader.cs

@@ -1,14 +1,11 @@
 using UnityEngine;
 
-namespace DisasterButton
+namespace DisasterButton;
+
+public class Loader
 {
-    public class Loader
+    public static void Initialize()
     {
-        public static void Initialize()
-        {
-            GameObject gameObject = new GameObject();
-            gameObject.AddComponent<DisasterButton>();
-            GameObject.DontDestroyOnLoad(gameObject);
-        }
+        new GameObject("DisasterButton", typeof(DisasterButton)).DontDestroyOnLoad();
     }
-}
+}

Winch.Examples/DisasterButton/default_config.json

@@ -0,0 +1,8 @@
+{
+	"DisasterButtonKey": {
+		"type": "text",
+		"title": "disasterbutton.key.title",
+		"tooltip": "disasterbutton.key.tooltip",
+		"value": "delete"
+	}
+}

Winch.Examples/DisasterButton/mod_meta.json

@@ -2,11 +2,8 @@
 	"Name": "Disaster Button",
 	"Author": "Hacktix",
 	"ModGUID": "hacktix.disasterbutton",
-	"Version": "1.0",
+	"Version": "2.0.0",
 	"ModAssembly": "DisasterButton.dll",
 	"Entrypoint": "DisasterButton.Loader/Initialize",
-	"DefaultConfig": {
-		"DisasterButtonKey": "delete"
-	},
-	"MinWinchVersion": "alpha-1.0"
+	"MinWinchVersion": "0.5.0"
 }

Winch.Examples/ExampleItems/Assets/Abilities/exampleitems.testability.json

@@ -0,0 +1,8 @@
+{
+    "autoUnlock": false,
+    "nameKey": "exampleitems.testability.name",
+    "descriptionKey": "exampleitems.testability.desc",
+    "shortDescriptionKey": "exampleitems.testability.shortDesc",
+    "icon": "exampleitems.testability",
+    "persistAbilityToggle": true
+}

Winch.Examples/ExampleItems/Assets/Boat/Flags/exampleitems.flag.json

@@ -0,0 +1,5 @@
+{
+    "flagItem": "exampleitems.flag",
+    "flagTexture": "exampleitems.flagmaterial",
+    "localizedNameKey": "exampleitems.flag.option"
+}

Winch.Examples/ExampleItems/Assets/Boat/Paints/exampleitems.color.json

@@ -0,0 +1,10 @@
+{
+    "color": {
+        "r": 255,
+        "g": 255,
+        "b": 255,
+        "a": 255
+    },
+    "localizedNameKey": "exampleitems.color.option",
+    "questGridConfig": "exampleitems.color.crabs"
+}

Winch.Examples/ExampleItems/Assets/Buildings/exampleitems.constructable.tier1.json

@@ -0,0 +1,3 @@
+{
+    "tierId": "EXAMPLE_TIER_1"
+}