From 1fb933dfc8bebc789c28c70028bbf9a884d1f8e9 Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Fri, 4 Jul 2025 14:19:24 +0100 Subject: [PATCH 1/5] Changes to satisfy #226 --- articles/toc.yml | 90 ++++++++++++++++---------------- articles/tutorials/index.md | 101 +++++++++++++++++++++++++++++++++++- create/images/placeholder | 0 create/index.md | 93 +++++++++++++++++++++++++++++++++ docfx.json | 2 + index.md | 35 ++++++++++++- toc.yml | 11 ++-- 7 files changed, 278 insertions(+), 54 deletions(-) create mode 100644 create/images/placeholder create mode 100644 create/index.md diff --git a/articles/toc.yml b/articles/toc.yml index 638f8ce4..c6171888 100644 --- a/articles/toc.yml +++ b/articles/toc.yml @@ -6,7 +6,7 @@ items: - name: What's New href: whats_new.md - name: Getting Started - build your first 2D game - href: tutorials/building_2d_games/ + href: tutorials/building_2d_games/index.md items: - name: Setting up MacOS href: /articles/getting_started/1_setting_up_your_os_for_development_macos.html @@ -21,36 +21,36 @@ items: - name: Using Visual Studio Code href: /articles/getting_started/2_choosing_your_ide_vscode.html - name: Getting to know MonoGame - href: getting_to_know/ + href: getting_to_know/index.md items: - name: What is - href: getting_to_know/whatis/ + href: getting_to_know/whatis/index.md items: - name: Audio - href: getting_to_know/whatis/audio/ + href: getting_to_know/whatis/audio/index.md - name: Content Pipeline - href: getting_to_know/whatis/content_pipeline/ + href: getting_to_know/whatis/content_pipeline/index.md - name: Graphics - href: getting_to_know/whatis/graphics/ + href: getting_to_know/whatis/graphics/index.md - name: Input - href: getting_to_know/whatis/input/ + href: getting_to_know/whatis/input/index.md - name: The Game Loop - href: getting_to_know/whatis/game_loop/ + href: getting_to_know/whatis/game_loop/index.md - name: Vector / Matrix / Quaternions - href: getting_to_know/whatis/vector_matrix_quat/ + href: getting_to_know/whatis/vector_matrix_quat/index.md - name: MonoGame Class Library - href: getting_to_know/whatis/monogame_class_library/ + href: getting_to_know/whatis/monogame_class_library/index.md - name: How to - href: getting_to_know/howto/ + href: getting_to_know/howto/index.md items: - name: Audio - href: getting_to_know/howto/audio/ + href: getting_to_know/howto/audio/index.md - name: Content Pipeline - href: getting_to_know/howto/content_pipeline/ + href: getting_to_know/howto/content_pipeline/index.md - name: Graphics - href: getting_to_know/howto/graphics/ + href: getting_to_know/howto/graphics/index.md - name: Input - href: getting_to_know/howto/input/ + href: getting_to_know/howto/input/index.md - name: Advanced Topics href: getting_started/index.md items: @@ -63,7 +63,7 @@ items: - name: Tools items: - name: Introduction - href: getting_started/tools/ + href: getting_started/tools/index.md - name: MGCB href: getting_started/tools/mgcb.md - name: MGCB Editor @@ -97,65 +97,65 @@ items: - name: Samples and Demos href: samples.md - name: Tutorials - href: tutorials/ + href: tutorials/index.md items: - name: Building 2D Games - href: tutorials/building_2d_games/ + href: tutorials/building_2d_games/index.md items: - name: "01: What Is MonoGame?" - href: tutorials/building_2d_games/01_what_is_monogame/ + href: tutorials/building_2d_games/01_what_is_monogame/index.md - name: "02: Getting Started" - href: tutorials/building_2d_games/02_getting_started/ + href: tutorials/building_2d_games/02_getting_started/index.md - name: "03: The Game1 File" - href: tutorials/building_2d_games/03_the_game1_file/ + href: tutorials/building_2d_games/03_the_game1_file/index.md - name: "04: Creating a Class Library" - href: tutorials/building_2d_games/04_creating_a_class_library/ + href: tutorials/building_2d_games/04_creating_a_class_library/index.md - name: "05: Content Pipeline" - href: tutorials/building_2d_games/05_content_pipeline/ + href: tutorials/building_2d_games/05_content_pipeline/index.md - name: "06: Working with Textures" - href: tutorials/building_2d_games/06_working_with_textures/ + href: tutorials/building_2d_games/06_working_with_textures/index.md - name: "07: Optimizing Texture Rendering" - href: tutorials/building_2d_games/07_optimizing_texture_rendering/ + href: tutorials/building_2d_games/07_optimizing_texture_rendering/index.md - name: "08: The Sprite Class" - href: tutorials/building_2d_games/08_the_sprite_class/ + href: tutorials/building_2d_games/08_the_sprite_class/index.md - name: "09: The AnimatedSprite Class" - href: tutorials/building_2d_games/09_the_animatedsprite_class/ + href: tutorials/building_2d_games/09_the_animatedsprite_class/index.md - name: "10: Handling Input" - href: tutorials/building_2d_games/10_handling_input/ + href: tutorials/building_2d_games/10_handling_input/index.md - name: "11: Input Management" - href: tutorials/building_2d_games/11_input_management/ + href: tutorials/building_2d_games/11_input_management/index.md - name: "12: Collision Detection" - href: tutorials/building_2d_games/12_collision_detection/ + href: tutorials/building_2d_games/12_collision_detection/index.md - name: "13: Working With Tilemaps" - href: tutorials/building_2d_games/13_working_with_tilemaps/ + href: tutorials/building_2d_games/13_working_with_tilemaps/index.md - name: "14: Sound Effects and Music" - href: tutorials/building_2d_games/14_soundeffects_and_music/ + href: tutorials/building_2d_games/14_soundeffects_and_music/index.md - name: "15: Audio Controller" - href: tutorials/building_2d_games/15_audio_controller/ + href: tutorials/building_2d_games/15_audio_controller/index.md - name: "16: Working with SpriteFonts" - href: tutorials/building_2d_games/16_working_with_spritefonts/ + href: tutorials/building_2d_games/16_working_with_spritefonts/index.md - name: "17: Scenes" - href: tutorials/building_2d_games/17_scenes/ + href: tutorials/building_2d_games/17_scenes/index.md - name: "18: Texture Sampling" - href: tutorials/building_2d_games/18_texture_sampling/ + href: tutorials/building_2d_games/18_texture_sampling/index.md - name: "19: User Interface Fundamentals" - href: tutorials/building_2d_games/19_user_interface_fundamentals/ + href: tutorials/building_2d_games/19_user_interface_fundamentals/index.md - name: "20: Implementing UI with Gum" - href: tutorials/building_2d_games/20_implementing_ui_with_gum/ + href: tutorials/building_2d_games/20_implementing_ui_with_gum/index.md - name: "21: Customizing Gum UI" - href: tutorials/building_2d_games/21_customizing_gum_ui/ + href: tutorials/building_2d_games/21_customizing_gum_ui/index.md - name: "22: Snake Game Mechanics" - href: tutorials/building_2d_games/22_snake_game_mechanics/ + href: tutorials/building_2d_games/22_snake_game_mechanics/index.md - name: "23: Completing the Game" - href: tutorials/building_2d_games/23_completing_the_game/ + href: tutorials/building_2d_games/23_completing_the_game/index.md - name: "24: Shaders" - href: tutorials/building_2d_games/24_shaders/ + href: tutorials/building_2d_games/24_shaders/index.md - name: "25: Packaging Your Game for Distribution" - href: tutorials/building_2d_games/25_packaging_game/ + href: tutorials/building_2d_games/25_packaging_game/index.md - name: "26: Publishing Your Game to itch.io" - href: tutorials/building_2d_games/26_publish_to_itch/ + href: tutorials/building_2d_games/26_publish_to_itch/index.md - name: "27: Conclusion and Next Steps" - href: tutorials/building_2d_games/27_conclusion/ + href: tutorials/building_2d_games/27_conclusion/index.md - name: Console Access href: console_access.md - name: Help and Support diff --git a/articles/tutorials/index.md b/articles/tutorials/index.md index e025369a..51525a47 100644 --- a/articles/tutorials/index.md +++ b/articles/tutorials/index.md @@ -8,6 +8,11 @@ description: Tutorials provided by MonoGame community members. > > Have a tutorial suggestion, article or series that really helped you? Then please [log an issue](https://github.com/MonoGame/docs.monogame.github.io/issues) to get it included. +
+

