hydra/docs/README.nb.md

Hydra Launcher

Hydra er en spill launcher sin egen innebygt bittorrent klient.

Innhold

• Innhold
• Om
• Funksjoner
• Installasjon
• Bidra
  • Bli med i Telegram kanalen vår
  • Forke og klone repoet ditt
  • Måter du kan bidra
  • Prosjekt Struktur
• Bygg fra kilden
  • Installere Node.js
  • Installere Yarn
  • Installere Node-avhengigheter
  • Installere Python 3.9
  • Installere Python-avhengigheter
• Miljøvariabler
• Kjøre
• Bygge
  • Bygg bittorrent klienten
  • Bygg Electron applikationen
• Bidragsytere
• Lisens

Om

Hydra er en Spill Launcher sin egne innbygte BitTorrent Klient.
Launcheren er skrevet i TypeScript (Electron) og Python, som håndterer torrent systemet ved bruk av libtorrent.

Funksjoner

• Sin egen innebyggte bittorrent klient
• How Long To Beat (HLTB) integrasjon på spillsiden
• Nedlastingssti tilpasning
• Windows og Linux understøttelse
• Konstant oppdatert
• Og mer ...

Installasjon

Følg trinnene her under for å innstallere:

1. Last ned den seneste versjonen av Hydra fra Releases siden.
   • Last kun .exe filen ned om du vil installere Hydra på Windows.
   • Last kun .deb, .rpm eller .zip ned om du vil installere Hydra på Linux. (kommer an på Linux distroen din)
2. Kjør den nedlastede filen.
3. Nyt Hydra!

Bidra

Bli med i Telegram kanalen vår

Vi holder diskusjonene våres i Telegram kanalen.

Forke og klone repoet ditt

1. Fork repoet (trykk her for å forke nå)
2. Klon den forkede koden git clone https://github.com/brukernavnet_ditt/hydra
3. Lag en ny branch
4. Skyv committene dine
5. Send inn en ny Pull-forespørsel.

Måter du kan bidra

• Oversetting: Vi har lyst at Hydra skal bli tilgjengelig for så mange som mulig. Hjelp gjerne med å oversette til nye språk eller oppdater og forbedre de som allerede er tilgjengelige i Hydra.
• Code: Hydra is built with Typescript, Electron and a little bit of Python. If you want to contribute, join our Telegram!
• Kode: Hydra er laget med Typescript, Electron og lite gran Pythong. Hvis du har lyst på å bidra, bli med i Telegram kanalen vår!

Prosjektstruktur

• torrent-client: Vi bruker libtorrent, et Python-bibliotek, til å håndtere torrent nedlastinger.
• src/renderer: UIen til applikasjonen
• src/main: all logikken er her.

Bygg fra kildekoden

Installere Node.js

Vær sikker på at du har installert Node.js på maskinen din. Hvis du ikke har det, må du laste ned og installere det fra nodejs.org.

Installere Yarn

Yarn er et pakkehåndteringsverktøy til Node.js. Hvis du ikke allerede har installert Yarn, da kan du gjøre det ved å følge instruksjonene på yarnpkg.com.

Installere Node-avhengigheter

Naviger til prosjektmappen og installer Node-avhengighetene ved bruk av Yarn:

cd hydra
yarn

Installere Python 3.9

Vær sikker på at du har installert Python 3.9 på maskinen din. Du kan laste ned og installere det på python.org.

Installere Python-avhengigheter

Installer de nødvendige Python-avhengigheter ved bruk av pip:

pip install -r requirements.txt

Miljøvariabler

Du trenger en SteamGridDB API nøkkel for å kunne hente spillikonene ved installasjon.

Når du har det, kan du kopiere eller endre navnet på .env.example filen til å være .env og lagre nøkkelen som STEAMGRIDDB_API_KEY.

Kjøre

Når alt er satt op, kan du kjøre følgende kommando for å start både Electron prosessen og bittorrent klienten.

yarn dev

Bygge

Bygge bittorrent klienten

Bygg bittorrent klienten ved å bruke denne kommandoen:

python torrent-client/setup.py build

Bygge Electron applikasjonen

Bygg Electron applikasjonen ved å bruke denne kommandoen:

På Windows:

yarn build:win

På Linux:

yarn build:linux

Bidragsytere

Lisens

Hydra bruker MIT Lisensen.