Debugging PMDO - Revision history

IDK: remove gitignore considerations: implemented in repo's own gitignore

2024-11-11T20:19:37Z

remove gitignore considerations: implemented in repo's own gitignore

@@ Line 120: / Line 120: @@
 # With Rider installed, [https://www.jetbrains.com/help/rider/attach-to-process.html attach a debugger to the currently running PMDO process].
 # Each time you want to debug a change, you must rebuild the project using <code>dotnet build -c Debug -r osx-x64</code>, run the resulting program, and then attach the debugger.
 [[Category: Engine]]

IDK: attach debugger instructions

2024-11-11T19:35:18Z

attach debugger instructions

Show changes

IDK: Issues and further research

2024-11-09T23:18:23Z

Issues and further research

← Older revision		Revision as of 23:18, 9 November 2024
Line 46:		Line 46:
	# Once this debug configuration is chosen, you can start debugging quickly by going to the Debug tab and selecting the green button next to "Run and Debug".		# Once this debug configuration is chosen, you can start debugging quickly by going to the Debug tab and selecting the green button next to "Run and Debug".

			== Visual Studio Code Issues ==

			Various issues arise when attempting to use the ARM64 version of dotnet with the ARM64 version VS Code.

			Whenever the user clicks "debug", the IDE will build PMDO using the Any CPU setting. If the x64 dotnet is installed, this defaults to an x64 build. But if the Arm64 dotnet is installed, the Arm64 version is built. (Note: check if this is just the responsibility of dotnet installation itself, as opposed to both it and the IDE)

			THE ARM64 VERSION OF PMDO DOES NOT WORK. IT IS MISSING ARM64 DEPENDENCIES FOR LUA, SKIASHARP.

			We must avoid building the Arm64 version and only build for x64.

			It's unknown if there is a way to configure the build step such that it uses the x64 dotnet to build PMDO under x64. Can this be specified in <code>launchSettings.json</code>? In <code>tasks.json</code>?

			Resources:

			* https://code.visualstudio.com/docs/csharp/debugging
			* https://code.visualstudio.com/docs/csharp/debugger-settings
			* https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build
			* https://code.visualstudio.com/Docs/editor/tasks
			* https://code.visualstudio.com/docs/editor/variables-reference
			* https://github.com/dotnet/docs/issues/34726
			* https://code.visualstudio.com/docs/csharp/build-tools

	== Jetbrains Rider ==		== Jetbrains Rider ==

IDK: refactor steps to debug

2024-11-09T21:06:07Z

refactor steps to debug

← Older revision		Revision as of 21:06, 9 November 2024
Line 2:		Line 2:

	= Windows Setup =		= Windows Setup =
	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# ~~Open PMDOData~~.~~sln~~ using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.		# Download the [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0 SDK]. You want to download the x64 version for windows. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
			# Download [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.
			# Open PMDOData.sln using Visual Studio 2022.
	# Set your configuration to Debug, Any CPU. Build the entire solution		# Set your configuration to Debug, Any CPU. Build the entire solution
	# Set PMDC as the startup project and hit Debug.		# Set PMDC as the startup project and hit Debug.

	= Linux Setup =		= Linux Setup =
			Currently, only x64 architecture is supported for Linux.

	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# ~~Open PMDOData~~.~~sln~~ using [https://code.visualstudio.com/download Visual Studio Code]. ~~You can do this by opening~~ the ~~PMDODump folder, then right clicking PMDOData~~.~~sln and choosing "Open Solution"~~.		# Download the [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0 SDK]. You want to download the x64 version for Linux. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Install the [https://code.visualstudio.com/docs/csharp/debugging C# Dev Kit] ~~if you haven't already~~. This can be found in the Extensions tab.		# Download and install [https://code.visualstudio.com/download Visual Studio Code] for Linux. We recommend using the .deb installer.
	# ~~After~~ the C# Dev Kit is installed, you ~~can~~ open the Command Palette <code>Ctrl+Shift+P</code> ~~and typing~~/~~choosing~~ <code>Debug: Select and Start Debugging</code>.		# Install the [https://code.visualstudio.com/docs/csharp/debugging C# Dev Kit]. This can be found in the Extensions tab.
	## Choose C#.		# Open the PMDOData folder with VSCode. You can do this by starting with a blank VSCode window, open a folder, select the PMDODump folder.
	~~###~~ If you've properly opened the PMDOData.sln solution, you should have several Launch Configurations available. Choose "C#: PMDC".		# With the C# Dev Kit installed, you now have the option to open the PMDOData.sln: check the Solution Explorer tab, then right click PMDOData.sln and choose "Open Solution".
			# With the C# Dev Kit installed, you also have the option to open the Command Palette <code>Ctrl+Shift+P</code>. In the command palette, type/choose <code>Debug: Select and Start Debugging</code>.
			## Choose "C#" from the dropdown. If you've properly opened the PMDOData.sln solution, you should have several Launch Configurations available. Choose "C#: PMDC".
	# Debug will start. If the console complains about not being able to find the correct file from path, you may need to change the relative paths specified for the <code>-asset</code> argument in the <code>PMDC/PMDC/Properties/launchSettings.json</code> file.		# Debug will start. If the console complains about not being able to find the correct file from path, you may need to change the relative paths specified for the <code>-asset</code> argument in the <code>PMDC/PMDC/Properties/launchSettings.json</code> file.
	# Once this debug configuration is chosen, you can start debugging quickly by going to the Debug tab and selecting the green button next to "Run and Debug".		# Once this debug configuration is chosen, you can start debugging quickly by going to the Debug tab and selecting the green button next to "Run and Debug".
