From a7492a8a11217c86444e258830b94304b3690050 Mon Sep 17 00:00:00 2001 From: piradata Date: Sat, 11 May 2024 16:22:20 -0300 Subject: [PATCH] - add pb-br readme (WIP) - change discord link to telegram - remove discord tag - add readme links to other languages - make the list of contributors dynamic using contrib.rocks --- README.md | 222 +++++------------------------------------------- README.pt-br.md | 192 +++++++++++++++++++++++++++++++++++++++++ README.ru.md | 159 +++++----------------------------- 3 files changed, 231 insertions(+), 342 deletions(-) create mode 100644 README.pt-br.md diff --git a/README.md b/README.md index a570db4d..d7b3e20a 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,6 @@ Hydra is a game launcher with its own embedded bittorrent client and a self-managed repack scraper.

- - - @@ -20,6 +17,12 @@

+For this readme in other languages, choose here: + +[![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md) +[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md) +[![ru](https://img.shields.io/badge/lang-ru-yellow.svg)](README.ru.md) + ![Hydra Catalogue](./docs/screenshot.png) @@ -32,7 +35,7 @@ - [Features](#features) - [Installation](#installation) - [Contributing](#contributing) - - [Join our Discord](#join-our-discord) + - [Join our Telegram](#join-our-telegram) - [Fork and clone your repository](#fork-and-clone-your-repository) - [Ways you can contribute](#ways-you-can-contribute) - [Project Structure](#project-structure) @@ -76,15 +79,11 @@ Follow the steps below to install: 2. Run the downloaded file. 3. Enjoy Hydra! -## Contributing +## Contributing -### Join our Discord +### Join our Telegram -We concentrate our discussions on our [Discord](https://discord.gg/hydralauncher) server. - -1. Join our server -2. Go to the roles channel and grab the Collaborator role -3. Go to the dev channel, talk to us and share your ideas. +We concentrate our discussions on our [Telegram](https://t.me/hydralauncher) channel. ### Fork and clone your repository @@ -97,7 +96,7 @@ We concentrate our discussions on our [Discord](https://discord.gg/hydralauncher ### Ways you can contribute - Translation: We want Hydra to be available to as many people as possible. Feel free to help translate to new languages or update and improve the ones that are already available on Hydra. -- Code: Hydra is built with Typescript, Electron and a little bit of Python. If you want to contribute, join our Discord server! +- Code: Hydra is built with Typescript, Electron and a little bit of Python. If you want to contribute, join our [Telegram](https://t.me/hydralauncher)! ### Project Structure @@ -178,198 +177,15 @@ yarn build:linux ``` ## Contributors +Made with [contrib.rocks](https://contrib.rocks). + +> [!NOTE] +> It may take up to a day for the list to be updated. + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - hydralauncher -
- Hydra - - 		- - zamitto -
- Null - - 		- - fzanutto -
- Null - - 		- - JackEnx -
- Null - - 		- - Magrid0 -
- Magrid - - 		- - fhilipecrash -
- Fhilipe Coelho - -
- - jps14 -
- José Luís - - 		- - shadowtosser -
- Null - - 		- - Mkdantas -
- Matheus Dantas - - 		- - Hachi-R -
- Hachi - - 		- - pmenta -
- João Martins - - 		- - xbozo -
- Guilherme Viana - -
- - ferivoq -
- FeriVOQ - - 		- - Tunchichi -
- Ruslan - - 		- - eltociear -
- Ikko Eltociear Ashimine - - 		- - Netflixyapp -
- Netflixy - - 		- - vnumex -
- Vnumex - - 		- - FerNikoMF -
- Firdavs - -
- - PCTroller -
- Null - - 		- - AHOHNMYC -
- Null - - 		- - Chr1s0Blood -
- Cristian S. - - 		- - ChristoferMendes -
- Christofer Luiz Dos Santos Mendes - - 		- - IWareQ -
- Dmitry Luk - - 		- - userMacieG -
- Maciej Ratyński - -
- - HOLKus -
- Redulum - - 		- - cardosource -
- Cardoso - -
- ## License diff --git a/README.pt-br.md b/README.pt-br.md new file mode 100644 index 00000000..e53080e7 --- /dev/null +++ b/README.pt-br.md @@ -0,0 +1,192 @@ +
+ +
+ + + +

Hydra Launcher

+

+ Hydra é um Game Launcher com seu próprio cliente de bittorrent integrado e um wrapper autogerenciado para busca de repacks. +

+

+ + + + + + +

+ +Para este README em outros idiomas, escolha aqui: + +[![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md) +[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md) +[![ru](https://img.shields.io/badge/lang-ru-yellow.svg)](README.ru.md) + +![Catalogue do Hydra](./docs/screenshot.png) + +
+ +
+ +## Table of Contents + +- [Sobre](#about) +- [Recursos](#features) +- [Instalação](#installation) +- [Contributing](#contributing) + - [Junte-se ao nosso Telegram](#join-our-telegram) + - [Fork e clone seu repositorio](#fork-and-clone-your-repository) + - [Como contribuir](#ways-you-can-contribute) + - [Estrutura do projeto](#project-structure) +- [Compile a partir do codigo fonte](#build-from-source) + - [Instale Node.js](#install-nodejs) + - [Instale Yarn](#install-yarn) + - [Instale Node Dependencies](#install-node-dependencies) + - [Instale Python 3.9](#install-python-39) + - [Instale Python Dependencies](#install-python-dependencies) +- [variaveis de ambiente](#environment-variables) +- [Rodando o programa](#running) +- [Compilando](#build) + - [Compile o client bittorrent](#build-the-bittorrent-client) + - [Compile a aplicação Electron](#build-the-electron-application) +- [Contribuidores](#contributors) + +## About + +**Hydra** is a **Game Launcher** with its own embedded **BitTorrent Client** and a **self-managed repack scraper**. +
+The launcher is written in TypeScript (Electron) and Python, which handles the torrenting system by using libtorrent. + +## Features + +- Self-Managed repack scraper among all the most reliable websites on the [Megathread]("https://www.reddit.com/r/Piracy/wiki/megathread/") +- Own embedded bittorrent client +- How Long To Beat (HLTB) integration on game page +- Downloads path customization +- Repack list update notifications +- Windows and Linux support +- Constantly updated +- And more ... + +## Installation + +Follow the steps below to install: + +1. Download the latest version of Hydra from the [Releases](https://github.com/hydralauncher/hydra/releases/latest) page. + - Download only .exe if you want to install Hydra on Windows. + - Download .deb or .rpm or .zip if you want to install Hydra on Linux. (depends on your Linux distro) +2. Run the downloaded file. +3. Enjoy Hydra! + +## Contribuindo + +### Junte-se ao nosso Telegram + +Concentramos nossas discussões no nosso canal do [Telegram](https://t.me/hydralauncher). + +### Fork and clone your repository + +1. Fork the repository [(click here to fork now)](https://github.com/hydralauncher/hydra/fork) +2. Clone your forked code `git clone https://github.com/your_username/hydra` +3. Create a new branch +4. Push your commits +5. Submit a new Pull Request + +### Ways you can contribute + +- Translation: We want Hydra to be available to as many people as possible. Feel free to help translate to new languages or update and improve the ones that are already available on Hydra. +- Code: Hydra is built with Typescript, Electron and a little bit of Python. If you want to contribute, join our [Telegram](https://t.me/hydralauncher)! + +### Project Structure + +- torrent-client: We use libtorrent, a Python library, to manage torrent downloads +- src/renderer: the UI of the application +- src/main: all the logic rests here. + +## Build from source + +### Install Node.js + +Ensure you have Node.js installed on your machine. If not, download and install it from [nodejs.org](https://nodejs.org/). + +### Install Yarn + +Yarn is a package manager for Node.js. If you haven't installed Yarn yet, you can do so by following the instructions on [yarnpkg.com](https://classic.yarnpkg.com/lang/en/docs/install/). + +### Install Node Dependencies + +Navigate to the project directory and install the Node dependencies using Yarn: + +```bash +cd hydra +yarn +``` + +### Install Python 3.9 + +Ensure you have Python 3.9 installed on your machine. You can download and install it from [python.org](https://www.python.org/downloads/release/python-3919/). + +### Install Python Dependencies + +Install the required Python dependencies using pip: + +```bash +pip install -r requirements.txt +``` + +## Environment variables + +You'll need an SteamGridDB API Key in order to fetch the game icons on installation. +If you want to have onlinefix as a repacker you'll need to add your credentials to the .env + +Once you have it, you can copy or rename the `.env.example` file to `.env`and put it on`STEAMGRIDDB_API_KEY`, `ONLINEFIX_USERNAME`, `ONLINEFIX_PASSWORD`. + +## Running + +Once you've got all things set up, you can run the following command to start both the Electron process and the bittorrent client: + +```bash +yarn dev +``` + +## Build + +### Build the bittorrent client + +Build the bittorrent client by using this command: + +```bash +python torrent-client/setup.py build +``` + +### Build the Electron application + +Build the Electron application by using this command: + +On Windows: + +```bash +yarn build:win +``` + +On Linux: + +```bash +yarn build:linux +``` + +## Contributors +Feito com [contrib.rocks](https://contrib.rocks). + +> [!NOTE] +> Pode levar ate um dia para a lista ser atualizada. + + + + + + +## License + +Hydra is licensed under the [MIT License](LICENSE). diff --git a/README.ru.md b/README.ru.md index 5fbee317..bb6961e4 100644 --- a/README.ru.md +++ b/README.ru.md @@ -9,9 +9,6 @@ Hydra - это игровой лаунчер с собственным встроенным клиентом BitTorrent и самостоятельным scraper`ом для репаков.

- - - @@ -20,6 +17,12 @@

+Для этого README на других языках выберите здесь: + +[![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md) +[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md) +[![ru](https://img.shields.io/badge/lang-ru-yellow.svg)](README.ru.md) + ![Hydra Catalogue](./docs/screenshot.png) @@ -34,8 +37,8 @@ - [Описание](#описание) - [Особенности](#особенности) - [Установка](#установка) -- [Сотрудничество](#сотрудничество) - - [Присоединяйтесь к нашему Discord](#присоединяйтесь-к-нашему-discord) +- [Сотрудничество](#contributing) + - [Присоединяйтесь к нашему Telegram](#join-our-telegram) - [Форк и клонирование репозитория](#форк-и-клонирование-репозитория) - [Способы внести свой вклад](#способы-внести-свой-вклад) - [Структура проекта](#структура-проекта) @@ -79,15 +82,11 @@ 2. Запустите скачанный файл. 3. Наслаждайтесь Hydra! -## Сотрудничество +## Вклад -### Присоединяйтесь к нашему Discord +### Присоединяйтесь к нашему Telegram -Мы сосредотачиваем наши обсуждения на нашем [Discord](https://discord.gg/hydralauncher) сервере. - -1. Присоединитесь к нашему серверу. -2. Перейдите в канал ролей и получите роль Collaborator. -3. Перейдите в канал Dev, общайтесь с нами и делитесь своими идеями. +Мы сосредотачиваем наши обсуждения в нашем канале [Telegram](https://t.me/hydralauncher). ### Форк и клонирование репозитория @@ -100,7 +99,7 @@ ### Способы внести свой вклад - Перевод: Мы хотим, чтобы Hydra была доступна как можно большему количеству людей. Не стесняйтесь помогать переводить на новые языки или обновлять и улучшать те, которые уже доступны в Hydra. -- Код: Hydra создан с использованием TypeScript, Electron и немного Python. Если хотите внести свой вклад, присоединяйтесь к нашему серверу Discord! +- Код: Hydra создан с использованием TypeScript, Electron и немного Python. Если хотите внести свой вклад, присоединяйтесь к нашему серверу [Telegram](https://t.me/hydralauncher)! ### Структура проекта @@ -181,133 +180,15 @@ yarn build:linux ``` ## Участники +Сделано с [contrib.rocks](https://contrib.rocks). + +> [!NOTE] +> Обновление списка может занять до одного дня. + + + + - - - - - - - - - - - - - - - - - - - - - - -
- - hydralauncher -
- Hydra - - 		- - zamitto -
- Null - - 		- - fzanutto -
- Null - - 		- - JackEnx -
- Null - - 		- - Magrid0 -
- Magrid - - 		- - fhilipecrash -
- Fhilipe Coelho - -
- - jps14 -
- José Luís - - 		- - shadowtosser -
- Null - - 		- - pmenta -
- João Martins - - 		- - ferivoq -
- FeriVOQ - - 		- - xbozo -
- Guilherme Viana - - 		- - eltociear -
- Ikko Eltociear Ashimine - -
- - Netflixyapp -
- Netflixy - - 		- - Hachi-R -
- Hachi - - 		- - FerNikoMF -
- Firdavs - - 		- - userMacieG -
- Maciej Ratyński - - 		- - Tunchichi -
- Ruslan - -
- ## License