A Matrix client for Neovim, bringing chat functionality directly into your editor.

⚠️ Warning: This plugin is currently in beta and under active development. The API may change without prior notice. Use at your own risk and expect breaking changes between updates.

Neoment is a Matrix protocol client implementation for Neovim that allows you to chat, and stay connected without leaving your editor.

Note: Neoment does not currently support End-to-End Encryption (E2EE). Encrypted rooms will not be accessible.

Features:

• List rooms
• Join rooms
• Leave rooms
• View spaces
• Rich-replies
• Edit messages
• Forward messages
• Image display (if you have Snacks)
• Download/open media
• Upload file
• Upload image from clipboard
• Reactions
• Threads
• Mark room as read/unread/favorite/low priority
• Compose messages with markdown support

{
	"Massolari/neoment",
}

-- In your init.lua:
vim.pack.add({
	{
		src = "https://github.com/Massolari/neoment",
		name = "neoment",
	},
})

1. Open Neovim and run :Neoment to authenticate with your Matrix homeserver
2. Provide your username and password
3. The plugin will automatically sync and display your rooms

• :Neoment - Login to your Matrix account. If already logged in, opens the rooms list
• :Neoment logout - Logout and clear session data
• :Neoment rooms - Use vim.ui.select to select and open a room/space
• :Neoment sync_start - Start syncing messages
• :Neoment sync_stop - Stop syncing messages
• :Neoment join <room_id_or_alias> - Join a room by its ID or alias

Neoment uses the global variable vim.g.neoment for configuration. You can set it in your Neovim configuration file (init.lua or equivalent).

vim.g.neoment = {
	-- Save session data to disk (default: true)
	save_session = true,
	
	-- Custom notifier function (optional)
	-- By default, uses vim.notify
	notifier = function(msg, level, opts)
		vim.notify(msg, level, opts)
	end,
	
	-- Icon configuration (all optional)
	icon = {
		invite = "",              -- Icon for room invites
		buffer = "󰮫",              -- Icon for buffer rooms
		favorite = "",            -- Icon for favorite rooms
		people = "",              -- Icon for people/DMs
		space = "󰴖",               -- Icon for spaces
		room = "󰮧",                -- Icon for regular rooms
		low_priority = "󰘄",       -- Icon for low priority rooms
		reply = "↳",               -- Icon for message replies
		right_arrow = "▶",         -- Icon for collapsed sections
		down_arrow = "▼",          -- Icon for expanded sections
		down_arrow_circle = "",  -- Icon for down arrow in circle
		bell = "󰵛",                -- Icon for mentions/highlights
		dot = "•",                 -- Icon for unread indicator
		dot_circle = "",          -- Icon for dot in circle
		vertical_bar = "│",        -- Icon for vertical separator
		vertical_bar_thick = "┃",  -- Icon for thick vertical separator
		tree_branch = "├",         -- Icon for tree branch
		image = "󰋩",               -- Icon for images
		file = "󰈙",                -- Icon for files
		audio = "",               -- Icon for audio files
		location = "󰍎",            -- Icon for location
		video = "",               -- Icon for video files
	},
}

Neoment uses <Plug> mappings for all its keybindings. There is no vim.g configuration option for keybindings; users should define their own mappings in their Neovim configuration files.

Since keybindings are buffer-specific, you can create files in the ftplugin directory of your Neovim configuration to set up buffer-local mappings.

For example, to change the key for opening rooms in the Rooms Buffer from <CR> to <BS>, create a file at ~/.config/nvim/ftplugin/neoment_rooms.lua with the following content:

vim.keymap.set("n", "<BS>", "<Plug>NeomentRoomsEnter", { buffer = 0 })

Below are the default keybindings for each buffer type.

Filetype: neoment_rooms

Filetype: neoment_room

Filetype: neoment_compose

You can type <C-x><C-o> in insert mode, after typing @, to trigger the completion menu for mentions.

Filetype: neoment_space

Neoment draws inspiration from some excellent Matrix clients:

• iamb
• gomuks
• ement.el

Contributions are welcome! Please note that as this project is in beta, architectural changes may occur. Feel free to:

• Report bugs and issues
• Suggest features and improvements
• Submit pull requests

See LICENSE file for details.

For issues, questions, or discussions, please use the GitHub issue tracker.