NeutrinoParticles.MonoGame.GL
3.8.14
dotnet add package NeutrinoParticles.MonoGame.GL --version 3.8.14
NuGet\Install-Package NeutrinoParticles.MonoGame.GL -Version 3.8.14
<PackageReference Include="NeutrinoParticles.MonoGame.GL" Version="3.8.14" />
paket add NeutrinoParticles.MonoGame.GL --version 3.8.14
#r "nuget: NeutrinoParticles.MonoGame.GL, 3.8.14"
// Install NeutrinoParticles.MonoGame.GL as a Cake Addin #addin nuget:?package=NeutrinoParticles.MonoGame.GL&version=3.8.14 // Install NeutrinoParticles.MonoGame.GL as a Cake Tool #tool nuget:?package=NeutrinoParticles.MonoGame.GL&version=3.8.14
NeutrinoParticles.MonoGame
The package allows you to render NeutrinoParticles effects in MonoGame game framework.
API documentation
For more info about latest API you can check API documentation pages.
For specific library version refer to Releases page.
Issues and Requests
If you have any request or issue, please, feel free to post it on Issues page. It will be considered ASAP.
Installation
There are two libraries which you will need to install for your MonoGame project to use NeutrinoParticles.
- The first one is
NeutrinoParticles.Core
library. It can be installed only as NuGet package. And it will allow you to attach exported effects as usual classes to you project. - The second one is
NeutrinoParticles.MonoGame
represented by this repository. It can be installed in a few different ways described below.
Install from NuGet
You can use NuGet to install both packages to your project.
NuGet from Command Line
To make it on Windows from command line or on MacOS/Linux, please refer to:
- NuGet CLI installation.
- nuget install command reference.
NuGet from Visual Studio
To install packages in Visual Studio, please refer to this instructions.
Install as DLL
Alternatively, you can download NeutrinoParticles.MonoGame.dll
from Releases page
and attach it to your project.
Install as source codes
Or you can download source code and add/import NeutrinoParticles.MonoGame.csproj
project to your solution.
Quick usage
This quick usage guide shows only programming side of using
NeutrinoPartciles.MonoGame
library. It assumes that you know how to use NeutrinoParticles Editor and already created effect and exported it to your project.Also, it assumes you use default MonoGame project template.
In your ancestor of Game
class add fields to store main NeutrinoParticles context and effect to draw.
public class Game1 : Game
{
...
private NeutrinoParticles.MonoGame.Context neutrinoContext_;
private NeutrinoParticles.MonoGame.ParticleEffect effect_;
Create the context in LoadContent()
.
protected override void LoadContent()
{
neutrinoContext_ = new NeutrinoParticles.MonoGame.Context(
GraphicsDevice,
texturesBasePath: "particles/", // Prefix directory for textures.
generateNoise: true // Allows to use turbulence.
);
Later in the same function create effect model.
var effectModel = new NeutrinoParticles.MonoGame.ParticleEffectModel(
neutrinoContext_,
new NeutrinoParticles.Effect_MyCoolEffect(), // Instance of exported effect model.
Content
);
And create instance of effect to render on the screen.
effect_ = new NeutrinoParticles.MonoGame.ParticleEffect(
effectModel,
position: new Vector3(400, 300, 0)
);
}
Update effect.
protected override void Update(GameTime gameTime)
{
...
effect_.Update(gameTime);
...
}
Draw effect.
protected override void Draw(GameTime gameTime)
{
...
effect_.Draw();
...
}
CI configuring
Install VS2022
- Install it with .NET development for desktops
- Add
MSBuild
toPATH
:C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin\
- Add
TestPlatform
toPATH
:C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\Extensions\TestPlatform\
nuget
- Download it from https://www.nuget.org/downloads and add to
PATH
.NET Core 3.1
- Download and install it from https://dotnet.microsoft.com/en-us/download/dotnet/3.1
- Restart to PATH take the effect
Doxygen
- https://www.doxygen.nl/download.html
- Restart to PATH take the effect
For VirtualBox
Machine must have GPU acceleration ON.
GitLab runner should run in manual, but not service mode. Otherwise there will be DirectX issues for Tests.
Contribution
We will be much appreciated for any fix/feature merge requests and will consider it ASAP.
There are not much rules for such requests, just be sure that all tests are passing.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.1 is compatible. |
.NET Framework | net452 is compatible. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETCoreApp 3.1
- NeutrinoParticles.Core (>= 1.2.2)
-
.NETFramework 4.5.2
- NeutrinoParticles.Core (>= 1.2.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
3.8.14 | 122 | 8/25/2024 |