diff --git a/README.md b/README.md index ed6ad48..a40f832 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,35 @@ -# PirateLauncher - A Download Manager/Launcher +# SoftwareManager - A Download Manager/Launcher ## Description -PirateLauncher is a Python-based GUI/TUI tool that simplifies downloading and managing pirated software from various sources. +SoftwareManager is a Python-based GUI/TUI tool that simplifies downloading and managing free software from various sources. ## Features +- VPN Binding (impl. soon) +- Bandwidth/Download speed limiting (impl. soon) +- UI Theming - Start downloads via a predefined magnet URI. -- View detailed download information (name, speed, and status). - -## Requirements -- Python 3.x -- `aria2c` (installed and available in your PATH) -- Python libraries: - - `aria2p` - - `keyboard` +- View detailed download information (name, speed, and status). (improved impl. soon) ## Installation +1. Download the binary file for your operating system from releases + https://github.com/KeksPirates/SoftwareManager/releases +2. Run the file + +## Manual Installation 1. Ensure Python 3.x is installed on your system. -2. Install Aria2: +2. Install Dependencies: ```bash - sudo apt install aria2 # For Debian/Ubuntu/Mint - paru/yay -S aria2 # For Arch from AUR - brew install aria2 # For macOS - choco install aria2 # For Windows + pip install -r requirements.txt ``` -4. Install the required Python libraries: +3. Run main.py: ```bash - pip install aria2p keyboard + python3 main.py ``` -## Usage -1. Clone or download PirateLauncher to your local machine. -2. Run the launcher: - ```bash - python pirate_launcher.py - ``` -3. Use the following keyboard controls: - - Press **`d`** to start/resume a download. - - Press **`s`** to pause all downloads. - - Press **`q`** to quit the launcher. - - -## Configuration -- To use a different magnet URI, update the `magnet_uri` variable in the script. -- Ensure the RPC port (default: 6800) is open and accessible. - -## Example -Run the following command to launch PirateLauncher and control downloads: - -```bash -python pirate_launcher.py -``` - -Press `d` to start the predefined download, `s` to pause, and `q` to quit. - ## Notes -- Aria2 must be installed and accessible from your command line. +- If you want to host your own server, clone the server branch of this repo, enter your cookie for rutracker.org and run server.py. Detailed Instructions on how to get your rutracker cookie are in the README of its branch. - This tool is for educational purposes only. Use it responsibly. --- -**Disclaimer:** PirateLauncher is intended for legal and ethical use only. Ensure compliance with applicable laws and regulations when using this tool. - +**Disclaimer:** SoftwareManager is intended for legal and ethical use only. Ensure compliance with applicable laws and regulations when using this tool.