README.de.md

Hydra Launcher

Hydra ist ein Launcher für Spiele mit einem eigenen eingebetteten BitTorrent-Client.

Inhaltsverzeichnis

• Über Hydra
• Eigenschaften
• Installation
• Mitwirken
  • Tritt uns auf Telegram bei
  • Forke und klone dein Repo
  • Wie du mitwirken kannst
  • Projektstruktur
• Den Quellcode kompilieren
  • Installiere Node.js
  • Installiere Yarn
  • Installiere Node-Abhängigkeiten
  • Installiere Python 3.9
  • Installiere Python-Abhängigkeiten
• Umgebungsvariablen
• Ausführung
• Kompilation
  • Kompiliere den BitTorrent-Client
  • Kompiliere die Electron-Applikation
• Mitwirkende

Über Hydra

Hydra ist ein Launcher für Spiele mit einem eigenen eingebetteten BitTorrent-Client.
Der Launcher ist in TypeScript (Electron) und Python, womit das Torrentingsystem durch Einsatz von libtorrent geregelt ist, geschrieben.

Eigenschaften

• Eigener eingebetteter BitTorrent-Client
• How Long to Beat (HLTB) Integration auf der Spielseite
• Anpassbarkeit des Downloadverzeichnisses
• Unterstützung von Windows und Linux
• Regelmäßig aktualisiert
• Und mehr ...

Installation

Die folgenden Schritte beschreiben den Installationsprozess:

1. Lade die neueste Version von Hydra von der Releases Seite herunter.
   • Für die Installation von Hydra auf Windows, wähle die .exe Datei.
   • Für die Installation von Hydra auf Linux, wähle die .deb, .rpm oder .zip Datei. (Abhängig von deiner Linux-Distribution)
2. Führe die heruntergeladene Datei aus.
3. Genieße Hydra!

Mitwirken

Tritt uns auf Telegram bei

Wir konzentrieren unsere Diskussionen in unserem Telegram Kanal.

Forke und klone dein Repo

1. Forke das Repo (Klicke hier, um direkt zu forken)
2. Klone deinen geforketen Code git clone https://github.com/dein_nutzername/hydra
3. Erstelle einen neuen Branch
4. Pushe deine Commits
5. Stelle eine neue Pull-Anfrage

Wie du mitwirken kannst

• Übersetzung: Wir wollen Hydra so vielen Menschen wie möglich zugänglich machen. Gerne kannst du uns helfen neue Sprachen zu übersetzen oder für Hydra bereits verfügbare Sprachen zu aktualisieren und verbessern.
• Code: Hydra ist mit TypeScript, Electron und etwas Python gebaut. Wenn du mitwirken möchtest, tritt unserem Telegram bei!

Projektstruktur

• torrent-client: Wir verwenden die Python-Bibliothek libtorrent zur Verwaltung von Torrent-Downloads.
• src/renderer: die UI der Applikation.
• src/main: sämtliche Logik liegt hier.

Den Quellcode kompilieren

Installiere Node.js

Stelle sicher, dass du Node.js auf deinem System installiert hast. Falls nicht, installiere es von nodejs.org.

Installiere Yarn

Yarn ist ein Packetmanager für Node.js. Sollte er dir fehlen, installiere ihn mithilfe der Anleitung auf yarnpkg.com.

Installiere Node-Abhängigkeiten

Navigiere zum Projektverzeichnis und installiere die Node-Abhängigkeiten mit Yarn:

cd hydra
yarn

Installiere Python 3.9

Stelle sicher, dass du Python 3.9 auf deinem System installiert hast. Ansonsten kannst du es von python.org herunterladen und installieren.

Installiere Python-Abhängigkeiten

Installiere die benötigten Python-Abhängigkeiten mit pip:

pip install -r requirements.txt

Umgebungsvariablen

Du wirst einen SteamGridDB API Schlüssel benötigen, um die Spielicons bei Installation abzurufen.

Sobald du einen hast, kannst du die .env.example Datei zu .env kopieren oder umbenennen und den Schlüssel bei STEAMGRIDDB_API_KEY einfügen.

Ausführung

Sobald du alles eingerichtet hast, kannst du den folgenden Befehl nutzen, um sowohl den Electron-Prozess als auch den BitTorrent-Client zu starten:

yarn dev

Kompilation

Kompiliere den BitTorrent-Client

Kompiliere den BitTorrent-Client mit folgendem Befehl:

python torrent-client/setup.py build

Kompiliere die Electron-Applikation

Kompiliere die Electron-Applikation mit folgendem Befehl:

Auf Windows:

yarn build:win

Auf Linux:

yarn build:linux

Mitwirkende

Lizenz

Hydra ist unter der MIT Lizenz lizensiert.