Skip to content

Commit 907bea9

Browse files
committed
doc: tweaked getting started to add links for other platforms
1 parent 97d54ba commit 907bea9

File tree

6 files changed

+77
-35
lines changed

6 files changed

+77
-35
lines changed

Docfx/articles/features/avatars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The user's information is not immediately available. You must wait for the `OnRe
1414
This event will contain the current user information, and the [DiscordRpcClient.CurrentUser](xref:DiscordRPC.DiscordRpcClient.CurrentUser) is not valid until it has invoked.
1515

1616
> [!WARNING]
17-
> As described in the [Getting Started](../getting_started/standard.md#events), events are executed in another thread.
17+
> As described in the [Getting Started](../getting_started.md#events), events are executed in another thread.
1818
>
1919
> If you are using a Game Engine, you need to manually use [DiscordRpcClient.Invoke](xref:DiscordRPC.DiscordRpcClient.Invoke) on your main thread or otherwise handle the cross-thread data transfer.
2020

Docfx/articles/getting_started.md renamed to Docfx/articles/getting_started/introduction.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
11
# Getting Started
22
This is a quck start guide on getting very basic presence working.
33

4+
## Platforms
5+
For non-dotnet platforms, there are a variety of guides to get you started
6+
7+
| Platform | Support | Documentation |
8+
|----------|---------|---------------|
9+
| .NET App | ✅ Full Support | [Getting Started](./introduction.md#download) |
10+
| [Godot](https://godotengine.org/) | 🚧 WIP Support | [lachee/discord-rpc-godot](https://github.com/Lachee/discord-rpc-godot/) |
11+
| [Mono](https://www.mono-project.com/) | ⚠️ Seperate Guide | [Mono Guide](./mono.md) |
12+
| [MonoGame](https://monogame.net/) | ⚠️ Seperate Guide | [Mono Guide](./mono.md) |
13+
| [Unity3D](https://unity.com/) | ✅ Full Support | [lachee/discord-rpc-unity](https://github.com/lachee/discord-rpc-unity/) |
14+
| [UWP](https://learn.microsoft.com/en-us/windows/uwp/get-started/universal-application-platform-guide) | ⚠️ Seperate Guide | [UWP Guide](./uwp.md) |
15+
16+
> ✅ Full Support - works out of the box
17+
> ⚠️ Seperate Guide - requires some additional setup
18+
> 🚧 WIP Support - actively being worked on
19+
20+
21+
The following guide will assume a standard .NET application.
22+
423
## Download
524

625
[![Nuget](https://img.shields.io/nuget/v/DiscordRichPresence.svg)](https://www.nuget.org/packages/DiscordRichPresence/)
726
[![GitHub package.json version](https://img.shields.io/github/package-json/v/lachee/discord-rpc-csharp?label=Release)](https://github.com/Lachee/discord-rpc-csharp/tags)
827

928
```sh
10-
nuget install DiscordRichPresence
29+
dotnet add package DiscordRichPresence
1130
```
1231

13-
Install the package [with NuGet](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-nuget-cli). This can be done within the [UI for Visual Studio](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio)
32+
Download the package with [NuGet](https://www.nuget.org/packages/DiscordRichPresence/) to start using in your project.
1433

1534
Unpackaged binaries can be found in the project's [Releases](https://github.com/Lachee/discord-rpc-csharp/releases).
1635

@@ -105,4 +124,10 @@ The [DiscordRPC.Example](https://github.com/Lachee/discord-rpc-csharp/blob/maste
105124

106125
```sh
107126
dotnet run --framework net9 --project DiscordRPC.Example --example=Basic
108-
```
127+
```
128+
129+
# Need More Help?
130+
131+
[![GitHub issues](https://img.shields.io/github/issues-raw/lachee/discord-rpc-csharp.svg?color=green&label=issues%20opened&logo=github)](https://github.com/Lachee/discord-rpc-csharp/issues)
132+
133+
Still stuck? Make a [new GitHub issue](https://github.com/Lachee/discord-rpc-csharp/issues/new)!
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
> [!NOTE]
2+
> This article is a stub and is not complete.
3+
>
4+
> Please help by [expanding it](https://github.com/Lachee/discord-rpc-csharp/blob/master/Docfx/articles/advance/mono.md).
5+
6+
# Mono
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
> [!NOTE]
2+
> This article is a stub and is not complete.
3+
>
4+
> Please help by [expanding it](https://github.com/Lachee/discord-rpc-csharp/blob/master/Docfx/articles/advance/uwp.md).
5+
6+
# UWP / .NET MAUI / WIN UI 3
7+
8+
For now, the library doesn't work on UWP applications until we find the issue and fix it.
9+
10+
In order to make this library work with the WIN UI 3 related applications such as .NET MAUI, you need to define `runFullTrust` Capability inside `Package.appxmanifest`.
11+
12+
Here is an example of how to add `runFullTrust` to your WIN UI 3 application:
13+
14+
`Package.appxmanifest`:
15+
16+
```xml
17+
<?xml version="1.0" encoding="utf-8"?>
18+
19+
<Package
20+
xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
21+
xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
22+
xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
23+
IgnorableNamespaces="uap rescap">
24+
...
25+
<Capabilities>
26+
<rescap:Capability Name="runFullTrust" />
27+
</Capabilities>
28+
</Package>
29+
```
30+
31+
If you use .NET MAUI or WIN UI 3 template for C#, it automatically puts `runFullTrust` capability.
32+

Docfx/articles/intro.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

Docfx/articles/toc.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
- name: Introduction
2-
href: intro.md
3-
41
- name: Getting started
5-
href: getting_started.md
2+
items:
3+
- name: Introduction
4+
href: getting_started/introduction.md
5+
- name: Use with Mono
6+
href: getting_started/mono.md
7+
- name: Use with UWP
8+
href: getting_started/uwp.md
69

710
- name: Activity Types
811
href: features/activity_types.md
@@ -20,4 +23,6 @@
2023
href: features/timestamps.md
2124

2225
- name: Joining & Parties
23-
href: features/joining.md
26+
href: features/joining.md
27+
28+

0 commit comments

Comments
 (0)