mirror of
https://github.com/AlexMacocian/MonoGame.Extended.git
synced 2026-07-24 03:56:31 +00:00
autemox
fd59442316
Added precise location of nuget packages folder to clear up confusion about it being in the solution folder (it is not), and by default windows 10 normal search feature does not check the .nuget folder, thus a search for the dll will find nothing and can lead to a lot of confusion for new users.
45 lines
2.8 KiB
Markdown
45 lines
2.8 KiB
Markdown
# Installation
|
|
|
|
MonoGame.Extended is a collection of [portable class libraries](https://msdn.microsoft.com/en-us/library/gg597391) (PCL) designed to be referenced from any MonoGame project to add common extensions and classes for making your games more awesome.
|
|
|
|
The libraries are distributed as [NuGet packages](https://www.nuget.org/packages?q=MonoGame.Extended) and can be installed using the NuGet Package Manager in [Visual Studio](https://www.visualstudio.com), [Xamarin Studio](https://xamarin.com/studio), or [MonoDevelop](http://www.monodevelop.com). They can also be installed by running the following command (or the equivilant command for the package you want to install) in the [Package Manager Console](http://docs.nuget.org/consume/package-manager-console).
|
|
|
|
Install-Package MonoGame.Extended
|
|
|
|
Note that [MonoGame 3.6 will need to be installed](http://www.monogame.net/downloads/) to properly use MonoGame.Extended in your game project.
|
|
|
|
## Referencing the Content Pipeline extension
|
|
|
|
To get the full experience you'll also want to install the Content Pipeline extension:
|
|
|
|
Install-Package MonoGame.Extended.Content.Pipeline
|
|
|
|
This package is not included in MonoGame.Extended and must be installed separately. It won't add any references to your project. Instead it will download a DLL that's intended to be referenced from the [MonoGame Content Pipeline tool](http://www.monogame.net/documentation/?page=Pipeline).
|
|
|
|
You'll need to manually add the reference to your content file (usually `Content.mgcb`) using one of the following methods.
|
|
|
|
### Using the MonoGame Pipeline GUI
|
|
|
|
To add the reference using the Pipeline GUI tool follow these steps:
|
|
|
|
1. Click on the **Content** node in the root of the tree.
|
|
2. In the properties window, modify the **References** property.
|
|
3. Find and add the `MonoGame.Extended.Content.Pipeline.dll`. It's usually located in the **packages** folder of your solution. The default location of the **packages** folder in .NET Core is: C:\Users\[User]\.nuget\packages.
|
|
|
|
|
|
|
|
### Using a text editor
|
|
|
|
An alternative way to add the reference is by manually editing the `Content.mgcb` file in a text editor or Visual Studio. Look for the references section and update it like this:
|
|
|
|
```
|
|
#-------------------------------- References --------------------------------#
|
|
|
|
/reference:..\..\packages\MonoGame.Extended.Content.Pipeline.0.6.372\tools\MonoGame.Extended.Content.Pipeline.dll
|
|
```
|
|
|
|
**Remember:** The `MonoGame.Extended.dll` and the `MonoGame.Extended.Content.Pipeline.dll` come as a pair. Always make sure the version referenced by your game matches the version referenced by the Pipeline tool.
|
|
|
|
That's it! Once you've referenced the library you can start using it to make your games even more awesome.
|
|
|