hydra/README.ru.md

315 lines
13 KiB
Markdown
Raw Normal View History

2024-05-06 13:56:33 +03:00
<br>
<div align="center">
<a href="https://hydralauncher.site">
<img src="./resources/icon.png" width="144"/>
</a>
<h1 align="center">Hydra Launcher</h1>
<p align="center">
2024-05-10 14:52:52 +03:00
<strong>Hydra - это игровой лаунчер с собственным встроенным клиентом BitTorrent и самостоятельным scraper`ом для репаков.</strong>
2024-05-06 13:56:33 +03:00
</p>
<p>
<a href="https://discord.gg/hydralauncher">
<img src ="https://img.shields.io/discord/1220692017311645737?style=flat&logo=discord&label=Hydra&labelColor=%231c1c1c"/>
</a>
<a href="https://github.com/hydralauncher/hydra">
<img src="https://img.shields.io/github/actions/workflow/status/hydralauncher/hydra/build.yml" />
</a>
<a href="https://github.com/hydralauncher/hydra">
<img src="https://img.shields.io/github/package-json/v/hydralauncher/hydra" />
</a>
</p>
![Hydra Catalogue](./docs/screenshot.png)
</div>
<br>
### Язык
[![ru](https://img.shields.io/badge/lang-ru-red)](https://github.com/hydralauncher/hydra/blob/main/README.ru.md)
## Содержание
2024-05-10 14:52:52 +03:00
- [Описание](#описание)
- [Особенности](#особенности)
2024-05-06 13:56:33 +03:00
- [Установка](#установка)
- [Сотрудничество](#сотрудничество)
- [Присоединяйтесь к нашему Discord](#присоединяйтесь-к-нашему-discord)
2024-05-10 14:52:52 +03:00
- [Форк и клонирование репозитория](#форк-и-клонирование-репозитория)
2024-05-06 13:56:33 +03:00
- [Способы внести свой вклад](#способы-внести-свой-вклад)
- [Структура проекта](#структура-проекта)
2024-05-10 14:52:52 +03:00
- [Сборка из исходного кода](#сборка-из-исходного-кода)
- [Установка Node.js](#установка-nodejs)
- [Установка Yarn](#установка-yarn)
- [Установка зависимостей Node](#установка-зависимостей-node)
- [Установка Python 3.9](#установка-python-39)
- [Установка зависимостей Python](#установка-зависимостей-python)
2024-05-06 13:56:33 +03:00
- [Переменные среды](#переменные-среды)
- [Запуск](#запуск)
2024-05-10 14:52:52 +03:00
- [Сборка](#сборка)
- [Сборка клиента BitTorrent](#сборка-клиента-bittorrent)
- [Сборка приложения Electron](#сборка-приложения-electron)
2024-05-06 13:56:33 +03:00
- [Участники](#участники)
2024-05-10 14:52:52 +03:00
## Описание
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
**Hydra** - это **Игровой Лаунчер** с собственным встроенным **Клиентом BitTorrent** и **самостоятельным scraper`ом для репаков**.
2024-05-06 13:56:33 +03:00
<br>
2024-05-10 14:52:52 +03:00
Лаунчер написан на TypeScript (Electron) и Python, который управляет системой торрентов с помощью libtorrent.
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
## Особенности
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
- Самостоятельный scraper репаков среди всех наиболее надежных веб-сайтов в [Megathread](https://www.reddit.com/r/Piracy/wiki/megathread/)
- Встроенный клиент BitTorrent
- Интеграция How Long To Beat (HLTB) на странице игры
- Настройка пути загрузки
2024-05-06 13:56:33 +03:00
- Уведомления об обновлении списка репаков
- Поддержка Windows и Linux
- Постоянно обновляется
2024-05-10 14:52:52 +03:00
- И многое другое...
2024-05-06 13:56:33 +03:00
## Установка
2024-05-10 14:52:52 +03:00
Чтобы установить, выполните следующие шаги:
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
1. Скачайте последнюю версию Hydra с [страницы релизов](https://github.com/hydralauncher/hydra/releases/latest).
- Загрузите только .exe, если хотите установить Hydra на Windows.
- Загрузите .deb или .rpm или .zip, если хотите установить Hydra на Linux (в зависимости от вашего дистрибутива Linux).
2. Запустите скачанный файл.
3. Наслаждайтесь Hydra!
2024-05-06 13:56:33 +03:00
## Сотрудничество
### Присоединяйтесь к нашему Discord
2024-05-10 14:52:52 +03:00
Мы сосредотачиваем наши обсуждения на нашем [Discord](https://discord.gg/hydralauncher) сервере.
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
1. Присоединитесь к нашему серверу.
2. Перейдите в канал ролей и получите роль Collaborator.
3. Перейдите в канал Dev, общайтесь с нами и делитесь своими идеями.
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
### Форк и клонирование репозитория
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
1. Форкните репозиторий [(нажмите здесь, чтобы сделать форк сейчас)](https://github.com/hydralauncher/hydra/fork)
2. Склонируйте свой форкнутый код `git clone https://github.com/ваше_имя_пользователя/hydra`
3. Создайте новую ветку
4. Отправьте свои коммиты
5. Отправьте Pull Request
2024-05-06 13:56:33 +03:00
### Способы внести свой вклад
2024-05-10 14:52:52 +03:00
- Перевод: Мы хотим, чтобы Hydra была доступна как можно большему количеству людей. Не стесняйтесь помогать переводить на новые языки или обновлять и улучшать те, которые уже доступны в Hydra.
- Код: Hydra создан с использованием TypeScript, Electron и немного Python. Если хотите внести свой вклад, присоединяйтесь к нашему серверу Discord!
2024-05-06 13:56:33 +03:00
### Структура проекта
2024-05-10 14:52:52 +03:00
- torrent-client: Мы используем libtorrent, библиотеку Python, для управления загрузками торрентов.
- src/renderer: пользовательский интерфейс приложения.
- src/main: весь основной функционал здесь.
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
## Сборка из исходного кода
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
### Установка Node.js
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Убедитесь, что у вас установлен Node.js на вашем компьютере. Если нет, загрузите и установите его с [nodejs.org](https://nodejs.org/).
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
### Установка Yarn
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Yarn - менеджер пакетов для Node.js. Если вы еще не установили Yarn, сделайте это, следуя инструкциям на [yarnpkg.com](https://classic.yarnpkg.com/lang/en/docs/install/).
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
### Установка зависимостей Node
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Перейдите в каталог проекта и установите зависимости Node, используя Yarn:
2024-05-06 13:56:33 +03:00
```bash
cd hydra
yarn
```
2024-05-10 14:52:52 +03:00
### Установка Python 3.9
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Убедитесь, что у вас установлен Python 3.9 на вашем компьютере. Вы можете загрузить и установить его с [python.org](https://www.python.org/downloads/release/python-3919/).
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
### Установка зависимостей Python
2024-05-06 13:56:33 +03:00
Установите необходимые зависимости Python, используя pip:
```bash
pip install -r requirements.txt
```
## Переменные среды
2024-05-10 14:52:52 +03:00
Вам понадобится ключ API SteamGridDB, чтобы получить значки игр при установке.
Если вы хотите использовать onlinefix в качестве репака, вам нужно добавить ваши учетные данные в файл .env.
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Как только у вас будет ключ, вы можете скопировать или переименовать файл `.env.example` в `.env` и поместить в него `STEAMGRIDDB_API_KEY`, `ONLINEFIX_USERNAME`, `ONLINEFIX_PASSWORD`.
2024-05-06 13:56:33 +03:00
## Запуск
2024-05-10 14:52:52 +03:00
После того как все настроено, вы можете выполнить следующую команду, чтобы запустить процесс Electron и клиента BitTorrent:
2024-05-06 13:56:33 +03:00
```bash
yarn dev
```
2024-05-10 14:52:52 +03:00
## Сборка
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
### Сборка клиента BitTorrent
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Соберите клиент BitTorrent с помощью этой команды:
2024-05-06 13:56:33 +03:00
```bash
python torrent-client/setup.py build
```
2024-05-10 14:52:52 +03:00
### Сборка приложения Electron
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
Соберите приложение Electron, используя эту команду:
2024-05-06 13:56:33 +03:00
2024-05-10 14:52:52 +03:00
На Windows:
2024-05-06 13:56:33 +03:00
```bash
yarn build:win
```
2024-05-10 14:52:52 +03:00
На Linux:
2024-05-06 13:56:33 +03:00
```bash
yarn build:linux
```
## Участники
<!-- readme: contributors -start -->
<table>
<tr>
<td align="center">
<a href="https://github.com/hydralauncher">
<img src="https://avatars.githubusercontent.com/u/164102380?v=4" width="100;" alt="hydralauncher"/>
<br />
<sub><b>Hydra</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/zamitto">
<img src="https://avatars.githubusercontent.com/u/167933696?v=4" width="100;" alt="zamitto"/>
<br />
<sub><b>Null</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/fzanutto">
<img src="https://avatars.githubusercontent.com/u/15229294?v=4" width="100;" alt="fzanutto"/>
<br />
<sub><b>Null</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/JackEnx">
<img src="https://avatars.githubusercontent.com/u/167036558?v=4" width="100;" alt="JackEnx"/>
<br />
<sub><b>Null</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Magrid0">
<img src="https://avatars.githubusercontent.com/u/73496008?v=4" width="100;" alt="Magrid0"/>
<br />
<sub><b>Magrid</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/fhilipecrash">
<img src="https://avatars.githubusercontent.com/u/36455575?v=4" width="100;" alt="fhilipecrash"/>
<br />
<sub><b>Fhilipe Coelho</b></sub>
</a>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/jps14">
<img src="https://avatars.githubusercontent.com/u/168477146?v=4" width="100;" alt="jps14"/>
<br />
<sub><b>José Luís</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/shadowtosser">
<img src="https://avatars.githubusercontent.com/u/168544958?v=4" width="100;" alt="shadowtosser"/>
<br />
<sub><b>Null</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/pmenta">
<img src="https://avatars.githubusercontent.com/u/71457671?v=4" width="100;" alt="pmenta"/>
<br />
<sub><b>João Martins</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/ferivoq">
<img src="https://avatars.githubusercontent.com/u/36544651?v=4" width="100;" alt="ferivoq"/>
<br />
<sub><b>FeriVOQ</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/xbozo">
<img src="https://avatars.githubusercontent.com/u/119091492?v=4" width="100;" alt="xbozo"/>
<br />
<sub><b>Guilherme Viana</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/eltociear">
<img src="https://avatars.githubusercontent.com/u/22633385?v=4" width="100;" alt="eltociear"/>
<br />
<sub><b>Ikko Eltociear Ashimine</b></sub>
</a>
</td></tr>
<tr>
<td align="center">
<a href="https://github.com/Netflixyapp">
<img src="https://avatars.githubusercontent.com/u/91623880?v=4" width="100;" alt="Netflixyapp"/>
<br />
<sub><b>Netflixy</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Hachi-R">
<img src="https://avatars.githubusercontent.com/u/58823742?v=4" width="100;" alt="Hachi-R"/>
<br />
<sub><b>Hachi</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/FerNikoMF">
<img src="https://avatars.githubusercontent.com/u/76095334?v=4" width="100;" alt="FerNikoMF"/>
<br />
<sub><b>Firdavs</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/userMacieG">
<img src="https://avatars.githubusercontent.com/u/24211405?v=4" width="100;" alt="userMacieG"/>
<br />
<sub><b>Maciej Ratyński</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Tunchichi">
<img src="https://avatars.githubusercontent.com/u/118926729?v=4" width="100;" alt="Tunchichi"/>
<br />
<sub><b>Ruslan</b></sub>
</a>
</td></tr>
</table>
<!-- readme: contributors -end -->
## License
2024-05-10 14:52:52 +03:00
Hydra лицензирована в соответствии с [MIT License](LICENSE).