mt-matrix/README.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

2024-02-19 23:46:32 +00:00
# mt-matrix
2024-02-20 10:20:27 +00:00
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 = "@alice:example.org",
2024-02-20 10:20:27 +00:00
-- The URL where the user communicates with the Matrix homeserver
url = "https://matrix.example.org",
2024-02-20 10:20:27 +00:00
-- Room ID that the Minetest server bridges to
room_id = "!room_id:example.org",
2024-02-20 10:20:27 +00:00
-- Access token to access the Matrix homeserver
access_token = "",
2024-02-20 10:20:27 +00:00
-- Average timeout duration
sync_timeout = 30
}
2024-02-20 10:20:27 +00:00
```
4. Add the mod to your world configuration.
Now you're good to go! Feel free to create issues or send me a message.