hiro/ement.el
1
0
Fork 0
mirror of https://github.com/vale981/ement.el synced 2025-03-05 09:21:37 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ement.el/README.org
Adam Porter 3dbcf93eb3 Add readme and screenshot 
It makes no sense to publish this until the login code is written.
2020-12-01 03:43:42 -06:00

2.7 KiB
Raw Blame History

ement.el

Ement.el is a new Matrix client for Emacs. It's basic at the moment, but it can be used to send and read messages.

Screenshots

This is what a room buffer looks like.

/hiro/ement.el/media/commit/3dbcf93eb3226229951bb9bf35721f01af64db92/images/screenshot.png

Installation

Quelpa

The recommended way to install is with quelpa-use-package, like this:

  ;; Install and load `quelpa-use-package'.
  (package-install 'quelpa-use-package)
  (require 'quelpa-use-package)

  ;; Install `plz' HTTP library (not on MELPA yet).
  (use-package plz
    :quelpa (plz :fetcher github :repo "alphapapa/plz.el"))

  ;; Install Ement.
  (use-package ement
    :quelpa (ement :fetcher github :repo "alphapapa/ement.el"))

Manual

If you want to install it manually, it's simple enough, but you should know what you're doing, and you're on your own.

Usage

  1. Call command ement-connect to connect.
  2. Wait for initial sync to complete (which can take a few moments–initial sync JSON requests can be large).
  3. Call command ement-view-room to select a room buffer to view.

In the room buffer:

  • RET sends a message.
  • TAB / <backtab> moves between messages.
  • M-v at the top of the buffer loads older messages.
  • v views an event's source.
  • g syncs new messages (not necessary if auto sync is enabled; see below).
  • r selects another room.

Tips

  • You can customize settings in the ement group.

    • Set ement-auto-sync to sync new messages automatically.

Changelog

0.1-pre

Yet to be released.

COMMENT Credits

Development

Bug reports, feature requests, suggestions — oh my!

License

GPLv3