Skip to content

Commit f1c0513

Browse files
committed
[Addition] - Proper README
1 parent 5b275f2 commit f1c0513

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# RL2.API
1+
# RL2.API
2+
[![GitHub Release](https://img.shields.io/github/v/release/RL2-API/RL2.API.svg?logo=github&style=flat-square)](https://github.com/RL2-API/RL2.API/releases/latest)
3+
![Docs](https://img.shields.io/badge/Documentation-Offline-orange?logo=github&style=flat-square)
4+
[![Website](https://img.shields.io/badge/Website-gray?logo=webtrees&logoColor=white&style=flat-square)](https://rl2-modloader.onrender.com/mods/RL2.API)
5+
![RL2.API Logo](https://raw.githubusercontent.com/RL2-API/RL2.ModLoader/main/Assets/ModLoaderIcon-NoText-700x700.png)
6+
7+
8+
RL2.API is a modding API for [Rogue Legacy 2](https://roguelegacy2.com). It requires [RL2.ModLoader](https://github.com/RL2-API/RL2.ModLoader) to function.
9+
10+
11+
## Installation
12+
1. Follow the installation guide for [RL2.ModLoader](https://github.com/RL2-API/RL2.ModLoader)
13+
2. Download the [latest release of RL2.API](https://github.com/RL2-API/RL2.API/releases/latest)
14+
3. Unpack the `.zip` into the `GameInstallation\Rogue Legacy 2_Data\Mods` directory
15+
4. Run the game once to let the mod loader recognise the mod
16+
17+
## Build from source
18+
1. Run `git clone https://github.com/RL2-API/RL2.API --recurse-submodules`
19+
2. Go to `RL2.ModLoader.DevSetup` and run the provided `.exe`
20+
3. Choose your games installation directory
21+
4. Open the solution and build it OR run `dotnet build -c Release`
22+
5. Go to the output directory and copy the `RL2.API` directory from there into `GameInstallation\Rogue Legacy 2_Data\Mods`
23+
6. Run the game once to let the mod loader recognise the mod
24+
25+
## Using RL2.API as a dependency
26+
1. Obtain `RL2.API.dll` and `RL2.API.xml` by following either the "Installation" or "Build from source" section.
27+
2. Add it as a reference in your `.csproj` like this:
28+
```xml
29+
<PropertyGroup>
30+
<Reference Include="YourPath\To\RL2.API.dll" />
31+
<PropertyGroup>
32+
```

0 commit comments

Comments
 (0)