karthanistyr/matrix-godot-client
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Matrix client for the Godot Engine, in GDScript.
26 commits 1 branch 0 tags 46 MiB
Find a file
Exact
Antoine Mazeas 47fe4b3bb2 last fixes for migration to godot 4 
Signed-off-by: Antoine Mazeas <antoine@karthanis.net>
2023-09-29 23:25:11 +02:00
addons allow selfsigned tls certs in integration tests 2023-09-29 01:05:28 +02:00
test last fixes for migration to godot 4 2023-09-29 23:25:11 +02:00
vendor convert to gdscript 4 2023-09-25 00:19:03 +02:00
.gitattributes Petit refactoring 2020-08-24 17:53:05 +02:00
.gitignore convert to gdscript 4 2023-09-25 00:19:03 +02:00
.gitmodules convert to gdscript 4 2023-09-25 00:19:03 +02:00
.gut_editor_config.json more upgrade fixes 2023-09-28 00:04:03 +02:00
.gutconfig.json Fist few classes and tests... 2020-08-23 21:20:37 +02:00
LICENSE Fist few classes and tests... 2020-08-23 21:20:37 +02:00
project.godot convert to gdscript 4 2023-09-25 00:19:03 +02:00
README.md convert to gdscript 4 2023-09-25 00:19:03 +02:00
run_tests_linux.sh last fixes for migration to godot 4 2023-09-29 23:25:11 +02:00

README.md

matrix-godot-client

A client to the Matrix universe for the Godot Game Engine.

Matrix: https://matrix.org Godot: https://godotengine.org

Coverage

API

According to Client-Server API:

  • Discovery *

Installation

The library is contained within addons/matrix-client. This directory should be put in your project's folder:

$ tree -d
.
├── addons
│   └── matrix-client
└── project.godot

Development

[TODO]

Testing

Unit tests

Unit tests do no I/O at all, and validate individual classes' behaviour. The tests are located at res://test/unit.

Integration tests

Integration tests are actual calls against a matrix server, for instance Synapse (http://github.com/matrix-org/synapse). The tests are located at res://test/integration. There are fixtures for a pre-populated and pre-configured synapse instance at res://test/integration/fixtures/synapse-data.

Running the tests

Linux 64-bit

Tests on Linux can be run within a terminal using the supplied Godot Headless binary. The script run_tests_linux.sh will help run the tests and print a report.

$ ./run_tests_linux.sh [-d unit|integration]

If running the integration tests, the script will attempt to use docker to start a container with the image matrixdotorg/synapse:v1.23.0, and attach a copy of the data directory at res://test/integration/fixtures/synapse-data (into a directory under /tmp).

Synapse in the container will run as the UID:GID of the local user running the tests.

Windows

[TODO]

Credits

This software makes use of the following programs or libraries: