User:FallenAvatar/Code Based Mod - Revision history

FallenAvatar at 04:15, 15 February 2018

2018-02-15T04:15:14Z

Meduris: not sure if I am mistaken here, but when putting this in GameContextInitializeInit I always got an exception about the game already having finished initialisation

2018-02-06T16:31:17Z

not sure if I am mistaken here, but when putting this in GameContextInitializeInit I always got an exception about the game already having finished initialisation

Meduris: changed namespace of VisualStudioAttacher to something more generic and used the namespace to reference the calls later on in AttachDebugger() (this way one should be able to use it as is without any modifications)

2018-02-06T16:29:13Z

changed namespace of VisualStudioAttacher to something more generic and used the namespace to reference the calls later on in AttachDebugger() (this way one should be able to use it as is without any modifications)

FallenAvatar: spelling fix

2018-02-05T23:58:15Z

spelling fix

FallenAvatar at 03:17, 3 February 2018

2018-02-03T03:17:03Z

FallenAvatar: Adding images

2018-02-03T03:16:01Z

Adding images

FallenAvatar: RFC: Replace current Code Based Mod page with this

2018-02-03T03:05:21Z

RFC: Replace current Code Based Mod page with this

Show changes

FallenAvatar at 02:28, 3 February 2018

2018-02-03T02:28:51Z

FallenAvatar at 01:51, 3 February 2018

2018-02-03T01:51:34Z

Show changes

FallenAvatar: fixing image

2018-02-03T00:27:44Z

fixing image

@@ Line 91: / Line 91: @@
 </pre>
 ''The project is now able to be built, copied to the Staxel bin directory and loaded as a Mod, of course it doesn't do much at the moment''
@@ Line 348: / Line 347: @@
+		}
 </pre>
-* Add to the function "ClientContextInitializeInit"
+* Add to the function "GameContextInitializeInit"
 <pre>this.AttachDebugger();</pre>
 * Add a reference to the project to "C:\Program Files (x86)\Common Files\Microsoft Shared\MSEnv\PublicAssemblies\envdte.dll"

@@ Line 348: / Line 348: @@
+		}
 </pre>
-* Add to the function "GameContextInitializeInit"
+* Add to the function "ClientContextInitializeInit"
 <pre>this.AttachDebugger();</pre>
 * Add a reference to the project to "C:\Program Files (x86)\Common Files\Microsoft Shared\MSEnv\PublicAssemblies\envdte.dll"

@@ Line 179: / Line 179: @@
 using Process = System.Diagnostics.Process;
-namespace Test471.Debugging {
+namespace StaxelModding.Debugging {
 	#region Classes
@@ Line 334: / Line 334: @@
 		private void AttachDebugger() {
 			// do a search for any Visual Studio processes that also have our solution currently open
-			var vsProcess = Debugging.VisualStudioAttacher.GetVisualStudioForSolutions( new List<string>() { SolutionInfo.SolutionFileName } );
+			var vsProcess = StaxelModding.Debugging.VisualStudioAttacher.GetVisualStudioForSolutions( new List<string>() { SolutionInfo.SolutionFileName } );
 			if( vsProcess != null ) {
-				Debugging.VisualStudioAttacher.AttachVisualStudioToProcess( vsProcess, Process.GetCurrentProcess() );
+				StaxelModding.Debugging.VisualStudioAttacher.AttachVisualStudioToProcess( vsProcess, Process.GetCurrentProcess() );
 			} else {
 				// try and attach the old fashioned way

@@ Line 56: / Line 56: @@
 #region Running
-	#region Every From
+	#region Every Frame
 		public void UniverseUpdateAfter() {}
 		public void UniverseUpdateBefore( Universe universe, Timestep step ) {}

@@ Line 4: / Line 4: @@
-== Creating The Project ==
+== Creating the Project ==
 ''This page assumes that you are running Visual Studio 2017. If you run other versions of Visual Studio, locations of things may have changed. Other IDE's will definitely have different methods for some actions.''
@@ Line 20: / Line 20: @@
 * Click '''Ok'''
-== Setting Up The Project ==
+== Setting up the Project ==
 Now the project needs to be setup to recognize Staxel's code and build itself correctly for debugging.
 [[File:code-based-mod_add-reference.png|thumb|x150px|Add References]]

@@ Line 97: / Line 97: @@
 == Setting up Debugging ==
 This section is technically optional, but it will make your life much, ''much'', '''much''' easier in the long run.
 * Right click the project and select properties
 * Select the "Build Events" tab on the left.
@@ Line 120: / Line 121: @@
 copy "$(TargetDir)$(TargetName).*" "C:\Program Files (x86)\Steam\steamapps\common\Staxel\bin\"
 </pre>
 * Select the "Debug" tab on the left
 ** Set "Start external program" to "C:\Program Files (x86)\Steam\steamapps\common\Staxel\bin\Staxel.Client.exe"

@@ Line 31: / Line 31: @@
 ** Click Add
 ** Click Ok
 * Add a new Text File and name it StaxelMod.mod
 ** Replace StaxelMod with what you named your project
 ** Simply add "{}" without the quotation marks to the file and save it.
 *** This file is a config file. However nothing is supported in it yet. In the future, this ''might'' change.
 * Rename the Class1 class to Mod and allow Visual Studio to rename all references to it.
-* Open Mod.cs and replace its content with:
+* Open Mod.cs and replacing "StaxelMod" as necessary, overwrite its content with:
 <pre>
 using Plukit.Base;
@@ Line 93: / Line 91: @@
 </pre>
-** Again, replace "StaxelMod" as necessary.
+'' '''Note''': Currently ClientContextDeinitialize is called during initialization intead of ClientContextInitializeInit
-** '' '''Note''': Currently ClientContextDeinitialize is called during initialization intead of ClientContextInitializeInit
+''The project is now able to be built, copied to the Staxel bin directory and loaded as a Mod, of course it doesn't do much at the moment''
-= Interface Documentation =
+== Interface Documentation ==
 * [[IAchievementComponentBuilder]]

@@ Line 19: / Line 19: @@
 * Click '''Ok'''
-[[File:code-based-mod_new-project|New Project]]
+[[File:code-based-mod_new-project.png|New Project]]
 '' Your New Project dialog may not look exactly like this.''