2D

+

A selection of 2D focused content and tutorials.

+
+
@@ -25,6 +30,61 @@ description: Tutorials provided by MonoGame community members.
+
+
+ +
+
2D Mobile Deployment - coming soon
+

+ An extension tutorial following on from the Beginner 2D above demonstrating how to take a desktop project to Mobile devices. +

+

Coming Soon

+
+ +
+
+
+
+ +
+
2D Advanced Shaders - coming soon
+

+ An extension tutorial following on from the Beginner 2D above demonstrating advanced shader techniques for 2D projects. +

+

See what is coming

+
+ +
+
+
+
+ +
+
2D Networking - coming soon
+

+ An extension tutorial following on from the Beginner 2D above demonstrating connecting multiple clients together and implementing leaderboards. +

+

See what is coming

+
+ +
+
+ +
+ +
+

3D

+

A selection of 3D focused content and tutorials.

+
+ +
+
+
+
+ +
+

MonoGame Foundation

+

Links to other related resources and information.

+
+ +
+
-
+
+
+ +
+
Blog
+

+ The official MonoGame Foundation blog for notes, minutes and announcements. +

+

View the MonoGame blog

+
+ +
+
+
+
+ +
+
Bounties
+

+ The Foundation has a number of paid contribution efforts for the Framework, ranging from Tutorials, Framework extensions and samples. +

