RSML in C#¶

RSML for C# is a great and solid choice for learning to use RSML programmatically, as it has the best support.

Installation¶

RSML can be installed in 2 ways: package reference (via NuGet) or project reference (building RSML inside your solution).

Package Reference¶

Installing RSML via its NuGet package is the recommended way to install RSML, as it guarantees stability.

.NET CLIProject FileVisual Studio (PMC)Central Package Management (CPM)

dotnet add package OceanApocalypseStudios.RSML --version 2.0.0

ItemGroup

<PackageReference Include="OceanApocalypseStudios.RSML" Version="2.0.0" />

VS Package Manager Console

NuGet\Install-Package OceanApocalypseStudios.RSML -Version 2.0.0

Directory.Packages.props

<PackageVersion Include="OceanApocalypseStudios.RSML" Version="2.0.0" />

Project File

<PackageReference Include="OceanApocalypseStudios.RSML" />

Project Reference (Not recommended)¶

If, for whatever reason, you need the latest nightly updates, you may also add the RSML project to your solution.

Warning

Please keep in mind that not all nightly updates are guaranteed to be bug-free or stable. Nightly updates are also not documented, only stable versions are.

# Adapt this to your solution structure
cd src/MyAwesomeProject/
dotnet add reference ../../include/RSML/

Git Submodules

If your solution is included in a git repository already, consider using Git Submodules instead.