discordrpc - GitLite

KO | EN

gitlite — search

#react #typescript #golang #android #machine-learning #rust #docker #awesome #cli #vue #security #pytorch #mcp #openai

discordrpc

(★ 51)

Discord Rich Presence Client written in PowerShell

파일 탐색기

최종 버전 다운로드 (.zip)

- - main.yml
- launch.json
- settings.json
- - DiscordRPC.dll
  - DiscordRPC.pdb
  - DiscordRPC.xml
  - Newtonsoft.Json.dll
- Clear-DSTimestamp.ps1
- Get-DSClient.ps1
- Get-DSCurrentUser.ps1
- Get-DSTemplate.ps1
- Get-DSTimerEvent.ps1
- New-DSAsset.ps1
- New-DSButton.ps1
- New-DSClient.ps1
- New-DSLogger.ps1
- New-DSParty.ps1
- New-DSRichPresence.ps1
- New-DSSecret.ps1
- New-DSTimestamp.ps1
- Start-DSClient.ps1
- Stop-DSClient.ps1
- Update-DSAsset.ps1
- Update-DSButton.ps1
- Update-DSRichPresence.ps1
- Update-DSTimestamp.ps1
- - FileIntegrity.Exceptions.ps1
  - FileIntegrity.Tests.ps1
  - Help.Exceptions.ps1
  - Help.Tests.ps1
  - Manifest.Tests.ps1
  - PSScriptAnalyzer.Tests.ps1
- - Integration.Tests.ps1
  - readme.md
- constants.ps1
- pester.ps1
- readme.md
clientids.json
discordrpc.psd1
discordrpc.psm1
LICENSE
logo.png
other-clientids.json
plex.png
presence.png
README.md
todo.md
twitch.png

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img align="left" src=https://user-images.githubusercontent.com/8278033/112738954-e3222000-8f67-11eb-8bcf-fa59b1daa3b1.png alt="discordrpc logo"><p>&nbsp;</p>discordrpc is a Discord Rich Presence Client written in PowerShell that allows you to change your presence to let people know that you're playing with PowerShell.

discordrpc works on PowerShell Core. This means that you can run all commands on <strong>Windows</strong>, <strong>Linux</strong> and <strong>macOS</strong>.

<p>&nbsp;</p>

