https://github.com/open-unlight/node-discord-game

The Discord Game SDK for Electron.js
https://github.com/open-unlight/node-discord-game

Last synced: 3 months ago
JSON representation

The Discord Game SDK for Electron.js

• Host: GitHub
• URL: https://github.com/open-unlight/node-discord-game
• Owner: open-unlight
• Archived: true
• Created: 2019-10-01T10:41:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-24T19:03:09.000Z (over 2 years ago)
• Last Synced: 2024-09-23T15:08:36.261Z (4 months ago)
• Language: C
• Size: 123 KB
• Stars: 47
• Watchers: 6
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-discord - node-discord-game - The Discord Game SDK for Electron.js. (Game SDK & RPC Bindings)

README

        
Discord Game SDK

===

[![Node CI Status](https://github.com/open-unlight/node-discord-game/workflows/Node%20CI/badge.svg)](https://github.com/open-unlight/node-discord-game/actions?workflow=Node+CI)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fopen-unlight%2Fnode-discord-game.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fopen-unlight%2Fnode-discord-game?ref=badge_shield)

This is node.js module for Electron to integrate with Discord.

## Requirements

* Node.js 11+

* Electron 6.0+

## Windows Setup

The Windows is required to add `dll` to project root, please copy `sdk\{ARCH}\discord_game_sdk.dll` to your project folder to ensure your Electron can access SDK correctly.

## Usage

Before using this module, you have to go to [Discord Developer](https://discord.com/developers/applications/) to create an application.

### Discord

#### create()

Initialize Discord.

```js

const Discord = require('discord-game');

const isRequireDiscord = true;

Discord.create('Client ID', isRequireDiscord);

// => true

```

#### version

Get Discord Game SDK Version

#### runCallback()

Resolve Discord's async behavior and call the callback;

```js

const Discord = require('discord-game');

const isRequireDiscord = true;

Discord.create('Client ID', isRequireDiscord);

setInterval(function() {

  Discord.runCallback(); // => true

}, 1000/60)

```

### Application

#### locale

Get the current locale

#### branch

Get the current branch

#### getOAuth2Token()

Get the user OAuth2 Token.

```js

const Discord = require('discord-game');

const isRequireDiscord = true;

Discord.create('Client ID', isRequireDiscord);

Discord.Application

       .getOAuth2Token()

       .then(function(token) { console.log('Token is', token) });

setInterval(function() {

  Discord.runCallback(); // => true

}, 1000/60)

```

### Activity (aka Rich Presence)

#### update

Update user's rich presence.

```js

const Discord = require('discord-game');

const isRequireDiscord = true;

Discord.create('Client ID', isRequireDiscord);

// All property are optional

const activity = {

  details: 'Details',

  state: 'State',

  assets: {

    largeImage: 'large',

    largeText: 'Large',

    samllImage: 'small',

    smallText: 'Small'

  },

  timestamps: {

    startAt: new Date(),

    endAt: new Date()

  },

  secrets: {

    match: 'match',

    join: 'join',

    spectate: 'spectate'

  },

  party: {

    id: 'id',

    currentSize: 1,

    maxSize: 5

  }

}

const start_at = new Date();

Discord.Activity

       .update(activity)

       .then(function() { console.log('Rich Presence updated') });

setInterval(function() {

  Discord.runCallback(); // => true

}, 1000/60)

```

#### clear

Clear user's rich presence.

```js

Discord.Activity.clear()

```

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fopen-unlight%2Fnode-discord-game.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fopen-unlight%2Fnode-discord-game?ref=badge_large)