Skip to content

echebbi/eclipse-discord-integration

Repository files navigation

Discord Rich Presence for Eclipse IDE

Show the world the projects you're working on!

Build Status Documentation Status p2 update site Eclipse Marketplace
Technical Debt codecov

Example of Rich Presence Integration

Discord Rich Presence for Eclipse IDE is a plug-in that uses Rich Presence in order to display information related to your current work in Discord.

Main Features:

Please take a look at the documentation for further information about installation, use and customizations.

Usage

Discord will automatically be notified as soon as the plug-in is installed. The plug-in can be deactivated from the Eclipse's Preferences (Window > Preferences > Discord Rich Presence > Uncheck Activate Rich Presence Integration).

Installation

The plug-in is available in the Eclipse Marketplace.

Drag the following button to your running Eclipse workspace to start the installation:

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client
Or show how to install it manually
  1. Open Eclipse IDE
  2. Go to Help > Install New Software...
  3. Copy the update site’s URL in the Work with textbox:
  4. Hit Enter and wait for the list to load
  5. Check Discord Rich Presence for Eclipse IDE
  6. Click Next then Finish

Troubleshooting

Discord does not detect Eclipse IDE as a game

If Discord is not showing anything, ensure that Eclipse IDE is detected as a game:

  1. Open Discord's User Settings
  2. Go the Games tab
  3. Click on the Add it! button
  4. Select Eclipse IDE

A 'Workbench early startup error' occurs since the plug-in is installed

In case you encounter the following error on startup:

An internal error occurred during: "Workbench early startup".

There is an incompatible JNA native library installed on this system
Expected: 5.1.0
Found: 4.0.1

modify the eclipse.ini file (located next to eclipse.exe) to set the jna.nosys property to true:

-vmargs
-Djna.nosys=true

ℹ️ The -vmargs line should already exist, otherwise you can append it at the end of the file.

Changelog

See CHANGELOG.md.

Contributing

Setup your dev environment
  1. Download the latest Eclipse IDE for RCP Developers release
  2. Clone the repository git clone https://github.com/echebbi/eclipse-discord-integration.git
  3. Import all projects in Eclipse IDE
  4. Open the releng/*.target/*.target file
  5. Click on Set as Target Platform
  6. Wait for the dependencies to be loaded
Technical documentation
  Plug-in's architecture is presented in [CONTRIBUTING.md/how-is-the-plug-in-architected](https://github.com/echebbi/eclipse-discord-integration/blob/master/CONTRIBUTING.md#how-is-the-plug-in-architected).

See CONTRIBUTING.md for further details.

License

The Discord Rich Presence for Eclipse IDE plug-in is licensed under the Eclipse Public License 2.0.

It uses different third-party components which are licensed under:

  • the Apache Public License 2.0
    • java-discord-rpc Copyright (c) 2016 - 2019 Florian Spieß and the java-discord-rpc contributors
  • the MIT License (MIT)

Thanks