Skip to content

Changes to satisfy #225 #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
101 changes: 100 additions & 1 deletion articles/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<section class="container-xxl my-5">
<h1 id="learn-2d" class="fw-bold"><a href="#learn-2d">2D</a></h1>
<p>A selection of 2D focused content and tutorials.</p>
</section>

<section class="container-xxl mb-5">
<div class="row">
<div class="col-12 col-lg-4 mb-5">
Expand All @@ -25,6 +30,61 @@ description: Tutorials provided by MonoGame community members.
</a>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="/articles/tutorials/index.html"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-filetype-cs"></i> 2D Mobile Deployment - coming soon</div>
<p>
An extension tutorial following on from the Beginner 2D above demonstrating how to take a desktop project to Mobile devices.
</p>
<p class="mt-auto">Coming Soon</p>
</div>
</a>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="/articles/tutorials/index.html"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-lightbulb"></i> 2D Advanced Shaders - coming soon</div>
<p>
An extension tutorial following on from the Beginner 2D above demonstrating advanced shader techniques for 2D projects.
</p>
<p class="mt-auto">See what is coming</p>
</div>
</a>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="/articles/tutorials/index.html"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-lightbulb"></i> 2D Networking - coming soon</div>
<p>
An extension tutorial following on from the Beginner 2D above demonstrating connecting multiple clients together and implementing leaderboards.
</p>
<p class="mt-auto">See what is coming</p>
</div>
</a>
</div>
</div>
</div>
</section>

<section class="container-xxl my-5">
<h1 id="learn-2d" class="fw-bold"><a href="#learn-2d">3D</a></h1>
<p>A selection of 3D focused content and tutorials.</p>
</section>

<section class="container-xxl mb-5">
<div class="row">
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
Expand All @@ -40,6 +100,16 @@ description: Tutorials provided by MonoGame community members.
</a>
</div>
</div>
</div>
</section>

<section class="container-xxl my-5">
<h1 id="learn-2d" class="fw-bold"><a href="#learn-2d">MonoGame Foundation</a></h1>
<p>Links to other related resources and information.</p>
</section>

<section class="container-xxl mb-5">
<div class="row">
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
Expand All @@ -55,7 +125,36 @@ description: Tutorials provided by MonoGame community members.
</a>
</div>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="https://monogame.net/blog/"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-files"></i> Blog</div>
<p>
The official MonoGame Foundation blog for notes, minutes and announcements.
</p>
<p class="mt-auto">View the MonoGame blog</p>
</div>
</a>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="https://monogame.net/bounties/"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-filetype-cs"></i> Bounties</div>
<p>
The Foundation has a number of paid contribution efforts for the Framework, ranging from Tutorials, Framework extensions and samples.
</p>
<p class="mt-auto">Check out the bounties</p>
</div>
</a>
</div>
</div>
</section>

## Other community recommended tutorials
Expand Down
2 changes: 1 addition & 1 deletion external/MonoGame
Submodule MonoGame updated 46 files
+93 −80 .github/workflows/main.yml
+4 −7 MonoGame.Framework.Content.Pipeline/Audio/DefaultAudioProfile.cs
+0 −32 MonoGame.Framework.Content.Pipeline/ExternalTool.cs
+24 −2 MonoGame.Framework.Content.Pipeline/Graphics/DxtBitmapContent.cs
+1 −1 MonoGame.Framework.Content.Pipeline/Graphics/Etc1BitmapContent.cs
+1 −1 MonoGame.Framework.Content.Pipeline/Graphics/Etc2BitmapContent.cs
+15 −17 MonoGame.Framework.Content.Pipeline/MonoGame.Framework.Content.Pipeline.csproj
+13 −13 MonoGame.Framework.Content.Pipeline/README.md
+3 −2 MonoGame.Framework.Content.Pipeline/Utilities/BasisUHelpers.cs
+24 −0 MonoGame.Framework.Content.Pipeline/Utilities/BcnHelpers.cs
+6 −18 MonoGame.Framework.Content.Pipeline/Utilities/CrunchHelpers.cs
+10 −2 MonoGame.Framework.Content.Pipeline/VideoContent.cs
+25 −7 MonoGame.Framework/Content/ContentManager.cs
+1 −1 MonoGame.Framework/Content/ContentTypeReaderManager.cs
+2 −2 MonoGame.Framework/MonoGame.Framework.Android.csproj
+25 −0 MonoGame.Framework/MonoGame.Framework.ConsoleCheck.sln
+2 −2 MonoGame.Framework/MonoGame.Framework.DesktopGL.csproj
+2 −2 MonoGame.Framework/MonoGame.Framework.WindowsDX.csproj
+2 −2 MonoGame.Framework/MonoGame.Framework.iOS.csproj
+1 −1 MonoGame.Framework/Platform/Native/Texture2D.Native.cs
+19 −27 README-packages.md
+11 −11 README.md
+1 −0 Templates/MonoGame.Templates.VSExtension/MonoGame.Templates.VSExtension.csproj
+4 −4 Tools/MonoGame.Content.Builder.Editor.Launcher/MonoGame.Content.Builder.Editor.Launcher.Linux.csproj
+2 −2 Tools/MonoGame.Content.Builder.Editor.Launcher/MonoGame.Content.Builder.Editor.Launcher.Mac.csproj
+2 −2 Tools/MonoGame.Content.Builder.Editor.Launcher/MonoGame.Content.Builder.Editor.Launcher.Windows.csproj
+3 −8 Tools/MonoGame.Content.Builder.Editor/MonoGame.Content.Builder.Editor.Linux.csproj
+3 −7 Tools/MonoGame.Content.Builder.Editor/MonoGame.Content.Builder.Editor.Mac.csproj
+3 −8 Tools/MonoGame.Content.Builder.Editor/MonoGame.Content.Builder.Editor.Windows.csproj
+0 −130 Tools/MonoGame.Content.Builder.Editor/README.md
+0 −5 Tools/MonoGame.Content.Builder.Task/MonoGame.Content.Builder.Task.csproj
+0 −126 Tools/MonoGame.Content.Builder.Task/README.md
+4 −6 Tools/MonoGame.Content.Builder/MonoGame.Content.Builder.csproj
+13 −2 Tools/MonoGame.Effect.Compiler/Effect/CommandLineParser.cs
+64 −32 Tools/MonoGame.Effect.Compiler/Effect/EffectObject.writer.cs
+1 −0 Tools/MonoGame.Effect.Compiler/Effect/Options.cs
+58 −5 Tools/MonoGame.Effect.Compiler/Effect/ShaderProfile.Vulkan.cs
+0 −1 Tools/MonoGame.Effect.Compiler/Effect/ShaderProfile.cs
+1 −1 Tools/MonoGame.Effect.Compiler/GraphicsDevice.cs
+69 −0 Tools/MonoGame.Effect.Compiler/LoadedTypeCollection.cs
+6 −58 Tools/MonoGame.Effect.Compiler/MonoGame.Effect.Compiler.csproj
+63 −3 Tools/MonoGame.Effect.Compiler/Program.cs
+3 −1 Tools/MonoGame.Tools.Tests/MonoGame.Tools.Tests.csproj
+0 −1 build/DeployTasks/UploadArtifactsTask.cs
+1 −1 external/MonoGame.Templates
+18 −1 native/monogame/common/MG_Asset.cpp
35 changes: 34 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: MonoGame Documentation Hub
---

