From be10bc9cfcd795227b5739c701b04fe9077144ce Mon Sep 17 00:00:00 2001 From: Zamitto Date: Sat, 4 May 2024 13:39:18 -0300 Subject: [PATCH] update README.md --- README.md | 204 ++++++++++++++++++++++-------------------------------- 1 file changed, 81 insertions(+), 123 deletions(-) diff --git a/README.md b/README.md index 6b7e8925..d1262f61 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,73 @@ -# Hydra +
-![Discord](https://img.shields.io/discord/1220692017311645737?style=flat&logo=discord&label=Hydra&labelColor=%231c1c1c) -![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hydralauncher/hydra/build.yml) -![GitHub package.json version](https://img.shields.io/github/package-json/v/hydralauncher/hydra) - -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](https://www.libtorrent.org/). +
+ + + +

Hydra Launcher

+

+ Hydra is a game launcher with its own embedded bittorrent client and a self-managed repack scraper. +

+

+ + + + + + + + + +

![Hydra Catalogue](./docs/screenshot.png) +
+ +
+ +## Table of Contents + +- [About](#about) +- [Features](#features) +- [Installation](#installation) +- [How to Open Dev Mode](#how-to-open-dev-mode) + +## 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, Linux and MacOS 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! + +## Contributing + +### Join our Discord + +We concentrate our discussions on our [Discord](https://discord.gg/hydralauncher) server. + +Join, grab the Collaborator role, go the dev channel and we talk to us and share your ideas. + ### Install Node.js Ensure you have Node.js installed on your machine. If not, download and install it from [nodejs.org](https://nodejs.org/). @@ -36,7 +93,7 @@ yarn ### Install Python 3.9 -Ensure you have Python installed on your machine. You can download and install it from [python.org](https://www.python.org/downloads/release/python-3919/). +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 @@ -48,7 +105,7 @@ pip install -r requirements.txt ## Environment variables -You'll need a SteamGridDB API Key in order to fetch the game icons on installation. +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 paste the `.env.example` file and put it on `STEAMGRIDDB_API_KEY`, `ONLINEFIX_USERNAME`, `ONLINEFIX_PASSWORD`. @@ -58,7 +115,7 @@ Once you have it, you can paste the `.env.example` file and put it on `STEAMGRID 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 start +yarn dev ``` ## Build @@ -75,124 +132,25 @@ python torrent-client/setup.py build Build the Electron application by using this command: +On Windows: + ```bash -yarn make +yarn build:win +``` + +On Linux: + +```bash +yarn build:linux ``` ## Contributors - - - - - - - - - - - - - - - - - - - - -
- - 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 - -
- + + + + +Made with [contrib.rocks](https://contrib.rocks). ## License