+

Check out the bounties

+
+ +
+
## Other community recommended tutorials diff --git a/create/images/placeholder b/create/images/placeholder new file mode 100644 index 00000000..e69de29b diff --git a/create/index.md b/create/index.md new file mode 100644 index 00000000..5528a734 --- /dev/null +++ b/create/index.md @@ -0,0 +1,93 @@ +--- +title: MonoGame Starter Kits +description: Downloadable projects ready to explore MonoGame with. +_disableToc: true +_disableBreadcrumb: true +--- + +
+

Create

+

+ Walk-through projects and samples to begin building your dream game project using MonoGame. +

+
+ +
+
+
+
+ +
+
Blank Project
+

+ Just the bare requirements for a new Desktop solution targetting the Vulkan and DX12 native backends. +
+

Also available using `dotnet new monogamedesktop` from the command-line

+

+

Click to view project

+
+ +
+
+
+
+ +
+
Blank Project
+

+ Just the bare requirements for a new Desktop solution targetting the Vulkan and DX12 native backends. +
+

Also available using `dotnet new monogamedesktop` from the command-line

+

+

Click to view project

+
+ +
+
+
+
+ +
+
Blank Project
+

+ Just the bare requirements for a new Desktop solution targetting the Vulkan and DX12 native backends. +
+

Also available using `dotnet new monogamedesktop` from the command-line

+

+

Click to view project

+
+ +
+
+
+
+ +
+

Resources

+
+ +
+
+
+
+ +
+
Community Resources
+

+ A managed collection of community created resources, guides, tutorials and books to aim MonoGame developers on their journey. +

+

Click to view project

+
+ +
+
+
+
diff --git a/docfx.json b/docfx.json index 1fc4b077..26ffa55f 100644 --- a/docfx.json +++ b/docfx.json @@ -40,6 +40,8 @@ "foundation/**/*.md", "roadmap/**/*.md", "roadmap/**/*.yml", + "create/**/*.md", + "create/**/*.yml", "errors/**/*.md", "toc.yml", "*.md" diff --git a/index.md b/index.md index ee7b440a..cac838a3 100644 --- a/index.md +++ b/index.md @@ -5,7 +5,7 @@ description: MonoGame Documentation Hub ---
-

MonoGame Documentation

+

Learn

Whether you are just starting out with MonoGame or you have been using it for years, you can find all documentation and tutorials here. @@ -44,6 +44,24 @@ description: MonoGame Documentation Hub +

+
+ +
+
How To
+

+ A collection of articles focused on answering the common questions asked by developers. + Split in to: +

- "How To" guides for building features.

+

- "What is" articles defining concepts.

+

+

Click to view guides

+
+ +
+
@@ -77,6 +95,21 @@ description: MonoGame Documentation Hub
+
+
+ +
+
Roadmap
+

+ Check out the future of MonoGame, from current developments to long term goals. +

+

Click to view roadmap

+
+ +
+
diff --git a/toc.yml b/toc.yml index 999ca7a3..d61ad5ee 100644 --- a/toc.yml +++ b/toc.yml @@ -1,16 +1,13 @@ -- name: Documentation +items: +- name: Learn href: / -- name: Roadmap - href: roadmap/ +- name: Create + href: /create - name: Community href: https://monogame.net/community/ - name: Showcase href: https://monogame.net/showcase/ -- name: Blog - href: https://monogame.net/blog/ - name: Bounties href: https://monogame.net/bounties/ -- name: Resources - href: https://monogame.net/resources/ - name: About href: https://monogame.net/about/ \ No newline at end of file From 14da799817db00476e62e8b85b59ac2c5c89997c Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Fri, 18 Jul 2025 11:04:48 +0100 Subject: [PATCH 2/5] Remove create as it moved to the main site --- create/images/placeholder | 0 create/index.md | 93 --------------------------------------- docfx.json | 2 - external/MonoGame | 2 +- toc.yml | 4 +- 5 files changed, 2 insertions(+), 99 deletions(-) delete mode 100644 create/images/placeholder delete mode 100644 create/index.md diff --git a/create/images/placeholder b/create/images/placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/create/index.md b/create/index.md deleted file mode 100644 index 5528a734..00000000 --- a/create/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: MonoGame Starter Kits -description: Downloadable projects ready to explore MonoGame with. -_disableToc: true -_disableBreadcrumb: true ---- - -
-

