Installation und Updates
Du kannst adaptor:ex auf deinem Rechner oder Laptop installieren oder auf einem Server laufen lassen (Lokal vs. Server).
Der schnellste Weg adaptor:ex lokal auszuprobieren ist die Desktop Installation. Wenn du mehr Kontrolle brauchst oder adaptor:ex für dein Team aufsetzen willst empfehlen wir die Installation per NPM oder Docker
Desktop Installation
Lade adaptor:ex für dein Betriebssystem herunter und speichere die Datei in deinem Apps Ordner.
Version 2.11.1 (11. Juni 2026)
Wenn du adaptor.ex ausführst wird automatisch eine Kommandozeile gestartet und dein Standartbrowser öffnet den adaptor:ex Web Editor.
Folge dem Getting Startet Guide um die ersten Schritte mit adaptor:ex zu machen.
NPM und Docker
Du kannst adaptor:ex außerdem per NPM oder Docker installieren oder den Source Code verwenden.
-
Installation per NPM Package Manager
Mit dem NPM Package Manager kannst du adaptor:ex einfach über die Kommandozeile auf jedem gängigen Betriebssystem installieren und als NPM Anwendung ausführen.
Wir empfehlen die Installation per NPM Package Manager wenn du NPM bereits verwendest und adaptor:ex lokal auf deinem Rechner oder in einem internen Netzwerk nutzen willst.
Eine lokale Installation erlaubt es dir die Anschlüsse an deinem Rechner zu nutzen. Z.B. den Seriellen Anschluss per USB oder eine Soundkarte.
-
Im besonderen für eine Server Installation empfehlen wir die Installation in einem Docker Container.
Du kannst unser Docker Compose File nutzen um ein umfangreiches und stabiles Setup mit unabhängiger Server und Client Anwendung und MongoDB Integration zu erstellen.
Das Server Setup Tutorial hilft dir dabei adaptor:ex mit Docker und Docker Compose auf einem externen Server zu installieren, zu sichern und für alle, die an deinem Projekt mitarbeiten, zugänglich zu machen.
-
Lade den adaptor:ex Quellcode herunter und nutze NPM um die Server Anwendung und den Client unabhängig voneinander zu installieren und auszuführen.
Eine Installation ausgehend vom Quellcode erlaubt es dir Änderungen an der Software vorzunehmen.
Wir empfehlen die Installation vom Quellcode wenn du etwas am Code anpassen oder an der Entwicklung von adaptor:ex mitwirken willst.
Installieren mit NPM
Bevor Du mit der Installation von adaptor:ex fortfahren kannst, brauchst Du die aktuelle Version von NodeJS. Die nötigen Installationsdateien für dein Betriebssystem findest Du hier.
Sobald Du NodeJS installiert hast, öffne deine Konsole bzw. das Terminal und führe in der Kommandozeile die Installation mit npm aus
Note
Beachte den Hinweis Nodejs und Windows PowerShell wenn du die Windows PowerShell nutzt.
Wenn die Installation erfolgreich war, starte adaptor:ex mit dem Kommando
Möglichkeiten adaptor:ex zu Konfigurieren findest du in der adaptor:ex server readme
Um den adaptor:ex server wieder zu beenden benutze die Tastenkombination
Ctrl+C
Cmd+C
oder gib quit in die Kommandozeile ein und drücke Enter.
Updates mit NPM
Lade dir die neueste Version von adaptor:ex herunter mit:
Mit npm outdated -g kannst du überprüfen ob eine neue Version zur Verfügung steht:
Installieren mit Docker
Lade Docker für dein Betriebssystem herunter und folge den Installationsanweisungen auf https://docs.docker.com/get-docker/
Erstelle einen neuen Ordner in dem du adaptor:ex installieren willst.
Öffne deine Kommandozeile, wechsle mit dem cd command in das adaptor:ex Verzeichnis und lade die adaptor:ex docker-compose Datei herunter:
curl -o docker-compose.yml https://gitlab.com/machina_ex/adaptor_ex/adaptor_ex_server/-/raw/main/docker-compose.yml
Lade die config Datei für den adaptor:ex client herunter mit:
Führe die Docker Compose Datei aus:
adaptor:ex Server, Client, Datenbank und Plugin Erweiterungen werden heruntergeladen und installiert.
Wenn du von einem anderen Rechner auf adaptor:ex zugreifen willst, musst du in der
adaptor_client_config.jsondie externe URL oder IP des adaptor servers angeben. Ersetze inhttp://localhost:8081/api"localhost" mit der IP des Rechners, auf dem du den docker container aufgesetzt hast, oder mit der URL deines Servers oder Rechners.
Für eine sichere installation auf einem Server wirf einen Blick in das Server Setup Tutorial.
In der adaptor:ex server readme kannst du mehr über die Konfiguration von adaptor:ex erfahren.
Updates mit Docker
Um die adaptor:ex Docker installation zu aktualisieren wechsle in das adaptor:ex Verzeichnis. Dort führe folgende Kommandos aus:
und anschließend
Installieren von Source mit NPM
Bevor Du mit der Installation von adaptor:ex fortfahren kannst, brauchst Du die aktuelle Version von NodeJS. Die nötigen Installatiosdateien für dein Betriebssystem findest Du hier.
Hole dir adaptor:ex Server und Client:
Server
Klone dir das aktuelle GitLab-Repository des adaptor:ex Servers
Oder lade es hier herunter: https://gitlab.com/machina_ex/adaptor_ex/adaptor_ex_server
Client
Klone dir das aktuelle GitLab-Repository des adaptor:ex Clients:
oder lade hier herunter: https://gitlab.com/machina_ex/adaptor_ex/adaptor_ex_client
Jetzt kannst du den Server und den Client mit NPM lokal installieren.
Wechsel im Terminal (der Konsole) in das Verzeichnis in das du den Server oder Client geladen oder geklont hast.
bzw.
Und führe in beiden Verzeichnissen folgenden Befehl aus:
Note
Beachte den Hinweis Nodejs und Windows PowerShell wenn du die Windows PowerShell nutzt.
Wenn die Installation erfolgreich war, starte den adaptor:ex Server im entsprechenden Verzeichnis mit dem Kommando
Bevor du den Client in einer separaten Kommandozeile startest, musst du im Verzeichnis adaptor_ex_client/public in der Datei config.json unter API_URL die Adresse angeben, über die der Server erreichbar ist. Wenn Server und Client mit den default Einstellungen auf dem Selben Rechner laufen ist das http://localhost:8081/api.
{
"API_URL": "http://localhost:8081/api",
"_COMMENT_LOG_STORE": "Set 'true' to print every store action and mutation",
"LOG_STORE": false,
"_COMMENT_LOG_SOCKET": "Set 'true' to print every socket message",
"LOG_SOCKET": true,
"LOG_SOCKET": false,
"_COMMENT_LOG_LEVEL_APP": "Set select wicht toast notifications to show. Can be 'debug', 'info', 'warn', 'error'.",
"LOG_LEVEL_APP": "debug"
}
Starte dann den adaptor:ex Client im entsprechenden Verzeichnis mit dem Kommando
Updates mit git
Lade dir die neueste Version von adaptor:ex server und client herunter indem du im jeweiligen Verzeichnis das Git Repository mit folgendem Befehl updates
Starte adaptor server und client anschließend neu.
Hinweise
Lokal vs. Server
Je nachdem wie du adaptor:ex einsetzen willst kann es sinnvoller sein die Anwendung auf deinem Rechner oder Laptop oder auf einem Server zu installieren.
Eine lokale Installation erlaubt es dir die Anschlüsse an deinem Rechner zu nutzen. Z.B.
- den Seriellen Anschluss per USB
- eine Soundkarte um Audio auf deinem Rechner abzuspielen
- eine DMX Box um Licht von deinem Rechner zu steuern
Wenn du einen Server verwendest kannst du die Hardware an deinem PC nicht nutzen. Du gewinnst aber andere Vorteile
- Alle Team Mitglieder haben jederzeit Zugriff auf das aktuelle Game Projekt
- IoT Geräte können über das Internet mit adaptor:ex kommunizieren
- Mobile Geräte, Handys und Tablets können sich mit dem adaptor:ex Server verbinden
- Du musst deinen Rechner nicht eingeschaltet lassen um dein Game Projekt 24/7 online zu haben
Wenn du auf beides nicht verzichten willst, kannst du mit etwas zusätzlicher Konfiguration auch deinen Lokalen Rechner zu einem Server machen oder einen Raspberry Pi so einrichten, dass er aus dem Internet erreicht wird.
Command Line Terminal
Um adaptor:ex über NPM, Docker oder Quellcode zu installieren musst du die Kommandozeile deines Betriebssystems nutzen.
Unter MacOS suche das Programm "Terminal".
Unter Linux kannst du das terminal mit der Tastenkombination Ctrl+Alt+T öffnen.
Unter Windows suche die Anwendung "Eingabeaufforderung" bzw. "cmd".
Konfiguration
Die adaptor:ex Server Anwendung bietet verschiedene Möglichkeiten um deine Installation anzupassen. In der Readme des adaptor:ex Server Code repositories sind alle Konfigurationsmöglichkeiten beschrieben.
Einige Funktionen des adaptor:ex Server können zudem über die Kommandozeile gesteuert werden: Commands
NPM
Wenn du adaptor:ex per NPM installiert hast füge Konfigurationsoptionen hinten an das adaptorex Kommando an z.B.:
Docker
Wenn du adaptor:ex in einem Docker Compose setup ausführst hänge die Optionen an den entrypoint des adaptorex server Containers an. Z.B.:
services:
adaptorex-server:
image: registry.gitlab.com/machina_ex/adaptor_ex/adaptorex-server:latest
entrypoint:
[
"node",
"index.js",
"--headless",
"-d",
"mongodb",
"-m",
"mongodb://mongodb:27017/?replicaSet=adaptor-repl",
"--log",
"debug"
]
Desktop
Auch wenn du die Desktop Installation von adaptor:ex verwendest kannst du die app mit Optionen über die Kommandozeile ausführen.
Unter MacOS führe die App mit open --args im Applications Ordner aus.
Unter Linux wechsle in den Ordner in den du adaptor:ex heruntergeladen hast und führe die .AppImage Datei aus
Multi User Server Setup
Wirf einen Blick in das Server Setup Tutorial um adaptor:ex mit Docker und Docker Compose auf einem externen Server zu installieren. Hier findest du auch heraus, wie du den Internetzugriff auf adaptor:ex sichern und für alle, die an deinem Projekt mitarbeiten, zugänglich machen kannst.
Updates
Wir werden in der Zukunft häufig Fehler beheben, Dinge (hoffentlich) verbessern und neue Features hinzufügen. Führe ein Update durch indem du die aktuelle Desktop Installation herunterlädst oder via NPM oder Docker ein update ausführst.
Neuigkeiten über Updates werden zeitnah im News Blog und auf unserem Discord Kanal veröffentlicht.
Nodejs und Windows PowerShell
In der Basis Konfiguration kann npm auf der Windows PowerShell nicht ausgeführt werden. Um das Ausführen zu erlauben muss die Execution Policy geändert werden.
Um adaptor:ex installieren zu können führe die PowerShell als Administrator aus und gib dieses Kommando ein:
Hilfe bekommen
Melde dich bei uns, wenn du Schwierigkeiten hast, adaptor:ex zu installieren. Schreib uns an tech@machinaex.de oder schau auf unserem Discord Kanal vorbei.