Added TRKWriter, cleaned up some code, added more comments, added example for writing track file and changing theme.

yellowberryHN · yellowberryHN · commit 9bda7568ec4d · 2020-08-12T20:44:27.000-06:00
diff --git a/Constants.cs b/Constants.cs
@@ -33,7 +33,8 @@ public enum TrackTheme
         public enum TrackSize
         {
             Multiplayer = 0,
-            Singleplayer = 1
+            Singleplayer = 1,
+            Mega = 2
         }
 
         /// <summary>
@@ -58,22 +59,22 @@ public enum TrackTime
         /// Converts normalized element ID to non-normalized element ID.
         /// </summary>
         /// <param name="theme">The theme of the requested element</param>
-        /// <param name="elementId">The normalized element ID</param>
+        /// <param name="xid">The normalized element ID</param>
         /// <returns>The non-normalized element ID</returns>
-        public static byte GetElement(TrackTheme theme, int elementId)
+        public static byte GetElement(TrackTheme theme, int xid)
         {
-            return elementTable[(int)theme][elementId];
+            return elementTable[(int)theme][xid];
         }
 
         /// <summary>
         /// Converts non-normalized element ID to normalized element ID.
         /// </summary>
         /// <param name="theme">The theme of the requested element</param>
-        /// <param name="elementId">The non-normalized element ID</param>
+        /// <param name="id">The non-normalized element ID</param>
         /// <returns>The normalized element ID</returns>
-        public static int GetElement(TrackTheme theme, byte elementId)
+        public static int GetElement(TrackTheme theme, byte id)
         {
-            return Array.IndexOf(elementTable[(int)theme], elementId);
+            return Array.IndexOf(elementTable[(int)theme], id);
         }
 
         /// <summary>
diff --git a/Examples/ReadTrack/Program.cs b/Examples/ReadTrack/Program.cs
@@ -38,8 +38,7 @@ static void PrintVis()
             {
                 foreach (var chr in row)
                 {
-                    //char pr = chr != '\0' ? chr : '.';
-                    Console.Write(chr);
+                    Console.Write(chr != '\0' ? chr : '.');
                 }
                 Console.Write("\n");
             }
@@ -63,7 +62,7 @@ static void Main(string[] args)
             var track = reader.ReadTrack(filename);
 
             track.GetInfo();
-            //track.GetElements()[0].GetInfo();
+            track.GetElements()[0].GetInfo();
             var elements = track.GetElements();
 
             foreach (var element in elements)
diff --git a/Examples/ReadTrack/Properties/launchSettings.json b/Examples/ReadTrack/Properties/launchSettings.json
@@ -0,0 +1,7 @@
+{
+  "profiles": {
+    "ReadTrack": {
+      "commandName": "Project"
+    }
+  }
+}
diff --git a/Examples/ReadTrack/ReadTrack.csproj b/Examples/ReadTrack/ReadTrack.csproj
@@ -12,11 +12,4 @@
     <ProjectReference Include="..\..\LSRutil.NET.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <None Include="..\..\LICENSE.md">
-      <Pack>True</Pack>
-      <PackagePath></PackagePath>
-    </None>
-  </ItemGroup>
-
 </Project>
diff --git a/Examples/ThemeChange/Program.cs b/Examples/ThemeChange/Program.cs
@@ -0,0 +1,30 @@
+﻿using LSRutil;
+using static LSRutil.Constants;
+
+namespace ThemeChange
+{
+    class Program
+    {
+        static string filename = @"C:\LSR\SavedTracks\height.trk";
+        static TrackTheme theme = TrackTheme.Ice;
+
+        static void ChangeTheme(TrackElement element)
+        {
+            element.theme = theme;
+        }
+
+        static void Main(string[] args)
+        {
+            var writer = new TRKWriter();
+            var reader = new TRKReader();
+
+            var track = reader.ReadTrack(filename);
+            track.theme = theme;
+
+            var elements = track.GetElements();
+            elements.ForEach(ChangeTheme);
+
+            writer.WriteTrack(track, "test2.trk");
+        }
+    }
+}
diff --git a/Examples/ThemeChange/ThemeChange.csproj b/Examples/ThemeChange/ThemeChange.csproj
@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\LSRutil.NET.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/Examples/WriteTrack/Program.cs b/Examples/WriteTrack/Program.cs
@@ -0,0 +1,28 @@
+﻿using System;
+using LSRutil;
+using static LSRutil.Constants;
+
+namespace WriteTrack
+{
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            var writer = new TRKWriter();
+            var track = new Track() {
+                size = TrackSize.Multiplayer,
+                theme = TrackTheme.Ice,
+                time = TrackTime.Night
+            };
+
+            track.Add(new TrackElement() {
+                theme = track.theme, // theme is set first, because that's important for the ID.
+                xid = 0,
+                rotation = 0,
+                pos = new GridPosition(0,0,0)
+            });
+
+            writer.WriteTrack(track, "test.trk");
+        }
+    }
+}
diff --git a/Examples/WriteTrack/WriteTrack.csproj b/Examples/WriteTrack/WriteTrack.csproj
@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\LSRutil.NET.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/GridPosition.cs b/GridPosition.cs
@@ -22,7 +22,11 @@ public override bool Equals(object obj)
 
         public override int GetHashCode()
         {
-            return base.GetHashCode();
+            int hash = 47;
+            hash = (hash * 5) + X.GetHashCode();
+            hash = (hash * 5) + Y.GetHashCode();
+            hash = (hash * 5) + Z.GetHashCode();
+            return hash;
         }
 
         public override string ToString()
diff --git a/LSRutil.NET.csproj b/LSRutil.NET.csproj
@@ -5,12 +5,14 @@
     <TargetFrameworks>netcoreapp3.0;net471</TargetFrameworks>
     <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
     <RootNamespace>LSRutil</RootNamespace>
-    <Version>0.8.1</Version>
+    <Version>0.9.0</Version>
     <Authors>Zsolt Zitting</Authors>
     <Copyright></Copyright>
     <Company></Company>
     <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
     <RepositoryUrl>https://github.com/YellowberryHN/LSRutil.NET</RepositoryUrl>
+    <Description>LSRutil.NET is a library for reading and eventually writing the LEGO Stunt Rally .trk file format. It parses tracks into a format that is easy to work with, and allows people to make converters and parsers for the format.</Description>
+    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
   </PropertyGroup>
   <ItemGroup>
     <Compile Remove="Examples\**" />
diff --git a/LSRutil.NET.sln b/LSRutil.NET.sln
@@ -5,7 +5,11 @@ VisualStudioVersion = 16.0.30204.135
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "LSRutil.NET", "LSRutil.NET.csproj", "{8435A509-306E-424D-88AA-DEABB779DF54}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ReadTrack", "Examples\ReadTrack\ReadTrack.csproj", "{806DDBAC-A303-487B-B9C2-4B88809FC889}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ReadTrack", "Examples\ReadTrack\ReadTrack.csproj", "{806DDBAC-A303-487B-B9C2-4B88809FC889}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WriteTrack", "Examples\WriteTrack\WriteTrack.csproj", "{F22846D5-D9D7-4914-A40C-48BAB30E5248}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ThemeChange", "Examples\ThemeChange\ThemeChange.csproj", "{7F5A019B-D222-414F-BBBE-FBDEE204B4D6}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -21,6 +25,14 @@ Global
 		{806DDBAC-A303-487B-B9C2-4B88809FC889}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{806DDBAC-A303-487B-B9C2-4B88809FC889}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{806DDBAC-A303-487B-B9C2-4B88809FC889}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F22846D5-D9D7-4914-A40C-48BAB30E5248}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F22846D5-D9D7-4914-A40C-48BAB30E5248}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F22846D5-D9D7-4914-A40C-48BAB30E5248}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F22846D5-D9D7-4914-A40C-48BAB30E5248}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7F5A019B-D222-414F-BBBE-FBDEE204B4D6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7F5A019B-D222-414F-BBBE-FBDEE204B4D6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7F5A019B-D222-414F-BBBE-FBDEE204B4D6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7F5A019B-D222-414F-BBBE-FBDEE204B4D6}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/README.md b/README.md
@@ -1,3 +1,34 @@
 # LSRutil.NET
 