After seeing the [Discord Presence](https://marketplace.visualstudio.com/items?itemName=icrawl.discord-vscode) plugin for VS Code, I was inspired to do something similar with PowerShell.

I made `discordrpc` as flexible as possible, so you can make your presence all your own, even changing the icons that show up. A wrapper command, `Start-DSClient`, has also been included to make getting started easy.

<p align="center"><img src=./presence.png></p>

# Install

Ensure that Discord is running and that "Game Activity" enabled in your settings.

## Install from PowerShell Gallery

Run the following to install discordrpc from the PowerShell Gallery:

```powershell
Install-Module discordrpc -Scope CurrentUser
```

## Add to profile

`discordrpc` loads fast enough to add to your profile so everyone can always see when you're hanging out in PowerShell. Type `notepad $profile` then add these params and call the command.

```powershell
$params = @{
    Details      = "Version $($PSVersionTable.PSVersion.Major).$($PSVersionTable.PSVersion.Minor)"
    State        = (Split-Path -Path $pwd -Leaf)
    Start        = "Now"
    UpdateScript = {
        # show the directory you are in. you can do anything here.
        Update-DSRichPresence -State (Split-Path -Path $pwd -Leaf)
    }
}

Start-DSClient @params
```

That will show results similar to the image above.

## Image Options
The following images are available to use within your configuration. If you'd like me to add any more, let me know.

| Image                                                                                                                                     | Key    |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| <img src="https://user-images.githubusercontent.com/8278033/112764560-68114600-9009-11eb-8a38-4d0729579b5d.png" width="128" height="128"> | avatar |
| <img src="https://user-images.githubusercontent.com/8278033/112764591-837c5100-9009-11eb-910a-137a56e0277d.png" width="128" height="128"> | icon   |

# Highlights

* You don't just have to show up as Playing PowerShell, you can also select from a variety of apps within `Start-DSClient`. You can see a list using `Get-DSTemplate`. Use the `Template` parameter within Start-DSClient to select the app you'd like to appear as.
* If you don't find an application that matches your needs, you can [create your own application](https://discord.com/developers/applications/) and use your own title and "assets" or icons/images
* You can use the wrapper command for ease or use the underlying commands individually for granular control

# Integrate with other apps

## Twitch
Here's a sample for Twitch using my other module [tvbot](https://github.com/potatoqualitee/twitch).

```powershell
$stream = Get-TvStream
$username = $stream.UserName
$params = @{
    Template     = "Twitch"
    Details      = $stream.Title
    State        = "$($stream.ViewerCount) Viewers"
    Start        = $stream.StartedAt
    Label        = "Watch Stream"
    Url          = "https://twitch.tv/$username"
    TimerRefresh = 30
    UpdateScript = {
        if (-not (Get-TvStream)) {
            Stop-DSClient
        }
    }
}

Start-DSClient @params
```

If I'm livestreaming, it'll appear like this..

<p align="center"><img src=./twitch.png width="334" height="429"></p>

## Plex
Here's a sample for Plex using the community module [PSPlex](https://github.com/bifa2/PSPlex).

This script will update your presence every 60 seconds, updating as you watch new media on Plex.

```powershell
# needs to be global for the timer update
function global:Get-CurrentlyWatching {
    Import-PlexConfiguration
    $session = Get-PlexSession | Where-Object { $psitem.player.state -in "playing", "paused" } | Select -First 1
    $xml = [xml]($session).OuterXml
    $media = $xml.Video

switch ($media.type) {
        "episode" {
            $title = $media.grandparentTitle
            $state = $media.title
        }
        default {
            $title = $media.title
            $state = $media.year
        }
    }
    [pscustomobject]@{
        Title  = $title
        State  = $state
        End    = [int]$media.duration - [int]$media.viewOffset
        Label  = "Watch $title"
        Url    = $media.guid
        Player = $media.player
    }
}
$watching = Get-CurrentlyWatching
$params = @{
    Template       = "Plex"
    Details        = $watching.Title
    State          = $watching.State
    End            = $watching.End
    Label          = $watching.Label
    Url            = $watching.Url
    TimerRefresh   = 60
    UpdateScript   = {
        $watching = global:Get-CurrentlyWatching
        if (-not $watching) {
            Stop-DSClient
        }

if ($watching.Player.state -eq "paused") {
            $timestamp = New-DSTimestamp
        } else {
            $timestamp = New-DSTimestamp -End $watching.End
        }
        $button = New-DSButton -Label $watching.Label -Url $watching.Url
        $params = @{
            Buttons   = $button
            Details   = $watching.Title
            State     = $watching.State
            Timestamp = $timestamp
        }
        Update-DSRichPresence @params
    }
}

Start-DSClient @params
```

If I'm playing Bob's Burgers, it'll appear like this..

<p align="center"><img src=./plex.png></p>

# Advanced commands

If you'd like to control all of the exact outcome, you can use the sample code below.

In the command below, you can use a custom [application ID](https://discord.com/developers/applications/), customize your timer, see info messages and more.

```powershell
$params = @{
    ApplicationID  = "824593663883214948"
    LargeImageKey  = "avatar"
    LargeImageText = "Summoners Rift"
    SmallImageKey  = "icon"
    SmallImageText = "Lvl 7"
    Label          = "Potato 🥔"
    Url            = "https://github.com/potatoqualitee/discordrpc"
    Details        = "Version $($PSVersionTable.PSVersion.Major).$($PSVersionTable.PSVersion.Minor)"
    State          = (Split-Path -Path $pwd -Leaf)
    LoggerType     = "ConsoleLogger"
    LoggerLevel    = "Info"
    TimerRefresh   = 10
    Start          = "Now"
    UpdateScript   = {
        Update-DSAsset -LargeImageText "Timer worked!" -SmallImageText "Lvl 10"
        Update-DSRichPresence -State (Split-Path -Path $pwd -Leaf)
    }
}

Start-DSClient @params
```

This setup will show logs in the console, which is inconvenient unless you are debugging something.

## Build your presence, step by step

Here's the code I used while testing the module. You can use this to see how different settings can change the presence.

```powershell
$assets = New-DSAsset -LargeImageKey avatar -LargeImageText "Summoners Rift" -SmallImageKey icon -SmallImageText "Lvl 7"
$timestamp = New-DSTimestamp -Start (Get-Date).AddMinutes(-3) -End (Get-Date).AddMinutes(3)
$button = New-DSButton -Label "Potato 🥔" -Url https://github.com/potatoqualitee/discordrpc
$party = New-DSParty -Size 10 -Privacy Public -Max 100
$presence = New-DSRichPresence -Asset $assets -State "presence.ps1" -Details "Some details" -Timestamp $timestamp -Buttons $button -Party $party
$logger = New-DSLogger -Type ConsoleLogger -Level Info
$client = New-DSClient -ApplicationID 824593663883214948 -Presence $presence -Logger $logger
```

## See what other commands are available

```powershell
Get-Command -Module discordrpc
```

## Get help

A lot of help has been included. If you want to know more about a command such as `New-DSLogger` run the following:

```powershell
Get-Help New-DSLogger
Get-Help New-DSLogger -Examples
```

# Reference

Discord RPC is a library for interfacing your game with a locally running Discord desktop client. This PowerShell module wraps [Lachee's](https://github.com/Lachee) C# library, [discord-rpc-csharp](https://github.com/Lachee/discord-rpc-csharp/)

You can visit the [Discord Developer Portal](https://discord.com/developers/applications/) to learn more or create your own assets to set your own app name and icons. You'll need to change the `ApplicationID` to the client key you are provided.

When searching for a [list of Client IDs](https://github.com/potatoqualitee/discordrpc/blob/main/clientids.json) already available on Discord, I found the [PreMiD app](https://premid.app/), which is a mature product to show a bunch of rich presences (though not PowerShell). If you'd like to create your own Rich Presence for an app, the code in [their repo](https://github.com/PreMiD) may provide good strategies. Or really, if you like this rich presence functionality and don't want to use PowerShell, [premid.app](https://github.com/PreMiD) is awesome and just works.