Add mod description

main
Bram van den Heuvel 2024-02-20 11:20:27 +01:00
parent 2a5563cd8b
commit c7d116e116
2 changed files with 46 additions and 1 deletions

View File

@ -1,3 +1,46 @@
# mt-matrix # mt-matrix
Matrix-Minetest bridge This repository serves as a bridge between Matrix and Minetest servers.
## Setup
1. Clone this repository into your Minetest mods folder:
```sh
git clone --recursive https://git.noordstar.me/Bram/mt-matrix.git
```
2. To access the Matrix homeserver, this mod needs access to HTTP calls. Add this mod to your `minetest.conf` settings at the field `secure.http_mods`:
```
# Comma-separated list of mods that are allowed to access HTTP APIs, which
# allow them to upload and download data to/from the internet.
# type: string
secure.http_mods=mt_matrix
```
3. Fill in the values in `config.lua`:
```lua
config = {
-- The user one expects to log in as
user = "@minetest:matrix.directory",
-- The URL where the user communicates with the Matrix homeserver
url = "https://synapse.matrix.directory",
-- Room ID that the Minetest server bridges to
room_id = "!fePhSRwZXgzmREGqFV:matrix.directory",
-- Access token to access the Matrix homeserver
access_token = "syt_bWluZXRlc3Q_TafRsEjsCwVaCxFYCIkT_2iChoq",
-- Average timeout duration
sync_timeout = 30
}
```
4. Add the mod to your world configuration.
Now you're good to go! Feel free to create issues or send me a message.

2
mod.conf Normal file
View File

@ -0,0 +1,2 @@
name = mt_matrix
description = This mod creates a bridge between a Matrix room and the in-game Minetest chat.