-LSRutil.NET is a library for reading and eventually writing the LEGO Stunt Rally .trk file format. It's pretty cool.
+LSRutil.NET is a library for reading and eventually writing the LEGO Stunt Rally .trk file format. It parses tracks into a format that is easy to work with, and allows people to make converters and parsers for the format.
+
+[![Nuget](https://img.shields.io/nuget/v/LSRutil.NET?color=004880&label=NuGet&logo=nuget)](https://www.nuget.org/packages/LSRutil.NET)
+
+## Usage
+```cs
+using LSRutil;
+...
+
+var reader = new TRKReader();
+var track = reader.ReadTrack(@"C:\LSR\SavedTracks\dune.trk");
+
+Console.WriteLine("This track is using the {0} theme!", track.theme);
+```
+Check out the [ReadTrack](Examples/ReadTrack/Program.cs), [WriteTrack](Examples/WriteTrack/Program.cs), and [ThemeChange](Examples/ThemeChange/Program.cs) examples!
+
+## Projects
+I like to think I write useful code, so here are some projects that use LSRutil.NET.
+*Know of any I missed?* ***Create a pull request!***
+
+* [**SRToolbox 2.0**](https://github.com/YellowberryHN/SRToolbox) (WIP)
+* **TrackMasters** (Coming soon!)
+
+## Need to use another language?
+**There might be a version for it.**
+* *Coming soon...*
+
+## Contributing
+Pull requests are always welcome, but major changes will not be accepted if they do not have a cooresponding issue.
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/TRKReader.cs b/TRKReader.cs
@@ -10,10 +10,21 @@ public class TRKReader
         private Stream stream;
         private BinaryReader reader;
 
+        /// <summary>
+        /// Enables extended features which are not supported by the official standard.
+        /// </summary>
+        /// <remarks>
+        /// <para>Allows you to use the <see cref="TrackSize.Mega"/> track size.</para>
+        /// </remarks>
+        public readonly bool extensions = false;
+
         /// <summary>
         /// Instanciates a new TRKReader to read a track file.
         /// </summary>
-        public TRKReader() { }
+        /// <param name="extensions">Enables extended features which are not supported by the official standard.</param>
+        public TRKReader(bool extensions = false) {
+            this.extensions = extensions;
+        }
 
         /// <summary>
         /// Reads a string from the stream.
@@ -53,7 +64,7 @@ private float ReadFloat()
         private int ReadHeight()
         {
             int height = (int)ReadFloat();
-            return height == -1 ? 0 : height/8;
+            return height == -1 ? 0 : (extensions ? height/8 : Math.Min(height/8, 3));
         }
 
         /// <summary>
@@ -100,6 +111,7 @@ public Track ReadTrack(Stream stream)
                 else if (ClaimedFilesize != RealFilesize) throw new InvalidDataException("Incorrect filesize, corrupted track!");
 
                 track.size = (TrackSize)ReadInt();
+                if(!extensions && track.size > TrackSize.Singleplayer) throw new NotSupportedException(string.Format("Please turn extensions on to read {0} size maps.", track.size));
                 track.theme = (TrackTheme)ReadInt();
                 track.time = (TrackTime)ReadInt();
 
@@ -113,7 +125,7 @@ public Track ReadTrack(Stream stream)
                     {
                         var element = new TrackElement();
 
-                        stream.Seek(4, SeekOrigin.Current); // skip padding
+                        element.mystery = ReadInt();
                         var height = ReadHeight();
                         var id = reader.ReadByte();
                         element.theme = ReadElementTheme();
@@ -127,6 +139,9 @@ public Track ReadTrack(Stream stream)
                     }
                     stream.Seek(skip, SeekOrigin.Current);
                 }
+
+                stream.Seek(65572, SeekOrigin.Begin);
+                track.playable = ReadInt() == 1;
             }
 
             return track;
diff --git a/TRKWriter.cs b/TRKWriter.cs
diff --git a/Track.cs b/Track.cs
diff --git a/TrackElement.cs b/TrackElement.cs

Original file line number	Diff line number	Diff line change
`@@ -38,8 +38,7 @@ static void PrintVis()`
`38`	`38`	`{`
`39`	`39`	`foreach (var chr in row)`
`40`	`40`	`{`
`41`		`- //char pr = chr != '\0' ? chr : '.';`
`42`		`- Console.Write(chr);`
	`41`	`+ Console.Write(chr != '\0' ? chr : '.');`
`43`	`42`	`}`
`44`	`43`	`Console.Write("\n");`
`45`	`44`	`}`
`@@ -63,7 +62,7 @@ static void Main(string[] args)`
`63`	`62`	`var track = reader.ReadTrack(filename);`
`64`	`63`
`65`	`64`	`track.GetInfo();`
`66`		`- //track.GetElements()[0].GetInfo();`
	`65`	`+ track.GetElements()[0].GetInfo();`
`67`	`66`	`var elements = track.GetElements();`
`68`	`67`
`69`	`68`	`foreach (var element in elements)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,11 @@ public override bool Equals(object obj)`
`22`	`22`
`23`	`23`	`public override int GetHashCode()`
`24`	`24`	`{`
`25`		`- return base.GetHashCode();`
	`25`	`+ int hash = 47;`
	`26`	`+ hash = (hash * 5) + X.GetHashCode();`
	`27`	`+ hash = (hash * 5) + Y.GetHashCode();`
	`28`	`+ hash = (hash * 5) + Z.GetHashCode();`
	`29`	`+ return hash;`
`26`	`30`	`}`
`27`	`31`
`28`	`32`	`public override string ToString()`