From 9df357fc453fa9f77661fac9451ce6510ba2ca62 Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:01:36 -0500 Subject: [PATCH 1/8] Added preface article --- articles/building_2d_games/index.md | 74 +++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 articles/building_2d_games/index.md diff --git a/articles/building_2d_games/index.md b/articles/building_2d_games/index.md new file mode 100644 index 0000000..aa4da23 --- /dev/null +++ b/articles/building_2d_games/index.md @@ -0,0 +1,74 @@ +--- +title: Building 2D Games with MonoGame +description: A beginner tutorial for building 2D games with MonoGame. +--- + +## Who This Is For + +This documentation is meant to be an introduction to game development and MonoGame. Readers should have a foundational understanding of C# and be comfortable with concepts such as classes and objects. + +> [!NOTE] +> If you are just getting started with C# for the first time, I would recommend following the official [Learn C#](https://dotnet.microsoft.com/en-us/learn/csharp) tutorials provided by Microsoft. These are free tutorials that teach you programming concepts as well as the C# languages. Once you feel you have a good foundation with that, come back and continue here. + +## How This Documentation Is Organized + +This documentation will introduce game development concepts using the MonoGame framework while walking the reader through the development of a Snake clone. The documentation is organized such that each chapter should be read sequentially, with each introducing new concepts and building off of the previous chapters. + +> [!CAUTION] +> This is currently a work in progress and is not finished. + +| Chapter | Summary | +| ------- | ------- | +| | | + +In additional to the chapter documentation, supplemental documentation is also provided to give a more in-depth look at different topics with MonoGame. These are provided through the Appendix documentation below: + +| Appendix | Summary | +| -------- | ------- | +| | | + +## Conventions Used in This Documentation + +The following conventions are used in this documentation + +### Italics + +*Italics* are used for emphasis, technical terms, and paths such as file paths including filenames and extensions. + +### Inline Code Blocks + +`Inline code` blocks are used for methods, functions, and variable names when they are discussed with the body a text paragraph. + +### Code Blocks + +```cs +// Example Code Block +public void Foo() { } +``` + +Code blocks are used to show code examples with syntax highlighting + +## MonoGame + +If you ever have questions about MonoGame or would like to talk with other developers to share ideas or just hang out with us, you can find us in the various MonoGame communities below + +* [Discord](https://discord.gg/monogame) +* [GitHub Discussions Forum](https://github.com/MonoGame/MonoGame/discussions) +* [Community Forums (deprecated)](https://community.monogame.net/) +* [Reddit](https://www.reddit.com/r/monogame/) +* [Facebook](https://www.facebook.com/monogamecommunity) + +## Note From Author + +> I have been using MonoGame for the past several years (since 2017). It was a time in my game development journey where I was looking for something that I had more control over. I didn't want to spend the time to write a full game engine, but I also wanted to have more control than what the current engines at the time (i.e. Unity) offered. At that time, there was a vast amount of resources available for getting started, but none of them felt like they fit a good beginner series. Even now, the resources available still seem this way. They either require the reader to have a great understanding of game development and programming, or they assume the reader has none and instead focuses on teaching programming more than teaching MonoGame. Even still, some relied too heavily on third party libraries, others were simply very bare bones asking the reader to just copy and paste code without explaining the *what* of it all. +> +> Since then, I have written various small self contained tutorials on different topics for MonoGame to try and give back to the community for those getting started. I also participate regularly in the community discussion channels, answering questions and offering technical advice, so I'm very familiar with the topics and pain points that users get hung up on when first starting out. +> +> My hopes with this documentation is to take the lessons I've learned, and what I've learned from helping others, to fill the gap that I wanted filled when I first started MonoGame. To present using MonoGame in a straight forward way, introducing concepts and building off of them as we go along in a way that makes sense and is easy to follow. +> +> \- Christopher Whitley (Aristurtle) + +## Acknowledgements + +> [!NOTE] +> Acknowledgments will be added at a later time to recognize everyone that assisted with editing and reviewing this documentation. \ No newline at end of file From 28e35bcf3bcd27af5ff87d5f2c5c2fed0a7be8c8 Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:01:42 -0500 Subject: [PATCH 2/8] Updated toc --- articles/toc.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/articles/toc.yml b/articles/toc.yml index 2e3c54f..718e591 100644 --- a/articles/toc.yml +++ b/articles/toc.yml @@ -106,6 +106,8 @@ href: migration/updating_versions.md - name: Samples and Demos href: samples.md +- name: Building 2D Games + href: building_2d_games/ - name: Community Tutorials href: tutorials.md - name: Console Access From 3c34ca9be90afa10b9fca55908fbfa16a5240212 Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Wed, 6 Nov 2024 10:51:04 -0500 Subject: [PATCH 3/8] Move to tutorials directory --- articles/toc.yml | 7 +++++-- articles/{ => tutorials}/building_2d_games/index.md | 0 articles/{tutorials.md => tutorials/index.md} | 0 3 files changed, 5 insertions(+), 2 deletions(-) rename articles/{ => tutorials}/building_2d_games/index.md (100%) rename articles/{tutorials.md => tutorials/index.md} (100%) diff --git a/articles/toc.yml b/articles/toc.yml index 718e591..8b8cdaa 100644 --- a/articles/toc.yml +++ b/articles/toc.yml @@ -106,8 +106,11 @@ href: migration/updating_versions.md - name: Samples and Demos href: samples.md -- name: Building 2D Games - href: building_2d_games/ +- name: Tutorials + href: tutorials/ + items: + - name: Building 2D Games + href: tutorials/building_2d_games/ - name: Community Tutorials href: tutorials.md - name: Console Access diff --git a/articles/building_2d_games/index.md b/articles/tutorials/building_2d_games/index.md similarity index 100% rename from articles/building_2d_games/index.md rename to articles/tutorials/building_2d_games/index.md diff --git a/articles/tutorials.md b/articles/tutorials/index.md similarity index 100% rename from articles/tutorials.md rename to articles/tutorials/index.md From 92bb76d6602e76f18a84c29758829311ce0337d3 Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Wed, 6 Nov 2024 11:02:16 -0500 Subject: [PATCH 4/8] revert changes so only new doc is in pr --- articles/toc.yml | 5 ----- articles/{tutorials/index.md => tutorials.md} | 0 2 files changed, 5 deletions(-) rename articles/{tutorials/index.md => tutorials.md} (100%) diff --git a/articles/toc.yml b/articles/toc.yml index 8b8cdaa..2e3c54f 100644 --- a/articles/toc.yml +++ b/articles/toc.yml @@ -106,11 +106,6 @@ href: migration/updating_versions.md - name: Samples and Demos href: samples.md -- name: Tutorials - href: tutorials/ - items: - - name: Building 2D Games - href: tutorials/building_2d_games/ - name: Community Tutorials href: tutorials.md - name: Console Access diff --git a/articles/tutorials/index.md b/articles/tutorials.md similarity index 100% rename from articles/tutorials/index.md rename to articles/tutorials.md From bd96a3471c629c9b8ef0a519d01b73d8b535ae4f Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Wed, 6 Nov 2024 11:24:09 -0500 Subject: [PATCH 5/8] Reword sentence per recommendation --- articles/tutorials/building_2d_games/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/tutorials/building_2d_games/index.md b/articles/tutorials/building_2d_games/index.md index aa4da23..7e53787 100644 --- a/articles/tutorials/building_2d_games/index.md +++ b/articles/tutorials/building_2d_games/index.md @@ -64,7 +64,7 @@ If you ever have questions about MonoGame or would like to talk with other devel > > Since then, I have written various small self contained tutorials on different topics for MonoGame to try and give back to the community for those getting started. I also participate regularly in the community discussion channels, answering questions and offering technical advice, so I'm very familiar with the topics and pain points that users get hung up on when first starting out. > -> My hopes with this documentation is to take the lessons I've learned, and what I've learned from helping others, to fill the gap that I wanted filled when I first started MonoGame. To present using MonoGame in a straight forward way, introducing concepts and building off of them as we go along in a way that makes sense and is easy to follow. +> With this documentation, I hope to take the lessons I've learned and provide a tutorial series that I wish was available when I first started.. To present using MonoGame in a straight forward way, introducing concepts and building off of them as we go along in a way that makes sense and is easy to follow. > > \- Christopher Whitley (Aristurtle) From bdf4a1d401e3a0d6cbef980877fb78824a4a0131 Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Mon, 18 Nov 2024 11:06:45 -0500 Subject: [PATCH 6/8] Add source files column for chapters that will have them --- articles/tutorials/building_2d_games/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/tutorials/building_2d_games/index.md b/articles/tutorials/building_2d_games/index.md index 7e53787..f973f52 100644 --- a/articles/tutorials/building_2d_games/index.md +++ b/articles/tutorials/building_2d_games/index.md @@ -17,9 +17,9 @@ This documentation will introduce game development concepts using the MonoGame f > [!CAUTION] > This is currently a work in progress and is not finished. -| Chapter | Summary | -| ------- | ------- | -| | | +| Chapter | Summary | Source Files | +| ------- | ------- | ------------ | +| | | | In additional to the chapter documentation, supplemental documentation is also provided to give a more in-depth look at different topics with MonoGame. These are provided through the Appendix documentation below: From 47822932982757fa163f2c34c0a7e47d5d68f3ca Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Mon, 18 Nov 2024 11:18:33 -0500 Subject: [PATCH 7/8] Add introduction paragraph --- articles/tutorials/building_2d_games/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/articles/tutorials/building_2d_games/index.md b/articles/tutorials/building_2d_games/index.md index f973f52..032f008 100644 --- a/articles/tutorials/building_2d_games/index.md +++ b/articles/tutorials/building_2d_games/index.md @@ -3,6 +3,8 @@ title: Building 2D Games with MonoGame description: A beginner tutorial for building 2D games with MonoGame. --- +This tutorial covers game development concepts using the MonoGame framework as our tool. Throughout each chapter, we'll explore game development with MonoGame, introducing new concepts to build upon previous ones as we go. We'll create a Snake game, which will serve as the vehicle to apply the concepts learned throughout the tutorial. The goal of this tutorial is to give you a solid foundation in 2D game development with MonoGame and provide you with reusable modules that you can jump start future projects. + ## Who This Is For This documentation is meant to be an introduction to game development and MonoGame. Readers should have a foundational understanding of C# and be comfortable with concepts such as classes and objects. From f16f2960628530a7a5815d4deab288fb41a0b98d Mon Sep 17 00:00:00 2001 From: Christopher Whitley <103014489+AristurtleDev@users.noreply.github.com> Date: Mon, 18 Nov 2024 11:23:01 -0500 Subject: [PATCH 8/8] Expand contractions --- articles/tutorials/building_2d_games/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/tutorials/building_2d_games/index.md b/articles/tutorials/building_2d_games/index.md index 032f008..7e53b3a 100644 --- a/articles/tutorials/building_2d_games/index.md +++ b/articles/tutorials/building_2d_games/index.md @@ -3,7 +3,7 @@ title: Building 2D Games with MonoGame description: A beginner tutorial for building 2D games with MonoGame. --- -This tutorial covers game development concepts using the MonoGame framework as our tool. Throughout each chapter, we'll explore game development with MonoGame, introducing new concepts to build upon previous ones as we go. We'll create a Snake game, which will serve as the vehicle to apply the concepts learned throughout the tutorial. The goal of this tutorial is to give you a solid foundation in 2D game development with MonoGame and provide you with reusable modules that you can jump start future projects. +This tutorial covers game development concepts using the MonoGame framework as our tool. Throughout each chapter, we will explore game development with MonoGame, introducing new concepts to build upon previous ones as we go. we will create a Snake game, which will serve as the vehicle to apply the concepts learned throughout the tutorial. The goal of this tutorial is to give you a solid foundation in 2D game development with MonoGame and provide you with reusable modules that you can jump start future projects. ## Who This Is For