Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/echebbi/eclipse-discord-integration

Discord's Rich Presence Integration within Eclipse IDE
https://github.com/echebbi/eclipse-discord-integration

discord discord-rich-presence discord-rpc eclipse eclipse-ide eclipse-plugin game

Last synced: about 2 months ago
JSON representation

Discord's Rich Presence Integration within Eclipse IDE

Host: GitHub
URL: https://github.com/echebbi/eclipse-discord-integration
Owner: echebbi
License: other
Created: 2018-02-13T16:01:56.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2021-05-04T05:27:39.000Z (over 3 years ago)
Last Synced: 2024-07-06T03:04:08.985Z (3 months ago)
Topics: discord, discord-rich-presence, discord-rpc, eclipse, eclipse-ide, eclipse-plugin, game
Language: Java
Homepage: https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/
Size: 6.9 MB
Stars: 44
Watchers: 4
Forks: 5
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-discord-activities - Discord Rich Presence for Eclipse IDE - plugin for [Eclipse](https://www.eclipse.org) (Programming/Editing)

README

Discord Rich Presence for Eclipse IDE

Show the world the projects you're working on!

[![Build Status](https://travis-ci.org/echebbi/eclipse-discord-integration.svg?branch=master)](https://travis-ci.org/echebbi/eclipse-discord-integration) [![Documentation Status](https://readthedocs.org/projects/discord-rich-presence-for-eclipse-ide/badge/?version=latest)](https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/?badge=latest) [![Eclipse Marketplace](https://img.shields.io/badge/Eclipse-Marketplace-blue.svg?longCache=true&style=flat&logo=eclipse)](https://marketplace.eclipse.org/content/discord-rich-presence-eclipse-ide)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root&metric=sqale_index)](https://sonarcloud.io/dashboard?id=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root) [![codecov](https://codecov.io/gh/echebbi/eclipse-discord-integration/branch/master/graph/badge.svg)](https://codecov.io/gh/echebbi/eclipse-discord-integration)

_Discord Rich Presence for Eclipse IDE_ is a plug-in that uses [Rich Presence](https://discordapp.com/rich-presence) in order to display information related to your current work in Discord.

## Main Features:

Exposure: have a great project? Show it to the world!

Customization: don't like the wording or the icons? Provide your own!

Extensibility: have a custom Eclipse editor? We can support it!

Privacy: working on a secret project? Show only what you want!

Please [take a look at the documentation](https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/) 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](https://marketplace.eclipse.org/content/discord-rich-presence-eclipse-ide).

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:
- https://echebbi.github.io/eclipse-discord-integration-updates/releases/1.2.2
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
```

> :information_source: The `-vmargs` line should already exist, otherwise you can append it at the end of the file.

## Changelog

See [CHANGELOG.md](CHANGELOG.md).

## Contributing

Setup your dev environment

1. Download the latest _[Eclipse IDE for RCP Developers](https://www.eclipse.org/downloads/packages/)_ 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](CONTRIBUTING.md) for further details.

## License

The Discord Rich Presence for Eclipse IDE plug-in is licensed under the [Eclipse Public License 2.0](https://www.eclipse.org/legal/epl-2.0/).

It uses different third-party components which are licensed under:
- the Apache Public License 2.0
- [java-discord-rpc](https://github.com/MinnDevelopment/java-discord-rpc) Copyright (c) 2016 - 2019 Florian Spieß and the java-discord-rpc contributors
- the MIT License (MIT)
- [fileicons-render](https://github.com/HelloWorld017/fileicons-render) Copyright (c) 2014

## Thanks

- [MinnDevelopment](https://github.com/MinnDevelopment) for [his Java implementation](https://github.com/MinnDevelopment/java-discord-rpc) of Discord RPC.
- [Lorenzo Bettini](https://github.com/LorenzoBettini) for his explanations on [how to publish a p2 composite repository on Bintray](http://www.lorenzobettini.it/2016/02/publish-an-eclipse-p2-composite-repository-on-bintray/).
- [HelloWorld017](https://github.com/HelloWorld017/) for [his adaptation](https://github.com/HelloWorld017/fileicons-render) of [programming language icons](https://github.com/file-icons/atom). These icons are displayed on Discord according to the programming language of the current file.
- The [Eclipse Foundation](https://www.eclipse.org/org/foundation/) for allowing me to display the logo of the Eclipse IDE in Discord's status.