Skip to content

Commit c4eb32b

Browse files
Merge pull request MonoGame#38 from MonoGame/feature/content_update
Migration of XNA upgraded documentation and general tidy up
2 parents 2f235bc + 1dbce67 commit c4eb32b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1699
-176
lines changed

articles/getting_started/1_setting_up_your_development_environment_unix.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
---
22
title: Setting up your development environment for macOS and Linux
3-
description: A step-by-step guide for setting up your development environment on macOS and Linux.
3+
description: This section provides a step-by-step guide for setting up your development environment on macOS and Linux.
44
---
55

6-
# Setting up your development environment for macOS and Linux
7-
8-
This section provides a step-by-step guide for setting up your development environment on macOS and Linux.
9-
106
The only development environment that MonoGame officially supports on Linux is [Visual Studio Code](https://code.visualstudio.com/).
117

12-
## Install .NET 6 SDK
8+
## Install .NET 8 SDK
139

1410
- .NET SDK at: [https://dotnet.microsoft.com/en-us/download](https://dotnet.microsoft.com/en-us/download)
1511
- If you are intending to target mobile platforms, make sure that you have the corresponding workload installed
@@ -34,6 +30,7 @@ code --install-extension ms-dotnettools.csharp
3430
```
3531

3632
If you want, you can also install the C# Dev Kit extensions, which are not open source:
33+
3734
```sh
3835
code --install-extension ms-dotnettools.csdevkit
3936
code --install-extension ms-dotnettools.dotnet-maui

articles/getting_started/1_setting_up_your_development_environment_vscode.md

Lines changed: 88 additions & 76 deletions
Large diffs are not rendered by default.

articles/getting_started/1_setting_up_your_development_environment_windows.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
---
22
title: Setting up your development environment for Windows
3-
description: A step-by-step guide for setting up your development environment on Windows.
3+
description: This section provides a step-by-step guide for setting up your development environment on Windows.
44
---
55

6-
# Setting up your development environment for Windows
7-
8-
This section provides a step-by-step guide for setting up your development environment on Windows.
9-
106
MonoGame can work with most .NET compatible tools, but we recommend [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)
117

128
Alternatively, you can use [JetBrains Rider](https://www.jetbrains.com/rider/) or [Visual Studio Code](https://code.visualstudio.com/).
@@ -37,31 +33,31 @@ To create new MonoGame projects from within Visual Studio 2022, you will need to
3733
1. Launch Visual Studio 2022
3834
2. Select **Continue without code**. This will launch Visual Studio without any project or solution opened.
3935

40-
![Visual Studio Launcher Continue Without Code](images/1_continue_without_code.png)
36+
![Visual Studio Launcher Continue Without Code](images/1_continue_without_code.png)
4137

4238
3. Click "*Extensions -> Manage Extensions* in the Visual Studio 2022 menu bar. This will open the Manage Extensions dialog window.
4339

44-
![Extensions -> Manage Extensions Menu Selection](images/1_visual_studio_extension_menu.png)
40+
![Extensions -> Manage Extensions Menu Selection](images/1_visual_studio_extension_menu.png)
4541

4642
4. Use the search box in the top-right corner of the Manage Extensions dialog window to search for **MonoGame**, then click the **MonoGame Framework C# project templates** extension as shown below and download it to install it.
4743

48-
![Visual Studio Extension Manager](images/1_visual_studio_extension_manager.png)
44+
![Visual Studio Extension Manager](images/1_visual_studio_extension_manager.png)
4945

5046
5. After it is downloaded, an alert will appear at the bottom of the Manage Extensions window that states "Your changes will be scheduled. The modifications will begin when all Microsoft Visual Studio windows are closed." Click the **Close** button, then close Visual Studio 2022.
5147

5248
6. After closing Visual Studio 2022, a VSIX Installer window will open confirming that you want to install the **MonoGame Framework C# project templates** extension. Click the **Modify** button to accept the install.
5349

54-
![VSIX Installer Window](images/1_vsix_installer_window.png)
50+
![VSIX Installer Window](images/1_vsix_installer_window.png)
5551

5652
You now have the MonoGame templates installed and are ready to create new projects.
5753

5854
**Next up:** [Creating a new project](2_creating_a_new_project_vs.md)
5955

6056
## [Alternative] Install the .NET 6 SDK (compatible with JetBrains Rider and Visual Studio Code)
6157

62-
If you prefer to use JetBrains Rider or Visual Studio Code, and after installing either of them, you will also need to [install the .NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0).
58+
If you prefer to use JetBrains Rider or Visual Studio Code, and after installing either of them, you will also need to [install the .NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
6359

64-
Once the .NET 6 SDK is installed, you can open a Command Prompt and install the MonoGame templates by typing the following command:
60+
Once the .NET 8 SDK is installed, you can open a Command Prompt and install the MonoGame templates by typing the following command:
6561

6662
```sh
6763
dotnet new --install MonoGame.Templates.CSharp

articles/getting_started/2_creating_a_new_project_netcore.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Creating a new project
2+
title: .NET CLI (JetBrains Rider or Visual Studio Code)
33
description: A step-by-step guide for creating a new project using JetBrains Rider or Visual Studio Code.
44
---
55

6-
# .NET CLI (JetBrains Rider or Visual Studio Code)
7-
86
This guide will walk you through building a starter game with MonoGame using only the command line/terminal on your operating system and a lightweight coding tool of your choice (such as [Visual Studio Code](https://code.visualstudio.com/) or [JetBrains Rider](https://www.jetbrains.com/rider/)).
97

10-
> It is assumed that you have already properly installed the .NET 6 SDK and MonoGame.
8+
> [!NOTE]
9+
> It is assumed that you have already properly installed the .NET 8 SDK and MonoGame.
1110
11+
> [!IMPORTANT]
1212
> Be aware that for iOS/iPadOS and Android, development might be limited when using the .NET CLI. Many of the development features for those targets are exclusive to Visual Studio 2022.
1313
1414
## Create a MonoGame Project
@@ -23,13 +23,13 @@ You can now create new MonoGame projects. To do that:
2323

2424
For example:
2525

26-
```
26+
```cli
2727
dotnet new mgdesktopgl -o MyGame
2828
```
2929

3030
> To know which platform identifier (short name) to use for your project, please refer to [Target Platforms](./platforms.md), or type the following command into the command prompt to list the installed templates and their corresponding short names:
31-
>
32-
> ```
31+
>
32+
> ```cli
3333
> dotnet new -l
3434
> ```
3535

articles/getting_started/2_creating_a_new_project_vs.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: Creating a new project
2+
title: Creating a Project with Visual Studio 2022
33
description: A step-by-step guide for creating a new project using Visual Studio
44
---
55

6-
# Creating a Project with Visual Studio 2022
7-
86
This guide will walk you through building a starter game with MonoGame using Windows and Visual Studio 2022.
97

8+
> [!NOTE]
109
> It is assumed that you have already properly installed Visual Studio 2022 and MonoGame.
1110
1211
Start Visual Studio 2022 and select **New Project...** in the upper left corner.

articles/getting_started/3_understanding_the_code.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
22
title: Understanding the Code
3-
description: A look at the code that is generated after creating a new project.
3+
description: This tutorial will go over the code that is generated when you start a blank project.
44
---
55

6-
# Understanding the Code
7-
8-
This tutorial will go over the code that is generated when you start a blank project.
9-
6+
> [!NOTE]
107
> For help with creating a project, please look at the Creating a New Project section of the [Getting Started guide](index.md).
118
129
Within the **Game.cs** class file, which is the core of any MonoGame project, you will find several critical sections necessary for your game to run:

articles/getting_started/4_adding_content.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
22
title: Adding Content
3-
description: Learn how to add content such as images or sounds to your game.
3+
description: This tutorial will go over adding content such as images or sounds to your game.
44
---
55

6-
# Adding Content
7-
8-
This tutorial will go over adding content such as images or sounds to your game.
9-
6+
> [!NOTE]
107
> For help with creating a project, please look at the [Creating a New Project](index.md) section of the Getting Started guide.
118
129
## MonoGame Content Builder Tool (MGCB Editor)

articles/getting_started/5_adding_basic_code.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: Adding Basic Code
3-
description: Learn how to add basic logic to your game.
3+
description: This tutorial will go over adding basic logic to your game
44
---
55

6-
# Adding Basic Code
7-
8-
This tutorial will go over adding basic logic to your game, continuing from where [Adding Content](4_adding_content.md) left off.
6+
> [!NOTE]
7+
> this tutorial continues from where [4. Adding Content](4_adding_content.md) left off.
98
109
---
1110

@@ -133,14 +132,14 @@ Find the **Update** method in the Game1.cs class file and add:
133132
if(Joystick.LastConnectedIndex == 0)
134133
{
135134
JoystickState jstate = Joystick.GetState(PlayerIndex.One);
136-
135+
137136
float updatedBallSpeed = ballSpeed * (float)gameTime.ElapsedGameTime.TotalSeconds;
138-
137+
139138
if (jstate.Axes[1] < 0)
140139
{
141140
ballPosition.Y -= updatedBallSpeed;
142141
}
143-
else if (jstate.Axes[1] > 0)
142+
else if (jstate.Axes[1] > 0)
144143
{
145144
ballPosition.Y += updatedBallSpeed;
146145
}

articles/getting_started/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
---
22
title: Getting Started
3-
description: Get started creating games with MonoGame.
3+
description: This section walks you through the basics of MonoGame, and helps you to create your first game.
44
---
55

6-
# Getting Started
7-
8-
This section walks you through the basics of MonoGame, and helps you to create your first game.
9-
106
First, select the operating system and toolset you will be working with to create your first MonoGame project, then continue reading to understand the basic layout of a MonoGame project.
117

128
By the end of this tutorial set, you will have a working project to build for your target platform and will be ready to tackle your next steps.

articles/getting_started/packaging_games.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ title: Package games for distribution
33
description: How to package your game for distribution.
44
---
55

6-
# Package games for distribution
7-
8-
Once your game is ready to be published, it is recommended that you package it properly for consumption by players.
9-
106
## Desktop games
117

128
To publish desktop games, it is recommended that you build your project as a [self-contained](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained) .NET application. As such, your game will require absolutely no external dependencies and should run out-of-the-box as-is.
@@ -35,14 +31,14 @@ We recommend using the .tar.gz archiving format to preserve the execution permis
3531

3632
From the .NET CLI:
3733

38-
```
34+
```cli
3935
dotnet publish -c Release -r osx-x64 /p:PublishReadyToRun=false /p:TieredCompilation=false --self-contained
4036
dotnet publish -c Release -r osx-arm64 /p:PublishReadyToRun=false /p:TieredCompilation=false --self-contained
4137
```
4238

4339
We recommend that you distribute your game as an [application bundle](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html). Application bundles are directories with the following file structure:
4440

45-
```
41+
```text
4642
YourGame.app                    (this is your root folder)
4743
    - Contents
4844
        - Resources
@@ -56,6 +52,7 @@ YourGame.app                    (this is your root folder)
5652
```
5753

5854
The contents of the entry point script:
55+
5956
```sh
6057
#!/bin/bash
6158

@@ -67,7 +64,7 @@ else
6764
fi
6865
```
6966

70-
The Info.plist file is a standard macOS file containing metadata about your game. Here's an example file with required and recommended values set:
67+
The `Info.plist` file is a standard macOS file containing metadata about your game. Here is an example file with required and recommended values set:
7168

7269
```xml
7370
<?xml version="1.0" encoding="UTF-8"?>

0 commit comments

Comments
 (0)