Rename and prepare release (#17)

* rename tool, make palette easier

* update readmen

* remove last vestigaes of *tool nomenclature

* rename folders, namespaces, fix many code quality hints

* remove some commented out code, other cleanup

* add array length support to object annotator

* cleanup some objects

* start fixing unit tests

* get object loading unit tests into a passing and usable state

* start adding unit test for saving

* add .editorconfig

* fix track saving incorrectly

* fix objdata directories not saving

* fix building object saving

* update readme

* cleanup resources, add version.txt

* remove useless variable

Author: LeftofZen

.editorconfig

@@ -1,10 +1,10 @@
-namespace OpenLocoTool
+namespace OpenLoco.ObjectEditor
 {
 	public class Annotation
 	{
-		private int start = 0;
-		private int end = 0;
-		private int length = 0;
+		private int start;
+		private int end;
+		private int length;
 
 		public Annotation(string name, Annotation? parent, int start, int length)
 		{

OpenLocoTool/Annotation.cs renamed to Core/Annotation.cs

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<OutputType>Library</OutputType>
+		<TargetFramework>net8.0</TargetFramework>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<Nullable>enable</Nullable>
+		<AnalysisLevel>latest</AnalysisLevel>
+		<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="Zenith.Core" Version="1.0.20" />
+	</ItemGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\Shared\Shared.csproj" />
+	</ItemGroup>
+
+</Project>

Core/Core.csproj

@@ -1,14 +1,14 @@
-using System.Reflection;
-using OpenLocoTool.Headers;
+using OpenLoco.ObjectEditor.Data;
+using System.Reflection;
 
-namespace OpenLocoTool.DatFileParsing
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	public static class AttributeHelper
 	{
 		public static T? Get<T>(PropertyInfo p) where T : Attribute
 		{
-			var attrs = p.GetCustomAttributes(typeof(T), inherit: false);
-			return attrs.Length == 1 ? attrs[0] as T : null;
+			var attributes = p.GetCustomAttributes(typeof(T), inherit: false);
+			return attributes.Length == 1 ? attributes[0] as T : null;
 		}
 
 		public static T? Get<T>(Type t) where T : Attribute

OpenLocoTool/DatFileParsing/AttributeHelper.cs renamed to Core/DatFileParsing/AttributeHelper.cs

@@ -1,4 +1,6 @@
-namespace OpenLocoTool.DatFileParsing
+using Zenith.Core;
+
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	public static class ByteHelpers
 	{
@@ -23,10 +25,7 @@ public static int GetObjectSize(Type type)
 				size = sizeAttr.Size;
 			}
 
-			if (size == 0)
-			{
-				throw new ArgumentException("unknown primitive type with no size");
-			}
+			Verify.Positive(size, message: $"type {type.Name} has no size data associated with it");
 
 			return size;
 		}

OpenLocoTool/DatFileParsing/ByteHelpers.cs renamed to Core/DatFileParsing/ByteHelpers.cs

@@ -1,4 +1,6 @@
-namespace OpenLocoTool.DatFileParsing
+using Zenith.Core;
+
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	public static class ByteReader
 	{
@@ -41,7 +43,7 @@ public static object ReadT(ReadOnlySpan<byte> data, Type t, int offset, int arrL
 
 			if (t.IsArray)
 			{
-				var elementType = t.GetElementType();
+				var elementType = t.GetElementType() ?? throw new ArgumentNullException(t.Name);
 				var size = ByteHelpers.GetObjectSize(elementType);
 
 				var arr = Array.CreateInstance(elementType, arrLength);
@@ -65,7 +67,7 @@ public static object ReadT(ReadOnlySpan<byte> data, Type t, int offset, int arrL
 
 					foreach (var enumValue in enumValues)
 					{
-						var enumValueInt = Convert.ToInt32(Enum.Parse(t, enumValue.ToString())); // Convert to int
+						var enumValueInt = Convert.ToInt32(Enum.Parse(t, enumValue.ToString()!)); // Convert to int
 						if ((enumValueInt & Convert.ToInt32(underlyingValue)) != 0) // Convert to int
 						{
 							combinedValue |= enumValueInt;
@@ -127,13 +129,39 @@ public static ILocoStruct ReadLocoStruct(ReadOnlySpan<byte> data, Type t)
 				var variableAttr = AttributeHelper.Get<LocoStructVariableLoadAttribute>(p);
 				if (variableAttr != null)
 				{
-					if (p.PropertyType.IsArray && p.PropertyType.GetElementType() == typeof(uint8_t))
+					if (p.PropertyType.IsArray)
 					{
-						args.Add(new uint8_t[arrLength]);
+						// todo: find a generic way to do this
+						if (p.PropertyType.GetElementType() == typeof(uint8_t))
+						{
+							args.Add(new uint8_t[arrLength]);
+						}
+						else if (p.PropertyType.GetElementType() == typeof(int8_t))
+						{
+							args.Add(new int8_t[arrLength]);
+						}
+						else if (p.PropertyType.GetElementType() == typeof(uint16_t))
+						{
+							args.Add(new uint16_t[arrLength]);
+						}
+						else if (p.PropertyType.GetElementType() == typeof(int16_t))
+						{
+							args.Add(new int16_t[arrLength]);
+						}
+						else if (p.PropertyType.GetElementType() == typeof(uint32_t))
+						{
+							args.Add(new uint32_t[arrLength]);
+						}
+						else if (p.PropertyType.GetElementType() == typeof(int32_t))
+						{
+							args.Add(new int32_t[arrLength]);
+						}
 					}
 					else
 					{
-						args.Add(Activator.CreateInstance(p.PropertyType));
+						var newInstance = Activator.CreateInstance(p.PropertyType);
+						Verify.NotNull(newInstance, paramName: p.PropertyType.Name);
+						args.Add(newInstance!);
 					}
 
 					continue;

OpenLocoTool/DatFileParsing/ByteReader.cs renamed to Core/DatFileParsing/ByteReader.cs

@@ -1,4 +1,4 @@
-namespace OpenLocoTool.DatFileParsing
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	public static class ByteReaderT
 	{

OpenLocoTool/DatFileParsing/ByteReaderT.cs renamed to Core/DatFileParsing/ByteReaderT.cs

@@ -1,4 +1,6 @@
-namespace OpenLocoTool.DatFileParsing
+using Zenith.Core;
+
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	public static class ByteWriter
 	{
@@ -36,13 +38,13 @@ public static void WriteT(Span<byte> data, Type t, int offset, object val)
 			}
 			else if (t.IsArray)
 			{
-				var elementType = t.GetElementType() ?? throw new NullReferenceException();
+				var elementType = t.GetElementType() ?? throw new ArgumentNullException(t.Name);
 				var size = ByteHelpers.GetObjectSize(elementType);
 				var arr = (Array)val;
 
 				for (var i = 0; i < arr.Length; i++)
 				{
-					var value = arr.GetValue(i) ?? throw new NullReferenceException();
+					var value = arr.GetValue(i) ?? throw new ArgumentNullException($"{t.Name}[{i}]");
 					WriteT(data, elementType, offset + (i * size), value);
 				}
 			}
@@ -72,10 +74,7 @@ public static void WriteT(Span<byte> data, Type t, int offset, object val)
 
 		public static ReadOnlySpan<byte> WriteLocoStruct(ILocoStruct obj)
 		{
-			if (obj == null)
-			{
-				throw new NullReferenceException();
-			}
+			Verify.NotNull(obj);
 
 			var t = obj.GetType();
 			var objSize = ByteHelpers.GetObjectSize(t);
@@ -113,7 +112,7 @@ public static ReadOnlySpan<byte> WriteLocoStruct(ILocoStruct obj)
 					arrLength = arrLengthAttr.Length;
 				}
 
-				var propVal = p.GetValue(obj) ?? throw new NullReferenceException();
+				var propVal = p.GetValue(obj) ?? throw new ArgumentNullException($"{p.Name} for {obj} was null");
 				WriteT(buf, p.PropertyType, offsetAttr.Offset, propVal);
 			}
 

OpenLocoTool/DatFileParsing/ByteWriter.cs renamed to Core/DatFileParsing/ByteWriter.cs

@@ -1,4 +1,4 @@
-namespace OpenLocoTool.DatFileParsing
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	public static class ByteWriterT
 	{

OpenLocoTool/DatFileParsing/ByteWriterT.cs renamed to Core/DatFileParsing/ByteWriterT.cs

@@ -1,6 +1,6 @@
-using OpenLocoTool.Headers;
+using OpenLoco.ObjectEditor.Data;
 
-namespace OpenLocoTool.DatFileParsing
+namespace OpenLoco.ObjectEditor.DatFileParsing
 {
 	[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property, AllowMultiple = false)]
 	public class LocoArrayLengthAttribute(int length) : Attribute