Line 22:		Line 25:
	= Mac Setup =		= Mac Setup =

	~~Note~~: This ~~has only been tested with Jetbrains Rider~~ and Visual Studio Code		Apple machines made a transition from x64 to ARM64 with [https://en.wikipedia.org/wiki/Mac_transition_to_Apple_silicon Apple Silicon] in 2020-2024, with any Macs running on M1 Chips or later using ARM64. PMDO runs and deploys on x64 only; this normally means that PMDO entirely would not be able to run on M1+ Macs, but [https://en.wikipedia.org/wiki/Rosetta_(software) Rosetta 2] translates applications meant for x64 to run on ARM64. This works normally when attempting to play published versions of PMDO, but makes things tricky for debugging.

			If your machine predates the ARM64 transition (IE, predates M1 Macs), it uses x64 architecture, and there should be no issues debugging. The setup for Visual Studio Code should work exactly as it did for Linux. Use the instructions there if so. Otherwise, use the modified instructions below:

			== Visual Studio Code (Arm64) ==

			# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
			# Download the [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0 SDK]. You want to download the x64 (Not Arm64!) version for MacOS. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
			## If you've previously installed dotnet, it's likely the version for Arm64. You must [https://learn.microsoft.com/en-us/dotnet/core/install/remove-runtime-sdk-versions uninstall] it beforehand.
			## If <code>dotnet</code> command does not work after x64 installation, you may need to specify the path of dotnet directly: check <code>/etc/paths.d/dotnet</code> and make sure it points to <code>/usr/local/share/dotnet/x64</code>.
			# Download and install [https://code.visualstudio.com/download Visual Studio Code] for MacOS. Specifically choose the zip for Intel Chip.
			## If you have an existing VSCode installation under Arm64, it must be uninstalled. You should be able to do this by sending the VSCode app to the trash.
			# Install the [https://code.visualstudio.com/docs/csharp/debugging C# Dev Kit]. This can be found in the Extensions tab.
			## If you had a previous installation of VSCode under Arm64, it's likely that the extension was also installed as an arm64 version. You will need to uninstall it and reinstall to get the x64 version. Do this for both the C# Dev Kit as well as the C# extension it depends on.
			# Open the PMDOData folder with VSCode. You can do this by starting with a blank VSCode window, open a folder, select the PMDODump folder.
			# With the C# Dev Kit installed, you now have the option to open the PMDOData.sln: check the Solution Explorer tab, then right click PMDOData.sln and choose "Open Solution".
			# With the C# Dev Kit installed, you also have the option to open the Command Palette <code>Ctrl+Shift+P</code>. In the command palette, type/choose <code>Debug: Select and Start Debugging</code>.
			## Choose "C#" from the dropdown. If you've properly opened the PMDOData.sln solution, you should have several Launch Configurations available. Choose "C#: PMDC".
			# Debug will start. If the console complains about not being able to find the correct file from path, you may need to change the relative paths specified for the <code>-asset</code> argument in the <code>PMDC/PMDC/Properties/launchSettings.json</code> file.
			# Once this debug configuration is chosen, you can start debugging quickly by going to the Debug tab and selecting the green button next to "Run and Debug".


			== Jetbrains Rider ==

	Made by: Trio-#4442		Made by: Trio-#4442
Line 29:		Line 54:
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Copy all of the <code>.dylib</code> files in <code>PMDC/PMDC/runtimes</code> folders to <code>PMDC/PMDC</code>. Here’s what your file structure should look like: [[File:Debug_Mac_FolderStructure.png\|frameless]]		# Copy all of the <code>.dylib</code> files in <code>PMDC/PMDC/runtimes</code> folders to <code>PMDC/PMDC</code>. Here’s what your file structure should look like: [[File:Debug_Mac_FolderStructure.png\|frameless]]
	# In your <code>~/.gitignore_global</code> file, add the following files for git to ignore:


			Jetbrains Rider requires a paid subscription.

			# Debug should run out of the box. Set the configuration to PMDC and click "Debug", and you should be all ready to go!</br>[[File:Debug_Mac_Rider.png\|frameless]]


			== Gitignore considerations ==


			In your <code>~/.gitignore_global</code> file, add the following files for git to ignore:
	<pre>		<pre>
	# Debug logs (npm, yarn)		# Debug logs (npm, yarn)
Line 46:		Line 82:
	</pre>		</pre>
	You may want to include more. Modified from [https://www.mashupgarage.com/playbook/git/gitignore.html here].		You may want to include more. Modified from [https://www.mashupgarage.com/playbook/git/gitignore.html here].

	~~The following steps below depend on your IDE of choice. See each section below.~~

	~~== Jetbrains Rider ==~~
	~~Jetbrains Rider requires a paid subscription.~~

	~~# Debug should run out of the box. Set the configuration to PMDC and click "Debug", and you should be all ready to go!</br>[[File:Debug_Mac_Rider.png\|frameless]]~~

	~~== Visual Studio Code ==~~
	# Install the C# extension. There is a possibility that you have to downgrade to an older version like <code>v1.24.4</code> or modify the settings in Omnisharp settings discussed here? But I personally wasn’t able to figure out how to make it work.
	~~# Create <code>.vscode/launch.json</code> in the root folder of <code>PMDODump</code> In launch.json, copy everything from here to the file.</br>[[File:Debug_Mac_VSCode_Launch.png\|frameless]]~~
	~~# In the <code>Run and Debug</code> tab in VSCode, you can click on the green arrow to begin debugging.</br>[[File:Debug_Mac_VSCode_Debug.png\|frameless]]~~

	[[Category: Engine]]		[[Category: Engine]]

IDK at 05:10, 9 November 2024

2024-11-09T05:10:14Z

← Older revision		Revision as of 05:10, 9 November 2024
Line 2:		Line 2:

	= Windows Setup =		= Windows Setup =
	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Open PMDOData.sln using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.		# Open PMDOData.sln using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.
Line 10:		Line 10:
	= Linux Setup =		= Linux Setup =

	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Open PMDOData.sln using [https://code.visualstudio.com/download Visual Studio Code]. You can do this by opening the PMDODump folder, then right clicking PMDOData.sln and choosing "Open Solution".		# Open PMDOData.sln using [https://code.visualstudio.com/download Visual Studio Code]. You can do this by opening the PMDODump folder, then right clicking PMDOData.sln and choosing "Open Solution".
Line 26:		Line 26:
	Made by: Trio-#4442		Made by: Trio-#4442

	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version. Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Copy all of the <code>.dylib</code> files in <code>PMDC/PMDC/runtimes</code> folders to <code>PMDC/PMDC</code>. Here’s what your file structure should look like: [[File:Debug_Mac_FolderStructure.png\|frameless]]		# Copy all of the <code>.dylib</code> files in <code>PMDC/PMDC/runtimes</code> folders to <code>PMDC/PMDC</code>. Here’s what your file structure should look like: [[File:Debug_Mac_FolderStructure.png\|frameless]]

IDK: Linux Debugging

2024-11-09T04:22:38Z

Linux Debugging

← Older revision		Revision as of 04:22, 9 November 2024
Line 12:		Line 12:
	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Open PMDOData.sln using [https://code.visualstudio.com/download Visual Studio Code].		# Open PMDOData.sln using [https://code.visualstudio.com/download Visual Studio Code]. You can do this by opening the PMDODump folder, then right clicking PMDOData.sln and choosing "Open Solution".
	# Install the [https://code.visualstudio.com/docs/csharp/debugging C# Dev Kit] if you haven't already.		# Install the [https://code.visualstudio.com/docs/csharp/debugging C# Dev Kit] if you haven't already. This can be found in the Extensions tab.
			# After the C# Dev Kit is installed, you can open the Command Palette <code>Ctrl+Shift+P</code> and typing/choosing <code>Debug: Select and Start Debugging</code>.
			## Choose C#.
			### If you've properly opened the PMDOData.sln solution, you should have several Launch Configurations available. Choose "C#: PMDC".
			# Debug will start. If the console complains about not being able to find the correct file from path, you may need to change the relative paths specified for the <code>-asset</code> argument in the <code>PMDC/PMDC/Properties/launchSettings.json</code> file.
			# Once this debug configuration is chosen, you can start debugging quickly by going to the Debug tab and selecting the green button next to "Run and Debug".

	= Mac Setup =		= Mac Setup =

IDK: Linux VSCode WIP

2024-11-09T02:53:39Z

Linux VSCode WIP

← Older revision		Revision as of 02:53, 9 November 2024
Line 1:		Line 1:
	See also: [[Contributing Code]], [[Building PMDO]]		See also: [[Contributing Code]], [[Building PMDO]]

	= ~~PMDO~~ Windows ~~Debug~~ Setup =		= Windows Setup =
	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Open PMDOData.sln using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.		# Open PMDOData.sln using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.
	# Set your configuration to Debug, ~~x64~~. Build the entire solution		# Set your configuration to Debug, Any CPU. Build the entire solution
	# Set PMDC as the startup project and hit Debug.		# Set PMDC as the startup project and hit Debug.

	= PMDO Mac ~~Debug~~ Setup =		= Linux Setup =

			# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
			# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
			# Open PMDOData.sln using [https://code.visualstudio.com/download Visual Studio Code].
			# Install the [https://code.visualstudio.com/docs/csharp/debugging C# Dev Kit] if you haven't already.


			= Mac Setup =

	Note: This has only been tested with Jetbrains Rider and Visual Studio Code		Note: This has only been tested with Jetbrains Rider and Visual Studio Code

IDK: Add building PMDO link

2024-11-08T19:07:59Z

Add building PMDO link

← Older revision		Revision as of 19:07, 8 November 2024
Line 1:		Line 1:
	See also: [[Contributing Code]]		See also: [[Contributing Code]], [[Building PMDO]]

	= PMDO Windows Debug Setup =		= PMDO Windows Debug Setup =

IDK at 21:18, 2 October 2024

2024-10-02T21:18:49Z

← Older revision		Revision as of 21:18, 2 October 2024
Line 2:		Line 2:

	= PMDO Windows Debug Setup =		= PMDO Windows Debug Setup =
	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Open PMDOData.sln using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.		# Open PMDOData.sln using [https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false Visual Studio 2022] or later.

IDK: upgrade dotnet

2024-10-02T21:18:23Z

upgrade dotnet

← Older revision		Revision as of 21:18, 2 October 2024
Line 14:		Line 14:
	Made by: Trio-#4442		Made by: Trio-#4442

	# Download [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.		# Download [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8.0]. You want to download the x64 version Confirm that it is installed using the command <code>dotnet --list-runtimes</code>.
	# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.		# Recursively clone the PMDO repository using <code>git clone --recurse-submodules -j8 https://github.com/audinowho/PMDODump.git</code>.
	# Copy all of the <code>.dylib</code> files in <code>PMDC/PMDC/runtimes</code> folders to <code>PMDC/PMDC</code>. Here’s what your file structure should look like: [[File:Debug_Mac_FolderStructure.png\|frameless]]		# Copy all of the <code>.dylib</code> files in <code>PMDC/PMDC/runtimes</code> folders to <code>PMDC/PMDC</code>. Here’s what your file structure should look like: [[File:Debug_Mac_FolderStructure.png\|frameless]]