You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Report any errors, bugs, or unexpected behaviors related to presence.nvim
3
+
title: "[Bug]: "
3
4
labels: [bug]
5
+
assignees:
6
+
- jiriks74
4
7
body:
5
8
- type: markdown
6
9
attributes:
7
10
value: |
8
11
Before reporting, please search [existing issues](https://github.com/andweeb/presence.nvim/issues) and make sure that presence.nvim is updated to the latest version.
12
+
13
+
- type: checkboxes
14
+
attributes:
15
+
label: Are you on the latest version?
16
+
options:
17
+
- label: I have updated to the latest version.
18
+
required: true
19
+
20
+
- type: checkboxes
21
+
attributes:
22
+
label: Have you tried it with default config?
23
+
options:
24
+
- label: I have tried the default config.
25
+
required: true
26
+
9
27
- type: textarea
10
28
attributes:
11
29
label: "Description"
12
30
description: "A short summary of the error, bug, or unexpected behavior you're facing."
13
31
validations:
14
32
required: true
33
+
15
34
- type: textarea
16
35
attributes:
17
36
label: "Neovim version"
18
37
description: "Output of `nvim --version`"
19
38
render: markdown
20
39
placeholder: |
21
-
NVIM v0.6.0-dev+209-g0603eba6e
40
+
NVIM: v0.6.0-dev+209-g0603eba6e
22
41
Build type: Release
23
-
LuaJIT 2.1.0-beta3
42
+
LuaJIT: 2.1.0-beta3
43
+
value: |
44
+
NVIM:
45
+
Build type:
46
+
LuaJIT:
24
47
validations:
25
48
required: true
49
+
26
50
- type: input
27
51
attributes:
28
52
label: "OS information"
29
53
placeholder: "macOS 12.0.1"
30
54
validations:
31
55
required: true
56
+
32
57
- type: textarea
33
58
attributes:
34
59
label: "Steps to reproduce"
35
-
description: "Steps to reproduce the issue with your config(s) if applicable"
60
+
description: "Steps to reproduce the issue with your config(s) if applicable."
36
61
placeholder: |
37
62
1. Setup presence.nvim with `require("presence"):setup({...})`
38
63
2. Run Neovim with `nvim test.txt`
39
64
3. ...
40
65
validations:
41
66
required: true
67
+
42
68
- type: textarea
43
69
attributes:
44
70
label: "Logs"
45
-
description: "The full list of `:messages` from one or more `nvim` instances"
71
+
description: "The full list of `:messages` from one or more `nvim` instances.\nPlease insert the logs into code blocks."
72
+
placeholder: |
73
+
<details>
74
+
75
+
```
76
+
[presence.nvim] Using runtime path: /run/user/1000
77
+
[presence.nvim] Using Discord IPC socket path: /run/user/1000/discord-ipc-0
78
+
[presence.nvim] Checking Discord IPC socket at /run/user/1000/discord-ipc-0...
79
+
```
80
+
81
+
</details>
82
+
value: |
83
+
<details>
84
+
85
+
```
86
+
87
+
```
88
+
89
+
</details>
46
90
validations:
47
91
required: true
92
+
93
+
- type: textarea
94
+
attributes:
95
+
label: "Aditional info"
96
+
description: "If you'd like to add anything else put it here."
* Requires [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0) or higher
31
-
* Rich Presence should work automatically after installation (unless you're using WSL, in which case [see here](https://github.com/andweeb/presence.nvim/wiki/Rich-Presence-in-WSL))
32
-
* If you're using an unofficial Discord package on Linux ([flatpak](https://flathub.org/apps/details/com.discordapp.Discord), [snap](https://snapcraft.io/discord), etc.), you may need to follow some instructions to expose the Discord socket on your system (e.g. [flatpak instructions](https://github.com/flathub/com.discordapp.Discord/wiki/Rich-Precense-(discord-rpc)))
Configuration is not necessary for Rich Presence to work. But for those that want to override the default configs, the following options are available to configure in either Lua or VimL.
52
+
53
+
Configuration is not necesary unless you want to override the default config.
54
+
55
+
If you want to change the default config here are your options in Lua and VimL:
36
56
37
57
### Lua
38
-
Require the plugin and call `setup` with a config table with one or more of the following keys:
58
+
59
+
Require the plugin and call `setup` with a config table with one or more of the
60
+
following keys:
39
61
40
62
```lua
41
63
-- The setup config table shows all available config options with their default values:
@@ -44,7 +66,7 @@ require("presence").setup({
44
66
auto_update=true, -- Update activity based on autocmd events (if `false`, map or manually execute `:lua package.loaded.presence:update()`)
45
67
neovim_image_text="The One True Text Editor", -- Text displayed when hovered over the Neovim image
46
68
main_image="neovim", -- Main image display (either "neovim" or "file")
47
-
client_id="793271441293967371", -- Use your own Discord application client id (not recommended)
69
+
client_id="1172122807501594644", -- Use your own Discord application client id (not recommended)
48
70
log_level=nil, -- Log messages at or above this level (one of the following: "debug", "info", "warn", "error")
49
71
debounce_timeout=10, -- Number of seconds to debounce events (or calls to `:lua package.loaded.presence:update(<filename>, true)`)
50
72
enable_line_number=false, -- Displays the current line number instead of the current project
@@ -65,13 +87,15 @@ require("presence").setup({
65
87
```
66
88
67
89
### VimL
90
+
68
91
Or if global variables are more your thing, you can use any of the following instead:
92
+
69
93
```viml
70
94
" General options
71
95
let g:presence_auto_update = 1
72
96
let g:presence_neovim_image_text = "The One True Text Editor"
73
97
let g:presence_main_image = "neovim"
74
-
let g:presence_client_id = "793271441293967371"
98
+
let g:presence_client_id = "1172122807501594644"
75
99
let g:presence_log_level
76
100
let g:presence_debounce_timeout = 10
77
101
let g:presence_enable_line_number = 0
@@ -91,23 +115,48 @@ let g:presence_line_number_text = "Line %s out of %s"
91
115
```
92
116
93
117
## Troubleshooting
94
-
* Ensure that Discord is running
95
-
* Ensure that your Neovim version is 0.5 or higher
96
-
* Ensure Game Activity is enabled in your Discord settings
97
-
* Enable logging and inspect the logs after opening a buffer
98
-
* Set the [`log_level`](#lua) setup option or [`g:presence_log_level`](#viml) to `"debug"`
99
-
* Load a file and inspect the logs with `:messages`
100
-
* If there is a `Failed to determine Discord IPC socket` error, your particular OS may not yet be supported
101
-
* If you don't see an existing [issue](https://github.com/andweeb/presence.nvim/issues) or [card](https://github.com/andweeb/presence.nvim/projects/1#column-14183588) for your OS, create a prefixed [issue](https://github.com/andweeb/presence.nvim/issues/new) (e.g. `[Void Linux]`)
102
-
* Still not working and need help? Create a new [issue](https://github.com/andweeb/presence.nvim/issues)!
118
+
119
+
- Ensure that Discord is running
120
+
- Ensure that your Neovim version is 0.5 or higher
121
+
- Ensure Game Activity is enabled in your Discord settings
122
+
- Enable logging and inspect the logs after opening a buffer
123
+
- Set the [`log_level`](#lua) setup option or [`g:presence_log_level`](#viml)
124
+
to `"debug"`
125
+
- Load a file and inspect the logs with `:messages`
126
+
- If there is a `Failed to determine Discord IPC socket` error, your particular
- Ensure that there are no [luacheck](https://github.com/mpeterv/luacheck/)
145
+
errors: `luacheck lua`
109
146
110
147
## Contributing
111
-
Pull requests are very welcome, feel free to open an issue to work on any of the open [todo items](https://github.com/andweeb/presence.nvim/projects/1?add_cards_query=is%3Aopen) or message [droob#1322](https://discordapp.com/users/241953146232897550) on Discord!
112
148
113
-
Asset additions and changes are also welcome! Supported file types can be found in [`file_assets.lua`](lua/presence/file_assets.lua) and their referenced asset files can be found [in this folder](https://www.dropbox.com/sh/j8913f0gav3toeh/AADxjn0NuTprGFtv3Il1Pqz-a?dl=0).
149
+
**Please use [Conventional Commits](https://www.conventionalcommits.org/)
0 commit comments