minetest-matrix_bridge/README.md

1.8 KiB

Minetest Matrix bridge

This is a server-side mod for Minetest, creating a bridge between a Matrix instant-messaging room and a Minetest server.

This mod does not use any additional lua library, only standard Minetest API.

Compatibility note: Fully functional with >=5.4.0. Due to a broken API in 5.3.0, this version is not fully supported.

Demo server: survival.juneland.fr port 30000; see Juneland's Matrix room

Donate Libre Currency Ğ1

Install

The mod needs an existing account on the Matrix server, and access to the room.

Copy the template config to config.lua:

cp config.template.lua config.lua

then edit config.lua.

Add matrix_bridge to secure.http_mods (e.g. in the file /etc/minetest/minetest.conf):

secure.http_mods = matrix_bridge

Contributing

See Matrix API docs.

License

A bit of code comes from diggers-mt/matrix_chat: BSD-2-Clause, Copyright 2017 Jon Neverland (joenas)

GNU AGPL v3, CopyLeft 2022 Pascal Engélibert (tuxmain), scuti

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.