Skip to content

Commit 06ca0d2

Browse files
Add information on maui requirements for mobile debugging (#136)
* Update install additional workload instructions to include maui * Update vscode doc to include maui extension suggestion for mobile dev
1 parent 40f143b commit 06ca0d2

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

articles/getting_started/1_setting_up_your_os_for_development_macos.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ To develop with MonoGame in C#, you will need to install the .NET SDK. As of Mon
1717

1818
If you intend to also work with platforms such as `Android` or `iOS`, you will need to install the additional .NET workload templates for those platforms which include additional features and simulators to support those platforms. Just run the following commands from the terminal for the platforms below you wish to install.
1919

20+
> [!IMPORTANT]
21+
> For mobile development with iOS and Android, you must also install the MAUI workload even though MonoGame does not use MAUI. The MAUI workload contains the debugging tools required to run and debug mobile .NET applications. Without it, you will not be able to properly debug your MonoGame mobile projects.
22+
2023
### [Android](#tab/android)
2124

2225
```cli
@@ -29,6 +32,17 @@ If you intend to also work with platforms such as `Android` or `iOS`, you will n
2932
dotnet workload install ios
3033
```
3134

35+
### [Maui](#tab/maui)
36+
```cli
37+
dotnet workload install maui
38+
```
39+
40+
### [Android, iOS, and Maui](#tab/all)
41+
42+
```cli
43+
dotnet workload install android ios maui
44+
```
45+
3246
---
3347

3448
> [!NOTE]

articles/getting_started/1_setting_up_your_os_for_development_ubuntu.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ To develop with MonoGame in C#, you will need to install the .NET SDK. As of Mon
2121

2222
If you intend to also work with platforms such as `Android` or `iOS`, you will need to install the additional .NET workload templates for those platforms which include additional features and simulators to support those platforms. Just run the following commands from the terminal for the platforms below you wish to install.
2323

24+
> [!IMPORTANT]
25+
> For mobile development with iOS and Android, you must also install the MAUI workload even though MonoGame does not use MAUI. The MAUI workload contains the debugging tools required to run and debug mobile .NET applications. Without it, you will not be able to properly debug your MonoGame mobile projects.
26+
2427
### [Android](#tab/android)
2528

2629
```cli
@@ -33,6 +36,17 @@ If you intend to also work with platforms such as `Android` or `iOS`, you will n
3336
dotnet workload install ios
3437
```
3538

39+
### [Maui](#tab/maui)
40+
```cli
41+
dotnet workload install maui
42+
```
43+
44+
### [Android, iOS, and Maui](#tab/all)
45+
46+
```cli
47+
dotnet workload install android ios maui
48+
```
49+
3650
---
3751

3852
> [!NOTE]

articles/getting_started/1_setting_up_your_os_for_development_windows.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ You can follow the instructions below based on your operating system to install
2626

2727
If you intend to also work with platforms such as `Android` or `iOS`, you will need to install the additional .NET workload templates for those platforms which include additional features and simulators to support those platforms. Just run the command-line command for the platforms below you wish to install.
2828

29+
> [!IMPORTANT]
30+
> For mobile development with iOS and Android, you must also install the MAUI workload even though MonoGame does not use MAUI. The MAUI workload contains the debugging tools required to run and debug mobile .NET applications. Without it, you will not be able to properly debug your MonoGame mobile projects.
31+
2932
### [Android](#tab/android)
3033

3134
```cli
@@ -38,6 +41,17 @@ If you intend to also work with platforms such as `Android` or `iOS`, you will n
3841
dotnet workload install ios
3942
```
4043

44+
### [Maui](#tab/maui)
45+
```cli
46+
dotnet workload install maui
47+
```
48+
49+
### [Android, iOS, and Maui](#tab/all)
50+
51+
```cli
52+
dotnet workload install android ios maui
53+
```
54+
4155
---
4256

4357
> [!NOTE]

articles/getting_started/2_choosing_your_ide_vscode.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,20 @@ You can find this extension by following the steps above and searching for "Mono
8181
> [!NOTE]
8282
> While not built by the MonoGame team, we regularly use this extension ourselves and fully support it.
8383

84+
## (Optional) Install the ".NET MAUI" extension to help with mobile development
85+
86+
This extension is provided by Microsoft and is built on top of the C# and C# Dev Kit extensions. They will be installed as dependencies if they were not already installed. While primarily designed for MAUI development, it provides essential mobile debugging capabilities that MonoGame mobile projects can utilize.
87+
88+
The .NET MAUI extension adds features for building mobile apps, including:
89+
90+
- F5 debugging support - Debug your MonoGame mobile apps on emulators, simulators, and physical devices
91+
- Easy target switching - Change debug/deploy targets between different mobile platforms
92+
- Enhanced C# Dev Kit integration - Leverages Solution Explorer, Test Explorer, and advanced language features
93+
94+
> [!NOTE]
95+
> This extension is recommended if you wish to do iOS or Android development. It is required for debugging support when working on mobile games.
96+
97+
8498
## Creating a new MonoGame project
8599

86100
1. Open up an empty folder in Visual Studio Code

0 commit comments

Comments
 (0)