Create

-

- Walk-through projects and samples to begin building your dream game project using MonoGame. -

-
- -
-
-
-
- -
-
Blank Project
-

- Just the bare requirements for a new Desktop solution targetting the Vulkan and DX12 native backends. -
-

Also available using `dotnet new monogamedesktop` from the command-line

-

-

Click to view project

-
- -
-
-
-
- -
-
Blank Project
-

- Just the bare requirements for a new Desktop solution targetting the Vulkan and DX12 native backends. -
-

Also available using `dotnet new monogamedesktop` from the command-line

-

-

Click to view project

-
- -
-
-
-
- -
-
Blank Project
-

- Just the bare requirements for a new Desktop solution targetting the Vulkan and DX12 native backends. -
-

Also available using `dotnet new monogamedesktop` from the command-line

-

-

Click to view project

-
- -
-
-
-
- -
-

Resources

-
- -
-
-
-
- -
-
Community Resources
-

- A managed collection of community created resources, guides, tutorials and books to aim MonoGame developers on their journey. -

-

Click to view project

-
- -
-
-
-
diff --git a/docfx.json b/docfx.json index 26ffa55f..1fc4b077 100644 --- a/docfx.json +++ b/docfx.json @@ -40,8 +40,6 @@ "foundation/**/*.md", "roadmap/**/*.md", "roadmap/**/*.yml", - "create/**/*.md", - "create/**/*.yml", "errors/**/*.md", "toc.yml", "*.md" diff --git a/external/MonoGame b/external/MonoGame index f7520d18..a3f2380d 160000 --- a/external/MonoGame +++ b/external/MonoGame @@ -1 +1 @@ -Subproject commit f7520d18291d55d830c738a366ab0b09385931bf +Subproject commit a3f2380d9cfeafdfc21cef8a6a1c8336f4b450c8 diff --git a/toc.yml b/toc.yml index d61ad5ee..32f85b40 100644 --- a/toc.yml +++ b/toc.yml @@ -2,12 +2,10 @@ items: - name: Learn href: / - name: Create - href: /create + href: https://monogame.net/create/ - name: Community href: https://monogame.net/community/ - name: Showcase href: https://monogame.net/showcase/ -- name: Bounties - href: https://monogame.net/bounties/ - name: About href: https://monogame.net/about/ \ No newline at end of file From a47cd54c6f154376908806454892e32ae468f10a Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Fri, 18 Jul 2025 11:13:07 +0100 Subject: [PATCH 3/5] Fix footer to match --- templates/monogame/partials/footer.tmpl.partial | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/templates/monogame/partials/footer.tmpl.partial b/templates/monogame/partials/footer.tmpl.partial index 63a577dc..41f7a2dd 100644 --- a/templates/monogame/partials/footer.tmpl.partial +++ b/templates/monogame/partials/footer.tmpl.partial @@ -36,7 +36,10 @@ Issues
  • - Patreon + Bounties +
    • +
  • + Store
    • @@ -85,9 +88,15 @@ + + + - + + + + From c289adf104eb9cba39797e74167431f4bd26a74b Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Fri, 18 Jul 2025 11:15:38 +0100 Subject: [PATCH 4/5] Update links for Bsky and mastodon --- templates/monogame/partials/footer.tmpl.partial | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/monogame/partials/footer.tmpl.partial b/templates/monogame/partials/footer.tmpl.partial index 41f7a2dd..84dd9bf1 100644 --- a/templates/monogame/partials/footer.tmpl.partial +++ b/templates/monogame/partials/footer.tmpl.partial @@ -88,13 +88,13 @@ - + - + From 07ebe98a56018e675265afd8eb127ae91e9d34ea Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Fri, 18 Jul 2025 11:21:13 +0100 Subject: [PATCH 5/5] Revert MonoGame checkout to 3.8.4 --- external/MonoGame | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/external/MonoGame b/external/MonoGame index a3f2380d..caaa1170 160000 --- a/external/MonoGame +++ b/external/MonoGame @@ -1 +1 @@ -Subproject commit a3f2380d9cfeafdfc21cef8a6a1c8336f4b450c8 +Subproject commit caaa1170c48b8d340690014423e1c8bbc0777899