Emacs client for Mastodon
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
mousebot 4ab5a4bb8d tl--more: message before and after appending more toots. 1 week ago
fixture test: fixture: update client.plstore file 3 months ago
lisp tl--more: message before and after appending more toots. 1 week ago
test Merge pull request '2FA login support' (#255) from Red_Starfish/mastodon-up.el:login into develop 2 months ago
.gitignore gitignore 2 weeks ago
.travis.yml Add Matrix notification to Travis 5 years ago
Cask Fix tests. 7 months ago
LICENSE Fix #43 with LICENSE file 5 years ago
README.org Merge branch 'develop' 2 months ago

README.org

mastodon.el updated

This is an updated version of the great but seemingly dormant mastodon client for emacs.

This is now the version available via MELPA.

[The original readme is below.]

It adds the following features:

Profiles:
display profile metadata fields
display pinned toots first
display relationship (follows you/followed by you)
display toots/follows/followers counts
links/tags/mentions in profile bios are active links
show a lock icon for locked accounts
G view follow suggestions
R, a, r view/accept/reject follow requests
V view your favorited toots
i toggle pinning of toots
U update your profile bio note
O jump to own profile
Notifications:
follow requests now also appear in notifications
a, j accept/reject follow request
notifications for when a user posts (mastodon-tl--enable-notify-user-posts)
Timelines:
C copy url of toot at point
d delete your toot at point, and reload current timeline
D delete and redraft toot at point, preserving reply/CW/visibility
W, M, B (un)follow, (un)mute, (un)block author of toot at point
k, K toggle bookmark of toot at point, view bookmarked toots
I, c, d view, create, and delete filters
display image captions
display polls and vote on them
images are links to the full image, can be zoomed/rotated/saved (see image keymap)
images scale properly
toot visibility (direct, followers only) icon appears in toot bylines
display toot's number of favorites, boosts and replies
play gifs and videos (requires mpv to be installed)
customize option to cache images
Toots:
mention booster in replies by default
replies preserve visibility status/CW of original toot
autocompletion of user mentions, via company-mode (must be installed to work)
C-c C-a media uploads, asynchronous
media upload previews displayed in toot compose buffer
C-c C-n and sensitive media/nsfw flag
C-c C-e add emoji (if emojify installed)
download and use your instance's custom emoji
server's maximum toot length shown in toot compose buffer
Search:
S search (posts, users, tags) (NB: only posts you have interacted with are searched)

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.

The minimum Emacs version is now 27.1. But if you are running an older version it shouldn't be very hard to get it working.

live-updating timelines: mastodon-async-mode

(code taken from https://github.com/alexjgriffith/mastodon-future.el.)

Works for federated, local, and home timelines and for notifications. It's a little touchy, one thing to avoid is trying to load a timeline more than once at a time. It can go off the rails a bit, but it's still pretty cool.

To enable, it, add (require 'mastodon-async) to your init.el. Then you can view a timeline with one of the commands that begin with mastodon-async--stream-.

translating toots

You can translate toots with mastodon-toot--translate-toot-text. At the moment this requires lingva.el, a little interface I wrote to https://lingva.ml, to be installed to work.

You could easily modify the simple function to use your emacs translator of choice (google-translate, babel, go-translate, etc.), you just need to fetch the toot's content with (mastodon-tl--content toot) and pass it to your translator function as its text argument. Here's what mastodon-toot--translate-toot-text looks like:

  (defun mastodon-toot--translate-toot-text ()
    "Translate text of toot at point.
    Uses `lingva.el'."
      (interactive)
      (let* ((toot (mastodon-tl--property 'toot-json)))
        (if toot
            (lingva-translate nil (mastodon-tl--content toot))
          (message "No toot to translate?"))))

NB: dependencies

This version depends on the library request (for uploading attachments). You can install it from MELPA, or https://github.com/tkf/emacs-request. It also depends on seq.

Optional dependencies:

  • company for autocompletion of mentions when composing a toot
  • emojify for inserting and viewing emojis
  • mpv and mpv.el for viewing videos and gifs
  • lingva.el for translating toots

NB: bugs

This repo also incorporates fixes for two bugs that were never merged into the upstream repo:

contributing

Contributions are welcome.

  1. Create an here on codeberg 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.

Original README

Installation

Clone this repository and add the lisp directory to your load path. Then, require it and go.

    (add-to-list 'load-path "/path/to/mastodon.el/lisp")
    (require 'mastodon)

Or, with use-package:

  (use-package mastodon
    :ensure t)

MELPA

Add MELPA to your archives:

  (require 'package)
  (add-to-list 'package-archives
               '("melpa" . "http://melpa.org/packages/") t)

Update and install:

M-x package-refresh-contents RET

M-x package-install RET mastodon RET

Emoji

mastodon-mode will enable 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 Discover is installed. It is not required.

if you have Discover, add the following to your Emacs init configuration:

  (require 'mastodon-discover)
  (with-eval-after-load 'mastodon (mastodon-discover))

Or, with use-package:

  (use-package mastodon
    :ensure t
    :config
    (mastodon-discover))

Usage

Instance

You need to set 2 variables in your init file to get started:

  1. mastodon-instance-url
  2. mastodon-active-user

(see their doc strings for details). For example If you want to post toots as "example_user@social.instance.org", then put this in your init file:

    (setq mastodon-instance-url "https://social.instance.org"
          mastodon-active-user "example_user")

Then restart Emacs and run M-x mastodon. Make sure you are connected to internet before you do this. If you have multiple mastodon accounts you can activate one at a time by changing those two variables and restarting Emacs.

If you have been using mastodon.el before this change and the above steps do not work it's advisable that you delete the old file specified by mastodon-client--token-file and restart Emacs and follow the steps again.

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

Here are the features I plan to implement before putting mastodon.el on MELPA.

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 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 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 toot or leave an issue.