1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
* mastodon.el fork
This is a fork of of the great but seemingly dormant https://github.com/jdenen/mastodon.el.
It adds the following features:
| Profiles: | |
| | display profile metadata fields |
| | display pinned toots on profiles |
| | display relationship (follows you/followed by you) on profiles |
| | display toots/follows/followers counts on profiles |
| | links/tags/mentions in profiles are active links |
| =R=, =C-c a=, =C-c r= | view/accept/reject follow requests |
| =v= | view your favorited toots |
| =i= | toggle pinning of toots |
| =S-C-P= | jump to your profile |
| =U= | update your profile bio note |
| Timelines: | |
| =C= | copy url of toot at point |
| =d= | delete your toot at point |
| =W=, =M=, =B= | (un)follow, (un)mute, (un)block author of toot at point |
| | display polls (very basic for now) |
| | images are links to the full image, can be zoomed/rotated/saved (see their keymap) |
| Toots: | |
| | mention booster in replies by default |
| =C-c C-a= | media uploads |
| =C-c C-n= | and sensitive media/nsfw flag |
| Search: | |
| =S= | search (posts, users, tags) (improved! but still rly basic!) (NB: by default, posts searched will only be those you have interacted with in some way; your instance can optionally enable full search) |
It also makes some small cosmetic changes to make timelines easier to read, and makes some functions asynchronous, based on https://github.com/ieure/mastodon.el.
This updated version is not on MELPA, to use it you need to clone and require it as per the installation instructions below.
The minimum Emacs version is now 25.1. But if you are running an older version it shouldn't be very hard to get it working.
I did this for my own use and to learn more Elisp. Feel free to improve it.
** live-updating timelines
(code adapted from https://github.com/alexjgriffith/mastodon-future.el.)
Works for federated, local, and home timelines and for notifications. It's pretty necro, sometimes it goes off the rails, so use at your own risk. Not a super high priority for me, but some people dig it. The command prefix is =mastodon-async--stream=, and you can load various timelines from within a mastodon session like so:
- =C-c h= (home)
- =C-c f= (federated)
- =C-c l= (local)
- =C-c n= (notifications)
** NB: dependency
This version depends on the library =request= (for uploading attachments). You can install it from MELPA, or https://github.com/tkf/emacs-request.
** NB: bugs
As it stands the client still has some bugs. In particular, when composing a toot, hit =C-g= before sending your toot. If you don't, your draft may disappear. You may also see a related error when you try to add a media attachment. You should be able to run the command again and it should work. See the issues on the original repo.
Some people have also had niggling troubles with initial auth and set-up, but I couldn't reproduce.
** roadmap-ish
I might add a few more features if the ones I added turn out to work ok. Possible additions/amendments:
- [X] update profile note.
- [X] fix loading more notifications re-loads the same ones
- [X] view/accept/reject follow requests in notifications view.
- voting on polls
- better display of polls
- display number of boosts/faves in toot byline
- mention all thread participants in replies
- handle newlines in toots better, for poetry, etc.
- improve async.
It looks like 2-factor auth was never completed in the original repo. It's not a priority for me, auth ain't my thing. If you want to hack on it, its on the develop branch in the original repo.
* Original README
** Installation
Clone this repository and add the lisp directory to your load path.
Then, require it and go.
#+BEGIN_SRC emacs-lisp
(add-to-list 'load-path "/path/to/mastodon.el/lisp")
(require 'mastodon)
#+END_SRC
Or, with =use-package=:
#+BEGIN_SRC emacs-lisp
(use-package mastodon
:ensure t)
#+END_SRC
*** MELPA
Add =MELPA= to your archives:
#+BEGIN_SRC emacs-lisp
(require 'package)
(add-to-list 'package-archives
'("melpa" . "http://melpa.org/packages/") t)
#+END_SRC
Update and install:
=M-x package-refresh-contents RET=
=M-x package-install RET mastodon RET=
*** Emoji
=mastodon-mode= will enable [[https://github.com/iqbalansari/emacs-emojify][Emojify]] if it is loaded in your Emacs environment, so
there's no need to write your own hook anymore. =emojify-mode= is not required.
*** Discover
=mastodon-mode= can provide a context menu for its keybindings if [[https://github.com/mickeynp/discover.el][Discover]] is
installed. It is not required.
if you have Discover, add the following to your Emacs init configuration:
#+BEGIN_SRC emacs-lisp
(require 'mastodon-discover)
(with-eval-after-load 'mastodon (mastodon-discover))
#+END_SRC
Or, with =use-package=:
#+BEGIN_SRC emacs-lisp
(use-package mastodon
:ensure t
:config
(mastodon-discover))
#+END_SRC
** Usage
*** 2 Factor Auth
2FA is not supported yet. It is in the [[https://github.com/jdenen/mastodon.el/milestone/2][plans]] for the =1.0.0= release.
If you have 2FA enabled and try to use mastodon.el, your Emacs client will hang until you `C-g` your way out.
*** Instance
Set =mastodon-instance-url= in your =.emacs= or =customize=. Defaults to the [[https://mastodon.social][flagship]].
#+BEGIN_SRC emacs-lisp
(setq mastodon-instance-url "https://my.instance.url")
#+END_SRC
There is an option to have your user credentials (email address and password) saved to disk so you don't have to re-enter them on every restart.
The default is not to do this because if not properly configured it would save these unencrypted which is not a good default to have.
Customize the variable =mastodon-auth-source-file= if you want to enable this feature.
*** Timelines
=M-x mastodon=
Opens a =*mastodon-home*= buffer in the major mode so you can see toots. You will be prompted for email and password. The app registration process will take place if your =mastodon-token-file= does not contain =:client_id= and =:client_secret=.
**** Keybindings
|-----------------+---------------------------------------------------------|
| Key | Action |
|-----------------+---------------------------------------------------------|
| | /Help/ |
| =?= | Open context menu if =discover= is available |
| | /Timeline actions/ |
| =n= | Go to next item (toot, notification) |
| =p= | Go to previous item (toot, notification) |
| =M-n=/=<tab>= | Go to the next interesting thing that has an action |
| =M-p=/=<S-tab>= | Go to the previous interesting thing that has an action |
| =u= | Update timeline |
| =#= | Prompt for tag and open its timeline |
| =A= | Open author profile of toot under =point= |
| =F= | Open federated timeline |
| =H= | Open home timeline |
| =L= | Open local timeline |
| =N= | Open notifications timeline |
| =P= | Open profile of user attached to toot under =point= |
| =T= | Open thread buffer for toot under =point= |
| | /Toot actions/ |
| =c= | Toggle content warning content |
| =b= | Boost toot under =point= |
| =f= | Favourite toot under =point= |
| =r= | Reply to toot under =point= |
| =n= | Compose a new toot |
| | /Switching to other buffers/ |
| | /Quitting/ |
| =q= | Quit mastodon buffer, leave window open |
| =Q= | Quit mastodon buffer and kill window |
|-----------------+---------------------------------------------------------|
**** Legend
|--------+-------------------------|
| Marker | Meaning |
|--------+-------------------------|
| =(B)= | I boosted this toot. |
| =(F)= | I favourited this toot. |
|--------+-------------------------|
*** Toot toot
=M-x mastodon-toot=
Pops a new buffer/window with a =mastodon-toot= minor mode. Enter the
contents of your toot here. =C-c C-c= sends the toot. =C-c C-k= cancels.
Both actions kill the buffer and window.
If you have not previously authenticated, you will be prompted for your
account email and password. *NOTE*: Email and password are NOT stored by mastodon.el.
Authentication stores your access token in the =mastodon-auth--token=
variable. It is not stored on your filesystem, so you will have to
re-authenticate when you close/reopen Emacs.
**** Customization
The default toot visibility can be changed by setting or customizing the =mastodon-toot--default-visibility= variable. Valid values are ="public"=, ="unlisted"=, ="private"=, or =direct=.
Toot visibility can also be changed on a per-toot basis from the new toot buffer.
**** Keybindings
|-----------+------------------------|
| Key | Action |
|-----------+------------------------|
| =C-c C-c= | Send toot |
| =C-c C-k= | Cancel toot |
| =C-c C-w= | Add content warning |
| =C-c C-v= | Change toot visibility |
|-----------+------------------------|
** Roadmap
[[https://github.com/jdenen/mastodon.el/milestone/1][Here]] are the features I plan to implement before putting mastodon.el on MELPA.
[[https://github.com/jdenen/mastodon.el/milestone/2][Here]] are the plans I have for the =1.0.0= release.
** Contributing
PRs, issues, and feature requests are very welcome!
*** Features
1. Create an [[https://github.com/jdenen/mastodon.el/issues][issue]] detailing the feature you'd like to add.
2. Fork the repository and create a branch off of =develop=.
3. Create a pull request referencing the issue created in step 1.
*** Fixes
1. In an [[https://github.com/jdenen/mastodon.el/issues][issue]], let me know that you're working to fix it.
2. Fork the repository and create a branch off of =develop=.
3. Create a pull request referencing the issue from step 1.
** Connect
If you want to get in touch with me, give me a [[https://mastodon.social/@johnson][toot]] or leave an [[https://github.com/jdenen/mastodon.el/issues][issue]].
|
