6.1 KiB
Seznam obsahu
- Seznam obsahu
- O projektu
- Funkce
- Instalace
- Přispívání
- Sestavení ze zdroje
- Proměnné prostředí
- Spuštění
- Sestavení
- Přispěvatelé
- Licence
O projektu
Hydra je Herní Launcher s jeho vlastním vestavěným BitTorrent Klientem.
Launcher je napsán v TypeScriptu (Electron) a Pythonu, který má na starosti torrentovací systém za pomocí knihovny libtorrent.
Funkce
- Vlastní vestavěný BitTorrent klient
- How Long To Beat (HLTB) integrace na stránce hry
- Vlastní místa pro uložení hry
- Windows a Linux podpora
- Časté aktualizace
- A další ...
Instalace
Následuj kroky:
- Stáhni nejnovější verzi Hydry ze stránky Vydání.
- Stáhni .exe, pokud chceš instalovat Hydru na Windows.
- Stáhni .deb nebo .rpm nebo .zip, pokud chceš instalovat Hydru na Linux. (záleží na tvé Linux distribuci)
- Spusť stažený instalační soubor.
- Užívej Hydru!
Přispívání
Připoj se na náš telegram
Vedeme diskuzi v našem Telegramovém kanálu.
Vytvořte fork a naklonujte svůj repozitář
- Vytvoř fork repozitáře (klikni sem pro vytvoření forku)
- Naklonuj kód forku
git clone https://github.com/tvoje_jméno/hydra
- Vytvoř nové odvětví (branch)
- Odešli svoje změny
- Odešli nový Pull Request
Způsoby jak můžete přispět
- Překládání: Chceme, aby Hydra byla co nejvíce dostupná. Můžete přispět novým jazykem, nebo úpravou současného!
- Kód: Hydra je postavena na Typescriptu, Electronu a trochou Pythonu. Pokud chceš přispět, připoj se na náš Telegram!
Struktura projektu
- torrent-client: Používáme libtorrent, Pythonovou knihovnu, pro správu torrent stahování
- src/renderer: uživatelské rozhraní aplikace (UI)
- src/main: celá logika projektu
Sestavení ze zdroje
Instalace Node.js
Ujistěte se, že máte Node.js nainstalován na svém zařízení. Pokud ne, stáhněte ho, a nainstalujte z nodejs.org.
Instalace Yarn
Yarn je balíčkový správce pro Node.js. Pokud ještě nemáte yarn, můžete ho stáhnout za pomoci pokynů na yarnpkg.com.
Instalace Požadavků pro Node.js
Jděte do složky projektu, otevřte v ní konzole a nainstalujte požadavky pro Node pomocí Yarn:
cd hydra
yarn
Instalace Pythonu 3.9
Ujistěte se, že máte Python 3.9 nainstalován na svém zařízení. Můžete ho stáhnout z python.org.
Instalace Požadavků pro Python
Nainstalujte požadavky pro Python za pomoci pip:
pip install -r requirements.txt
Proměnné prostředí
Budete potřebovat SteamGridDB API klíč, abyste mohli načítat ikony u her.
Jakmile ho máte, můžete zkopírovat, nebo přejmenovat .env.example
soubor na .env
a dát ho do STEAMGRIDDB_API_KEY
.
Spuštění
Jakmile máte vše nastaveno, můžete spustit jak Electron proces tak bittorrent client:
yarn dev
Sestavení
Sestavení bittorrent klientu
Sestavit bittorrent klient můžete pomocí:
python torrent-client/setup.py build
Sestavení electron aplikace
Sestavit Electron aplikaci můžete pomocí následujících kroků:
Na Windows:
yarn build:win
Na Linux:
yarn build:linux
Přispěvatelé
Licence
Hydra je licencována pod MIT Licencí.