Skip to content

Commit 74b2c66

Browse files
committed
Update instances in documentation where version number should always reflect current version
1 parent f0cb9f7 commit 74b2c66

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

articles/getting_started/1_setting_up_your_os_for_development_arch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: This section provides a step-by-step guide for setting up your deve
66
> [!TIP]
77
> Arch Linux is a rolling release distribution. This guide was tested in October 2025 with kernel `version 6.15.9-arch1-1`.
88
9-
To develop with MonoGame in C#, you will need to install the .NET 9 SDK. As of MonoGame 3.8.4.1 the recommended version is .NET 9.
9+
To develop with MonoGame in C#, you will need to install the .NET 9 SDK. As of MonoGame {{mgVersion}} the recommended version is .NET 9.
1010

1111
> [!TIP]
1212
> You can still continue to use .NET 8 if you wish, you will just need to downgrade your client project .NET version in the `csproj` setup for your project (if using the default templates)

articles/getting_started/1_setting_up_your_os_for_development_macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Setting up your OS for development on MacOS
33
description: This section provides a step-by-step guide for setting up your development environment on Mac.
44
---
55

6-
To develop with MonoGame in C#, you will need to install the .NET SDK. As of MonoGame 3.8.4.1 the recommended version is .NET 9.
6+
To develop with MonoGame in C#, you will need to install the .NET SDK. As of MonoGame {{mgVersion}} the recommended version is .NET 9.
77

88
> [!TIP]
99
> You can still continue to use .NET 8 if you wish, you will just need to downgrade your client project .NET version in the `csproj` setup for your project (if using the default templates)

articles/getting_started/1_setting_up_your_os_for_development_ubuntu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: This section provides a step-by-step guide for setting up your deve
66
> [!TIP]
77
> The minimum version of Ubuntu that is supported by MonoGame is `20.04`.
88
9-
To develop with MonoGame in C#, you will need to install the .NET SDK. As of MonoGame 3.8.4.1 the minimum supported version is .NET 9.
9+
To develop with MonoGame in C#, you will need to install the .NET SDK. As of MonoGame {{mgVersion}} the minimum supported version is .NET 9.
1010

1111
## Install .NET 9 SDK
1212

articles/getting_started/1_setting_up_your_os_for_development_windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Setting up your OS for development on Windows
33
description: This section provides a step-by-step guide for setting up your development environment on Windows.
44
---
55

6-
To develop with MonoGame in C#, you must install the .NET SDK. As of MonoGame 3.8.4.1 the minimum supported version is .NET 9.
6+
To develop with MonoGame in C#, you must install the .NET SDK. As of MonoGame {{mgVersion}} the minimum supported version is .NET 9.
77

