Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 2.37 KB

README.md

File metadata and controls

101 lines (72 loc) · 2.37 KB
Raw

dart_discord_rpc

Discord Rich Presence for Flutter & Dart apps & games.



Install

Flutter

flutter pub add dart_discord_rpc

Dart CLI

dart pub add dart_discord_rpc

Documentation

For integrating Discord Rich Presence into your application or game, you must create an application at Discord Developer Portal.

Initialize the plugin.

void main() {
    DiscordRPC.initialize();
    runApp(MyApp());
}

Instantiate class.

DiscordRPC rpc = DiscordRPC(
    applicationId: 'APPLICATION_ID',
);

Set or change the user presence.

rpc.start(autoRegister: true);
rpc.updatePresence(
    DiscordPresence(
        state: 'Discord Rich Presence from Dart. 🎯',
        details: 'github.com/alexmercerind/dart_discord_rpc',
        startTimeStamp: DateTime.now().millisecondsSinceEpoch,
        largeImageKey: 'large_image',
        largeImageText: 'This text describes the large image.',
        smallImageKey: 'small_image',
        smallImageText: 'This text describes the small image.',
    ),
);

Clear the user presence.

rpc.clearPresence();

Listen to the events.

rpc.events.listen((event) {
    if (event is DiscordReady) {
        event.user;
    }
    if (event is DiscordErrored) {
        event.errorCode;
        event.message;
    }
    if (event is DiscordJoinGame) {
        event.joinSecret;
    }
    // Other events.
});

There are other features for you to checkout.

Support

Consider supporting the project by starring the repository or buying me a coffee.

License

Copyright (c) 2021 Hitesh Kumar Saini [email protected]

MIT. Contributions welcomed.

See COPYRIGHT for comprehensive licensing information.

Platforms

Supported

  • Windows
  • Linux