Skip to content

Commit

Permalink
Update of README information
Browse files Browse the repository at this point in the history
  • Loading branch information
Zukaritasu committed Aug 18, 2024
1 parent 0a99710 commit 90ec2ed
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# Discord Rich Presence for Notepad++

![GitHub](https://img.shields.io/github/license/Zukaritasu/notepadpp_rpc) ![GitHub all releases](https://img.shields.io/github/downloads/Zukaritasu/notepadpp_rpc/total) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/Zukaritasu/notepadpp_rpc)

<p align="center">
<img src="https://img.shields.io/github/license/Zukaritasu/notepadpp_rpc">
<img src="https://img.shields.io/github/downloads/Zukaritasu/notepadpp_rpc/total">
<img src="https://img.shields.io/github/v/release/Zukaritasu/notepadpp_rpc">
</p>

This plugin shows Discord the file you are currently editing in [Notepad++](https://github.com/notepad-plus-plus/notepad-plus-plus). If you change to another file or open a file the plugin will automatically show the new file you are editing. When you close [Notepad++](https://github.com/notepad-plus-plus/notepad-plus-plus) or disable rich presence the plugin will stop showing in discord what you are editing until you enable the plugin

The plugin has an options window in which you can edit the way the plugin should display the file you are editing, you also have the possibility to create your own application to use your custom images in the rich presence. For more information: [Create Custom Rich Presence](https://github.com/Zukaritasu/notepadpp_rpc/blob/main/DOCUMENTATION.md)

## Installation

To install the plugin manually you must download the plugin from <[Releases](https://github.com/Zukaritasu/notepadpp_rpc/releases)>, then you must create a folder with the name "**DiscordRPC**" in the following path:
To install the plugin manually you must download the plugin from [Releases](https://github.com/Zukaritasu/notepadpp_rpc/releases), then you must create a folder with the name "**DiscordRPC**" in the following path:
* **C:\Program Files\Notepad++\plugins** or
* **C:\Program Files (x86)\Notepad++\plugins**

Expand All @@ -17,10 +22,16 @@ After creating the folder you must unzip the downloaded file and paste it into t

And now it's time! Open Notepad++ and verify that the rich presence is showing up in Discord. Remember that the plugin requires internet connection and to have Discord open, although you can continue editing your files without any problem in case you don't have internet connection or Discord is closed

![](./sample_rpc.png)
<p align="center">
<img src="./sample_rpc.png" alt="Rich Presence">
</p>

*The plugin can currently be found in [The official collection of Notepad++ plugins](https://github.com/notepad-plus-plus/nppPluginList) so by simply opening the plugin manager from Notepad++ you can install it by entering "Discord Rich Presence" in the search box*

<p align="center">
<img src="./images/examples/search-rich-presence.png" alt="Search Rich Presence">
</p>

*The plugin has a default application ID, so it is not necessary to create an application for the plugin to work, only in case you want to create a custom application with your images*

## Contributing
Expand Down
Binary file added images/examples/search-rich-presence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions vstudio/vs.proj/NppPluginTemplate.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -61,20 +61,20 @@
<ConfigurationType>DynamicLibrary</ConfigurationType>
<UseDebugLibraries>true</UseDebugLibraries>
<CharacterSet>Unicode</CharacterSet>
<PlatformToolset>v142</PlatformToolset>
<PlatformToolset>v143</PlatformToolset>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
<ConfigurationType>DynamicLibrary</ConfigurationType>
<UseDebugLibraries>true</UseDebugLibraries>
<CharacterSet>Unicode</CharacterSet>
<PlatformToolset>v142</PlatformToolset>
<PlatformToolset>v143</PlatformToolset>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
<ConfigurationType>DynamicLibrary</ConfigurationType>
<UseDebugLibraries>false</UseDebugLibraries>
<WholeProgramOptimization>true</WholeProgramOptimization>
<CharacterSet>Unicode</CharacterSet>
<PlatformToolset>v142</PlatformToolset>
<PlatformToolset>v143</PlatformToolset>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
<ConfigurationType>DynamicLibrary</ConfigurationType>
Expand Down

0 comments on commit 90ec2ed

Please sign in to comment.