88
> [!IMPORTANT]
99
> If your chosen IDE for development is [Visual Studio](https://visualstudio.microsoft.com/) then you can skip this step as .NET 8 is included with the Visual Studio Installer.

articles/getting_to_know/howto/HowTo_Install_Preview_Release.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ To use the preview packages delivered via NuGet you need to update or replace yo
2424
The simplest way is from the command line in the folder where your `csproj` is located (if you have multiple projects, please repeat for each) using the following syntax:
2525

2626
```dotnetcli
27-
dotnet add package MonoGame.Framework.DesktopGL -v 3.8.4-preview.1
28-
dotnet add package MonoGame.Content.Builder.Task -v 3.8.4-preview.1
27+
dotnet add package MonoGame.Framework.DesktopGL -v {{mgDevelopVersion}}
28+
dotnet add package MonoGame.Content.Builder.Task -v {{mgDevelopVersion}}
2929
```
3030

3131
**Replacing the preview version with the specific version you wish to install.**
@@ -42,11 +42,11 @@ To ensure symmetry between the project version and the Content Pipeline Editor (
4242
This is simply a matter of updating the tools references, again from the command line in the projects folder, as follows:
4343

4444
```dotnetcli
45-
dotnet tool install dotnet-mgcb --version 3.8.4-preview.1
46-
dotnet tool install dotnet-mgcb-editor --version 3.8.4-preview.1
47-
dotnet tool install dotnet-mgcb-editor-linux --version 3.8.4-preview.1
48-
dotnet tool install dotnet-mgcb-editor-windows --version 3.8.4-preview.1
49-
dotnet tool install dotnet-mgcb-editor-mac --version 3.8.4-preview.1
45+
dotnet tool install dotnet-mgcb --version {{mgDevelopVersion}}
46+
dotnet tool install dotnet-mgcb-editor --version {{mgDevelopVersion}}
47+
dotnet tool install dotnet-mgcb-editor-linux --version {{mgDevelopVersion}}
48+
dotnet tool install dotnet-mgcb-editor-windows --version {{mgDevelopVersion}}
49+
dotnet tool install dotnet-mgcb-editor-mac --version {{mgDevelopVersion}}
5050
```
5151

5252
**Replacing the preview version with the specific version you wish to install.**
@@ -65,7 +65,7 @@ This step is optional, if you intend to generate a new project using the latest
6565
1. Simply run the following from the command line:
6666

6767
```dotnetcli
68-
dotnet new install MonoGame.Templates.CSharp::3.8.4-preview.1
68+
dotnet new install MonoGame.Templates.CSharp::{{mgDevelopVersion}}
6969
```
7070

7171
**Replacing the preview version of MonoGame at the end of the command with the specific version you wish to install.**
@@ -77,7 +77,7 @@ At this time, the Visual Studio marketplace does not support preview versions of
7777
The Extension can be downloaded from the latest `GitHub Actions` build used to generate the preview build.
7878

7979
1. Go to the [MonoGame GitHub repository](https://github.com/MonoGame/MonoGame/actions) and select the "Actions" tab.
80-
1. Find the build with the associated tag, e.g. [`v3.8.4-preview.1`](https://github.com/MonoGame/MonoGame/actions/runs/14713318149)
80+
1. Find the build with the associated tag, e.g. [`{{mgDevelopVersion}}`](https://github.com/MonoGame/MonoGame/actions/runs/14713318149)
8181
1. In the `Artifacts` for the build, you should see the extensions installer `MonoGame.Templates.VSExtension.vsix`
8282
1. Click on the "Download Icon" on the far right-hand side of the row.
8383
1. Once downloaded, run the `vsix` which will update your installation of the extensions package.

articles/migration/migrate_38.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Upgrading MonoGame from 3.8.x to latest
3-
description: A guide on upgrading a MonoGame v3.8 project to the current 3.8.4.1+ releases of MonoGame.
3+
description: A guide on upgrading a MonoGame v3.8 project to the current {{mgVersion}}+ releases of MonoGame.
44
---
55

66
Upgrading existing projects from earlier 3.8 releases should be straightforward for most platforms.
@@ -10,7 +10,7 @@ Upgrading existing projects from earlier 3.8 releases should be straightforward
1010
1111
- The critical difference from pre 3.8.2 builds, [is that the MGCB Editor is no longer a global .NET tool](#addupdate-dotnet-toolsjson-configuration) and the MGCB editor is now included as part of the specific project through the use of the dotnet tooling configuration `dotnet-tools.json` file located in the `.config` folder in your solution/project.
1212

13-
- The major difference from 3.8.4 onwards is that we recommend using .NET 9 in your client project, but it is not mandatory, we are also simplifying the `csproj` configuration to reduce management for developers from 3.8.4.1.
13+
- The major difference from {{mgVersion}} onwards is that we recommend using .NET 9 in your client project, but it is not mandatory, we are also simplifying the `csproj` configuration to reduce management for developers from {{mgVersion}}.
1414

1515
> For iOS/Android however, DotNet 9 at a minimum is Mandatory, [see details here](#iosipados-and-android-considerations).
1616
@@ -58,8 +58,8 @@ Make sure you update the MonoGame references to the latest version, this can be
5858
- Use the [Updating NuGet package dependencies](../getting_to_know/howto/HowTo_Install_Preview_Release.md#updating-nuget-package-dependencies) documentation as part of the "Preview Release installation instructions", which states you should run the following commands (the example is for `DesktopGL`, use other platforms accordingly):
5959

6060
```dotnetcli
61-
dotnet add package MonoGame.Framework.DesktopGL -v 3.8.4.1
62-
dotnet add package MonoGame.Content.Builder.Task -v 3.8.4.1
61+
dotnet add package MonoGame.Framework.DesktopGL -v {{mgVersion}}
62+
dotnet add package MonoGame.Content.Builder.Task -v {{mgVersion}}
6363
```
6464
6565
> [!NOTE]
@@ -95,31 +95,31 @@ or alternatively you can do the following:
9595
"isRoot": true,
9696
"tools": {
9797
"dotnet-mgcb": {
98-
"version": "3.8.4.1",
98+
"version": "{{mgVersion}}",
9999
"commands": [
100100
"mgcb"
101101
]
102102
},
103103
"dotnet-mgcb-editor": {
104-
"version": "3.8.4.1",
104+
"version": "{{mgVersion}}",
105105
"commands": [
106106
"mgcb-editor"
107107
]
108108
},
109109
"dotnet-mgcb-editor-linux": {
110-
"version": "3.8.4.1",
110+
"version": "{{mgVersion}}",
111111
"commands": [
112112
"mgcb-editor-linux"
113113
]
114114
},
115115
"dotnet-mgcb-editor-windows": {
116-
"version": "3.8.4.1",
116+
"version": "{{mgVersion}}",
117117
"commands": [
118118
"mgcb-editor-windows"
119119
]
120120
},
121121
"dotnet-mgcb-editor-mac": {
122-
"version": "3.8.4.1",
122+
"version": "{{mgVersion}}",
123123
"commands": [
124124
"mgcb-editor-mac"
125125
]

articles/migration/updating_versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ dotnet restore
6262
Regardless of the development environment, users will need to update the dotnet tools manifest file manually to use the newest version of the *MonoGame Content Builder*. To do this:
6363

6464
1. Open the *.config/dotnet-tools.json* manifest file located in the project root directory
65-
2. Update the version specified for each tool to the current version of MonoGame (currently this is `3.8.4`).
65+
2. Update the version specified for each tool to the current version of MonoGame (currently this is `{{mgVersion}}`).
6666
3. Save the changes
6767

6868
Once these changes are made, open a command prompt or terminal at the root of the project directory and enter the following commands

0 commit comments

Comments
 (0)