diff --git a/README.md b/README.md index 6e77b667..9bc4215b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,23 @@ It makes MonoGame more awesome. [![Join the chat at https://gitter.im/craftworkgames/MonoGame.Extended](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/craftworkgames/MonoGame.Extended?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](http://build.craftworkgames.com/app/rest/builds/buildType:(id:MonoGameExtended_CI)/statusIcon)](http://build.craftworkgames.com/viewType.html?buildTypeId=MonoGameExtended_CI&guest=1) -MonoGame.Extended is an open source extension library for [MonoGame](http://www.monogame.net/). A collection of classes and extensions to make it easier to make games with MonoGame. +MonoGame.Extended is an open source collection of NuGet packages for [MonoGame](http://www.monogame.net/). A collection of classes and extensions to make it easier to make games with MonoGame. + +## Packages + + - **MonoGame.Extended** - the core package creates a solid foundation with sprites, bitmap fonts, collections, serialization, shapes, texture atlases, viewport adapters, cameras, timers, math and diagnostics. + - **MonoGame.Extended.Animations** - animated sprites and sprite sheets. + - **MonoGame.Extended.Collisions (experimental)** - collision detection and response. + - **MonoGame.Extended.Content.Pipeline** - a collection of importers for the [MonoGame Pipeline Tool](http://www.monogame.net/documentation/?page=Using_The_Pipeline_Tool). + - **MonoGame.Extended.Entities (experimental)** - An entity component system. + - **MonoGame.Extended.Graphics** - high performance geometry and sprite rendering. + - **MonoGame.Extended.Gui (wip)** - a gui system built from the ground up for desktop and mobile games. + - **MonoGame.Extended.Input** - event based input listeners with mouse, keyboard, touch and game pad support. + - **MonoGame.Extended.NuclexGui** - a port of the [Nuclex GUI framework](https://nuclexframework.codeplex.com/wikipage?title=Nuclex.UserInterface). + - **MonoGame.Extended.Particles** - high performance particle engine ported from the [Mercury Particle Engine](matthew-davey.github.io/mercury-particle-engine/). + - **MonoGame.Extended.SceneGraphs** - scene graphs and trees. + - **MonoGame.Extended.Tiled** - load and render maps created with the popular [Tiled Map Editor](http://www.mapeditor.org/). + - **MonoGame.Extended.Tweening (experimental)** - tween based animations. ## Patreon Supporters @@ -17,148 +33,41 @@ Thanks to all those that support the project on Patreon! Running an open source ### Special thanks to the top supporters - - Ben + - Ben - Patrick ([PRT Studios](http://prt-studios.com/)) - Benny - Walter - Marcel - Nathanial ([optimuspi](http://www.optimuspi.com/)) - Austin + - McKenzie - If you're not on the list and you should be please let me know! Managing Patreon is a job in itself. +If you're not on the list and you should be please let me know! Managing Patreon is a job in itself. +## Getting Started -## We're working towards the v0.6 release +If you're using the [NuGet packages](https://www.nuget.org/packages?q=monogame.extended) please read the [install guide](http://craftworkgames.github.io/MonoGame.Extended/installation/) to setup the Pipeline tool. -There's a lot going on in the `develop` branch right now. We're working towards the next official release (v0.6.xxx). If you want to keep up with the latest and greatest it's recommended that you: - - - [Install a pre-release NuGet package](https://github.com/craftworkgames/MonoGame.Extended/wiki/How-to-use-the-pre-release-NuGet-packages) or; - - [Build from source](https://github.com/craftworkgames/MonoGame.Extended/wiki/Building-MonoGame.Extended-from-source) - -## Version 0.5 is available on NuGet - -MonoGame.Extended v0.5 was published on 8th April 2016 as [a NuGet package](https://www.nuget.org/packages/MonoGame.Extended/). Please read the [install guide](https://github.com/craftworkgames/MonoGame.Extended/wiki/How-to-install-MonoGame.Extended) to setup the Pipeline tool. - - Install-Package MonoGame.Extended - -This release is compatible with MonoGame 3.5! - -**Note**: If you're still using MonoGame 3.4 you must upgrade to 3.5 for everything to work. - -## Forums -Our forum is part of the [MonoGame community](http://community.monogame.net/category/extended). Please ask any questions or post about problems or bugs that you have found there. Let us know if you're making a game with MonoGame.Extended! - -## Development status -MonoGame.Extended has a growing community of contributors adding to the project all the time. We also have [Nuget packages](https://www.nuget.org/packages/MonoGame.Extended/) of published releases and of course you can [build from source](https://github.com/craftworkgames/MonoGame.Extended/wiki/Building-MonoGame.Extended-from-source) to get the latest and greatest. +Alternately, you might want to [build from source](https://github.com/craftworkgames/MonoGame.Extended/wiki/Building-MonoGame.Extended-from-source) or use a [pre-release NuGet package](https://github.com/craftworkgames/MonoGame.Extended/wiki/How-to-use-the-pre-release-NuGet-packages). Please keep in mind that the project is still evolving. Some breaking API changes are likely to occur as we progress. -## Usage -MonoGame.Extended is a portable class library that sits on top of MonoGame. It's designed to work on all supported platforms using a single portable DLL. At runtime, the portable library will call into the platform specific MonoGame DLL referenced in your project. If you do use it on another platform please [let us know](http://community.monogame.net/category/extended)! +## Forums + +Our forum is part of the [MonoGame community](http://community.monogame.net/category/extended). Please ask any questions or post about problems or bugs that you have found there. Let us know if you're making a game with MonoGame.Extended! ## Documentation -We've got several feature demos in this repository and we're building up [the wiki](https://github.com/craftworkgames/MonoGame.Extended/wiki). You can also pop into [the forums](http://community.monogame.net/c/extended), check out [my blog](http://dylanwilson.net/), ask a question on [gamedev stack overflow](http://gamedev.stackexchange.com/questions/tagged/monogame-extended) or use our [live chat](https://gitter.im/craftworkgames/MonoGame.Extended). - -## How to install - -See the [How to install MonoGame.Extended](https://github.com/craftworkgames/MonoGame.Extended/wiki/How-to-install-MonoGame.Extended) guide. Here's the TL;DR version: - -The library is distributed as a NuGet package. Add a reference to your project using the following command: - - Install-Package MonoGame.Extended - -The package comes with 2 DLLs: - - - MonoGame.Extended.dll - - MonoGame.Extended.Content.Pipeline.dll - -The `MonoGame.Extended.Content.Pipeline.dll` needs to be referenced by the [Pipeline tool](http://www.monogame.net/documentation/?page=Pipeline). To reference the DLL in the Pipeline tool you'll need to edit your `Content.mgcb` file. - -## Roadmap / Features - -#### Animations - - [ ] Tweening** - - [x] Sprite Sheets - - [ ] Game Component** - -#### Content - - [x] Texture Atlases - - [x] Bitmap Fonts - - [x] Tiled Maps - -#### Collision Detection - - [x] Bounding Shapes - - [x] Intersection and overlap testing - -#### Input Management - - [x] Event based input (input listeners) - - [ ] Gesture detection (taps, panning, flinging and pinch zooming) - - [ ] Button Mapping (W=Up, A=Left, Space=Jump, etc) - - [ ] Game components** - -#### Graphics and Scenes - - [x] Sprites - - [x] Scene Graphs - - [x] Camera - - [x] Simple shape rendering - - [ ] Screen Management - -#### GUI System - - [x] Controls - - [x] Label** - - [x] Button (Text or Image)** - - [ ] Toggle Button (Checkbox)** - - [x] Progress Bar - - [x] Text Box** - - [x] Image - - [ ] Slider - - [ ] Layout - - [ ] Canvas - - [ ] Stack Panel - - [ ] Wrap Panel - - [ ] Dock Panel - - [ ] Grid - - [ ] Dialog - - [ ] Window - - [x] Skinning - - [x] Events - - [ ] Drag and Drop - -#### Particle System - - [x] Emitters - - [x] Modifiers (age, drag, gravity, rotation, velocity, vortex) - - [x] Profiles (box, circle, line, point, ring, spray) - - [x] Sprite Batch Renderer - - [ ] Game Component** - -#### Math and Utilities - - [x] Timers - - [x] Virtual Screens (viewport adapters) - - [x] Bounding Shapes - - [x] Collections - - [x] FPS Counter - - [x] Random Numbers - -#### Platforms - - [x] Windows - - [x] Linux - - [x] Mac - - [x] Android^^ - - [ ] iOS^^ - -\** Work in progress - -^^ Not officially tested but should work +We've got several feature demos in the repository and we're working on a new [documentation site](http://craftworkgames.github.io/MonoGame.Extended/). You can also pop into [the forums](http://community.monogame.net/c/extended), check out [my blog](http://dylanwilson.net/), ask a question on [gamedev stack overflow](http://gamedev.stackexchange.com/questions/tagged/monogame-extended) or use our [live chat](https://gitter.im/craftworkgames/MonoGame.Extended). ## Contributing + If you would like to contribute start with one of the following: - Please post your thoughts on our [forum](http://community.monogame.net/category/extended). - Join the discussion on one of the [issues](https://github.com/craftworkgames/MonoGame.Extended/issues). We often use github issues to discuss new features as well. - Talk about it on your [blog](http://dylanwilson.net/) or [twitter](https://twitter.com/craftworkgames). - and of course, you can fork the project. - ## Design goals - The primary goal is to make it easier to *make games*. @@ -167,7 +76,6 @@ If you would like to contribute start with one of the following: - It's *not* a game engine, but extends the framework. - Follows [C# coding guidelines](https://msdn.microsoft.com/en-us/library/ms229002(v=vs.110).aspx). - ## License MonoGame.Extended is released under the [The MIT License (MIT)](https://github.com/craftworkgames/MonoGame.Extended/blob/master/LICENSE). diff --git a/Source/Demos/Demo.Multiplatform/Demo/GameMain.cs b/Source/Demos/Demo.Multiplatform/Demo/GameMain.cs index 032b33f4..1c07430d 100644 --- a/Source/Demos/Demo.Multiplatform/Demo/GameMain.cs +++ b/Source/Demos/Demo.Multiplatform/Demo/GameMain.cs @@ -17,6 +17,7 @@ namespace Demo public class GameMain : Game { + // ReSharper disable once NotAccessedField.Local private readonly GraphicsDeviceManager _graphicsDeviceManager; private Camera2D _camera; private GuiSystem _guiSystem; diff --git a/Source/MonoGame.Extended/MonoGame.Extended.csproj b/Source/MonoGame.Extended/MonoGame.Extended.csproj index df874689..07b7239c 100644 --- a/Source/MonoGame.Extended/MonoGame.Extended.csproj +++ b/Source/MonoGame.Extended/MonoGame.Extended.csproj @@ -133,9 +133,7 @@ - - - +