<section class="container-xxl my-5">
<h1 id="monogame-documentation" class="fw-bold"><a href="#monogame-documentation">MonoGame Documentation</a></h1>
<h1 id="learn-monogame" class="fw-bold"><a href="#learn-monogame">Learn</a></h1>
<p>
Whether you are just starting out with MonoGame or you have been using it for years, you can find all documentation and
tutorials here.
Expand Down Expand Up @@ -44,6 +44,24 @@ description: MonoGame Documentation Hub
</a>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="/articles/getting_to_know/index.html"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-patch-question"></i> How To</div>
<p>
A collection of articles focused on answering the common questions asked by developers.
Split in to:
<p>- "How To" guides for building features.</P>
<p>- "What is" articles defining concepts.</P>
</p>
<p class="mt-auto">Click to view guides</p>
</div>
</a>
</div>
</div>
</div>
<div class="row">
<div class="col-12 col-lg-4 mb-5">
Expand Down Expand Up @@ -77,6 +95,21 @@ description: MonoGame Documentation Hub
</a>
</div>
</div>
<div class="col-12 col-lg-4 mb-5">
<div class="mg-card mg-box-shadow h-100">
<a target="_self"
href="/roadmap/index.html"
class="mg-no-link">
<div class="mg-card-body d-flex flex-column h-100">
<div class="mg-card-title"><i class="bi bi-signpost-split"></i> Roadmap</div>
<p>
Check out the future of MonoGame, from current developments to long term goals.
</p>
<p class="mt-auto">Click to view roadmap</p>
</div>
</a>
</div>
</div>
</div>
</section>
<section class="container-xxl mb-5">
Expand Down
13 changes: 11 additions & 2 deletions templates/monogame/partials/footer.tmpl.partial
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@
Issues</a>
</li>
<li class="nav-item mb-2">
<a href="https://www.patreon.com/MonoGame" class="p-0">Patreon</a>
<a href="https://monogame.net/bounties/" class="p-0">Bounties</a>
</li>
<li class="nav-item mb-2">
<a href="https://store.monogame.net/" class="p-0">Store</a>
</li>
</ul>
</div>
Expand Down Expand Up @@ -85,9 +88,15 @@
<a class="mg-social-link hide-external-icon" href="https://www.facebook.com/monogamecommunity" title="Facebook">
<i class="bi bi-facebook"></i>
</a>
<a class="mg-social-link hide-external-icon" href="https://bsky.app/profile/monogame.net" title="Blue Sky">
<i class="bi-moon-stars-fill"></i>
</a>
<a class="mg-social-link hide-external-icon" href="https://twitter.com/MonoGameTeam" title="Twitter">
<i class="bi bi-twitter"></i>
</a>
</a>
<a class="mg-social-link hide-external-icon" href="https://mastodon.cloud/@MonoGame" title="Mastodon">
<i class="bi-mastodon"></i>
</a>
<a class="mg-social-link hide-external-icon" href="https://monogame.net/blog/feed.xml" title="MonoGame Blog">
<i class="bi bi-rss-fill"></i>
</a>
Expand Down
Loading