Skip to content

Commit

Permalink
Merge pull request #3 from JakeLegendXIII/feature/migration-missing-u…
Browse files Browse the repository at this point in the history
…ninstallation-text

Add 3.8.0 to 3.8.1 dotnet tools uninstallation info
  • Loading branch information
SimonDarksideJ authored May 12, 2024
2 parents e55adfb + 3845933 commit f0afd37
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 15 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ on:
push:
branches:
- 'main'
pull_request:
branches:
- 'main'

workflow_dispatch:

permissions:
Expand Down
36 changes: 27 additions & 9 deletions articles/migrate_38.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ Migrating from 3.8.0 should be straightforward for most platforms.

The major difference is that 3.8.1 now requires .NET 6 and Visual Studio 2022. You can follow the [environment setup tutorial](getting_started/index.md) to make sure that you are not missing any components.

The MGCB Editor is no longer a global .NET tool and we recommend that you use the new Visual Studio 2022 extension which helps accessing it without the need of CLI commands.
The MGCB Editor is no longer a global .NET tool and we recommend that you use the new Visual Studio 2022 extension which helps with accessing it without the need of CLI commands.


::: note
It is also recommended that you uninstall the older global versions of the .NET tools as described below.
:::

## WindowsDX, DesktopGL, and UWP

Expand All @@ -30,41 +35,54 @@ Then edit your MonoGame ```PackageReference``` to point to 3.8.1:

### Accessing MGCB and MCGB Editor without a global tool

MGCB Editor is no longer a .NET global tool, and doesn't need to be installed or registered.
The MGCB Editor is no longer a .NET global tool, and does not need to be installed or registered. When migrating from 3.8.0, it is recommended that you **uninstall** the global versions of the tools. You can accomplish that with these commands:

```
dotnet tool uninstall dotnet-mgcb -g
dotnet tool uninstall dotnet-2mgfx -g
dotnet tool uninstall dotnet-mgcb-editor -g
```

::: tip
**Do not** run the ``` dotnet tool install ``` on 3.8.1, as it would break 3.8.1.
:::

You will also need to setup a dotnet-tools configuration file.

However, if you are migrating from 3.8.0, you will need to setup a configuration file. Next to your ```.csproj```, create a folder nammed ```.config``` and a file within it nammed ```dotnet-tools.json``` with this content:
- Next to your ```.csproj```create a folder named ```.config```
- Add a file within the folder named ```dotnet-tools.json``` with the following content:

```json
{
"version": 1,
"isRoot": true,
"tools": {
"dotnet-mgcb": {
"version": "3.8.1.263",
"version": "3.8.1.303",
"commands": [
"mgcb"
]
},
"dotnet-mgcb-editor": {
"version": "3.8.1.263",
"version": "3.8.1.303",
"commands": [
"mgcb-editor"
]
},
"dotnet-mgcb-editor-linux": {
"version": "3.8.1.263",
"version": "3.8.1.303",
"commands": [
"mgcb-editor-linux"
]
},
"dotnet-mgcb-editor-windows": {
"version": "3.8.1.263",
"version": "3.8.1.303",
"commands": [
"mgcb-editor-windows"
]
},
"dotnet-mgcb-editor-mac": {
"version": "3.8.1.263",
"version": "3.8.1.303",
"commands": [
"mgcb-editor-mac"
]
Expand All @@ -73,7 +91,7 @@ However, if you are migrating from 3.8.0, you will need to setup a configuration
}
```

Please note that you can't use the ```3.8.1.*``` wildcard in the ```dotnet-tools.json``` file (tool versions have to be fully qualified). We strongly recommand that the versions match the MonoGame version referenced in your ```.csproj``` (if you're using the ```*``` wildcard, make sure that they don't end up mismatching if the nugets are updated without you noticing).
Please note that you cannot use the ```3.8.1.*``` wildcard in the ```dotnet-tools.json``` file (tool versions have to be fully qualified). We strongly recommand that the versions match the MonoGame version referenced in your ```.csproj``` (if you are using the ```*``` wildcard, make sure that they do not end up mismatching if the nugets are updated without you noticing).

You will also need to add this to your ```.csproj```:

Expand Down
8 changes: 5 additions & 3 deletions articles/whats_new.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: What's New
description: What's new with the release of MonoGame 3.8.1
title: Whats New
description: Whats new with the release of MonoGame 3.8.1
---

# What's New
# Whats New

The MonoGame 3.8.1 release marks some big changes since 3.8.0 in how we build and distribute.

Expand All @@ -20,6 +20,8 @@ MonoGame 3.8.1 now comes with an optional Visual Studio extension which will ins

This extension is available for Visual Studio 2022, and Visual Studio 2022 for Mac.

If you are migrating from 3.8.0 it is recommended to uninstall the existing global MGCB .NET tools. It would be a good idea to review the [Migrating from 3.8.0](migrate_38.md) documentation, as there are changes to how 3.8.1 works with the .NET tools and the new extension.

## Visual Studio 2019 and prior are no longer supported

Since .NET 6 is not supported by Visual Studio 2019, starting with MonoGame 3.8.1 it will no longer be possible to build games with it.
Expand Down

0 comments on commit f0afd37

Please sign in to comment.