hydra/docs/README.be.md

Hydra Launcher

Hydra - гэта гульнявы лаўнчар з уласным убудаваным кліентам BitTorrent.

Змест

• Змест
• Апісанне
• Асаблівасці
• Усталёўка
• Уклад
  • Далучайцеся да нашага Telegram
  • Форк і кланаванне рэпазітара
  • Спосабы ўнесці свой уклад
  • Структура праекту
• Зборка з зыходнага коду
  • Усталёўка Node.js
  • Усталёўка Yarn
  • Усталёўка залежнасцяў Node
  • Усталёўка Python 3.9
  • Усталёўка залежнасцяў Python
• Пераменныя асяроддзі
• Запуск
• Зборка
  • Зборка кліента BitTorrent
  • Зборка прыкладання Electron
• Удзельнікі
• Ліцэнзія

Апісанне

Hydra - гэта гульнявы лаўнчар з уласным убудаваным кліентам BitTorrent і самастойным scraper`ом для рэпакаў.
Лаўнчар напісаны на TypeScript (Electron) і Python, які кіруе сістэмай торэнтаў з дапамогай libtorrent.

Асаблівасці

• Самастойны scraper рэпакаў сярод усіх найбольш надзейных вэб-сайтаў у Megathread
• Убудаваны кліент BitTorrent
• Інтэграцыя How Long To Beat (HLTB) на старонцы гульні
• Настройка шляху сцягвання
• Паведамленні аб абнаўленні спісу рэпакаў
• Падтрымка Windows і Linux
• Рэгулярныя абнаўленні
• І многае іншае...

Усталёўка

Каб усталяваць, выканайце наступныя крокі:

1. Спампуйце апошнюю версію Hydra з старонкі рэлізаў.
   • Загрузіце толькі .exe, калі жадаеце ўсталяваць Hydra на Windows.
   • Загрузіце .deb ці .rpm ці .zip, калі жадаеце ўсталяваць Hydra на Linux (у залежнасці ад вашага дыстрыбутыва Linux).
2. Запусціце спампаваны файл.
3. Атрымлівайце асалоду ад Hydra!

Уклад

Далучайцеся да нашага Telegram

Мы засяроджваем нашы абмеркаванні ў нашым канале Telegram.

Форк і кланаванне рэпазітара

1. Форкніце рэпазітар (націсніце тут, каб зрабіць форк зараз)
2. Склануйце свой форкнуты код git clone https://github.com/ваше_имя_пользователя/hydra
3. Стварыце новую галіну
4. Адпраўце свае каміты
5. Адпраўце Pull Request

Спосабы ўнесці свой уклад

• Пераклад: Мы хочам, каб Hydra была даступная як мага большай колькасці людзей. Не саромейцеся дапамагаць перакладаць на новыя мовы ці абнаўляць і паляпшаць тыя, якія ўжо даступныя ў Hydra.
• Код: Hydra створаны з выкарыстаннем TypeScript, Electron і крыху Python. Калі хочаце ўнесці свой уклад, далучайцеся да нашага канала Telegram!

Структура праекту

• torrent-client: Мы выкарыстоўваем libtorrent, бібліятэку Python, для кіравання торэнт-загрузкамі.
• src/renderer: Карыстацкі інтэрфейс прыкладання.
• src/main: Увесь асноўны функцыянал тут.

Зборка з зыходнага коду

Усталёўка Node.js

Упэўніцеся, што ў вас усталяваны Node.js на вашым кампутары. Калі не, загрузіце і ўсталюйце яго з nodejs.org.

Усталёўка Yarn

Yarn - мэнэджэр пакетаў для Node.js. Калі вы яшчэ не ўсталявалі Yarn, зрабіце гэта, прытрымліваючыся інструкцыям на yarnpkg.com.

Усталёўка залежнасцяў Node

Перайдзіце ў каталог праекта і ўсталюйце залежнасці Node, выкарыстоўваючы Yarn:

cd hydra
yarn

Усталёўка Python 3.9

Упэўніцеся, што ў вас усталяваны Python 3.9 на вашым кампутары. Вы можаце загрузіць і ўсталяваць яго з python.org.

Усталёўка залежнасцяў Python

Усталюйце неабходныя залежнасці Python, выкарыстоўваючы pip:

pip install -r requirements.txt

Пераменныя асяроддзі

Вам спатрэбіцца ключ API SteamGridDB, каб атрымаць значкі гульняў пры ўсталёўкі.

Як толькі вы атрымаеце ключ, вы зможаце скапіяваць або пераназваць файл .env.example у .env і змясціць у яго STEAMGRIDDB_API_KEY.

Запуск

Пасля таго як усё наладжана, вы можаце выканаць наступную каманду, каб запусціць працэс Electron і кліента BitTorrent:

yarn dev

Зборка

Зборка кліента BitTorrent

Збярыце кліент BitTorrent з дапамогай гэтай каманды:

python torrent-client/setup.py build

Зборка прыкладання Electron

Збярыце прыкладанне Electron, выкарыстоўваючы гэтую каманду:

На Windows:

yarn build:win

На Linux:

yarn build:linux

Удзельнікі

Ліцэнзія

Hydra ліцэнзавана ў адпаведнасці з MIT License.