mirror of
https://github.com/MasterAcnolo/Freedom-Loader.git
synced 2026-07-29 18:25:47 +02:00
feat: publish package to fedora copr, add script to automaticaly build and upload the file.
Enhance readme and fix auto updater issue
This commit is contained in:
138
README.md
138
README.md
@@ -5,9 +5,9 @@
|
||||
alt="Banner"
|
||||
style="width: 50%;"/></a>
|
||||
|
||||
### **A clean, open-source multimedia downloader for Windows**
|
||||
### **A clean, open-source multimedia downloader for Windows and Linux**
|
||||
|
||||
[](https://github.com/MasterAcnolo/Freedom-Loader/releases)
|
||||
[](https://github.com/MasterAcnolo/Freedom-Loader/releases)
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
[](https://masteracnolo.github.io/Freedom-Loader-Site/)
|
||||
[](https://masteracnolo.github.io/Freedom-Loader-Workshop/)
|
||||
@@ -86,35 +86,84 @@ The primary goal is to make media downloading accessible to users who want offli
|
||||
|
||||
## Installation
|
||||
|
||||
[](https://copr.fedorainfracloud.org/coprs/masteracnolo/freedom-loader/)
|
||||
[](https://github.com/MasterAcnolo/Freedom-Loader/releases)
|
||||
|
||||
[//]: # ([](https://snapcraft.io/freedom-loader))
|
||||
[](https://github.com/MasterAcnolo/Freedom-Loader/releases)
|
||||
|
||||
### Requirements
|
||||
|
||||
- **Operating System**: Windows 10 or later
|
||||
- **Browser**: Mozilla Firefox (required for cookie extraction)
|
||||
- [Download Firefox](https://www.firefox.com)
|
||||
- **Windows**: Windows 10 or later
|
||||
- **Linux**: any modern x86_64 distribution
|
||||
- **Browser**: Mozilla Firefox ([download](https://www.firefox.com)) required for cookie extraction, on both platforms
|
||||
|
||||
### Standard Installation
|
||||
### Windows
|
||||
|
||||
1. Download the latest release from the [Releases page](https://github.com/MasterAcnolo/Freedom-Loader/releases)
|
||||
2. Run the downloaded `.exe` installer
|
||||
3. If Windows Defender shows a warning, click "More info" then "Run anyway"
|
||||
4. Follow the installation wizard
|
||||
1. Download the latest `.exe` from the [Releases page](https://github.com/MasterAcnolo/Freedom-Loader/releases)
|
||||
2. Run the installer (click "More info" → "Run anyway" if Windows Defender warns you)
|
||||
3. Follow the installation wizard
|
||||
|
||||
### Linux
|
||||
|
||||
#### Fedora (via Copr — recommended)
|
||||
|
||||
Installing via Copr lets `dnf` handle future updates automatically:
|
||||
|
||||
```bash
|
||||
sudo dnf copr enable masteracnolo/freedom-loader
|
||||
sudo dnf install freedom-loader
|
||||
```
|
||||
|
||||
#### Debian / Ubuntu (.deb)
|
||||
|
||||
```bash
|
||||
# Download the latest .deb from the Releases page, then:
|
||||
sudo apt install ./freedom-loader_1.x.x_amd64.deb
|
||||
```
|
||||
|
||||
[//]: # (#### Snap (any distro with snapd))
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (```bash)
|
||||
|
||||
[//]: # (sudo snap install freedom-loader)
|
||||
|
||||
[//]: # (```)
|
||||
|
||||
#### RPM (Fedora/RHEL/openSUSE, without Copr)
|
||||
|
||||
```bash
|
||||
sudo dnf install ./freedom-loader-1.x.y.x86_64.rpm
|
||||
```
|
||||
|
||||
#### AppImage (any distro, no installation needed)
|
||||
|
||||
```bash
|
||||
# Download the latest .AppImage from the Releases page, then:
|
||||
chmod +x Freedom-Loader-1.x.y.AppImage
|
||||
./Freedom-Loader-1.x.y.AppImage
|
||||
```
|
||||
|
||||
Once installed via any method, launch Freedom Loader from your application menu, or from a terminal with:
|
||||
```bash
|
||||
freedom-loader
|
||||
```
|
||||
|
||||
### File Locations
|
||||
|
||||
Downloaded files are stored in:
|
||||
```
|
||||
C:\Users\[USERNAME]\Downloads\Freedom Loader
|
||||
```
|
||||
> [!NOTE]
|
||||
> *You can change it whenever you want. Just click the "Edit" button in the UI.*
|
||||
| | Windows | Linux |
|
||||
|---------------|---------------------------------------------------------|--------------------------------------|
|
||||
| **Downloads** | `C:\Users\[USERNAME]\Downloads\Freedom Loader` | `~/Downloads/Freedom Loader` |
|
||||
| **Logs** | `C:\Users\[USERNAME]\AppData\Local\FreedomLoader\logs\` | `~/.local/share/FreedomLoader/logs/` |
|
||||
|
||||
Application logs can be found at:
|
||||
```
|
||||
C:\Users\[USERNAME]\AppData\Local\FreedomLoader\logs\
|
||||
```
|
||||
> [!NOTE]
|
||||
> The download folder can be changed anytime via the "Edit" button in the UI, on both platforms.
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP] On Linux, you can start Freedom Loader using `freedom-loader` command
|
||||
|
||||
### Basic Download
|
||||
|
||||
1. Launch Freedom Loader
|
||||
@@ -138,7 +187,7 @@ The application supports various configuration options:
|
||||
If you encounter issues:
|
||||
|
||||
1. Restart the application
|
||||
2. Check the logs in `AppData\Local\FreedomLoader\logs\`
|
||||
2. Check the logs in `AppData\Local\FreedomLoader\logs\` or `~/.local/share/FreedomLoader/logs`
|
||||
3. Open the developer console: `CTRL + SHIFT + I` → "Toggle Developer Tools"
|
||||
4. Create an issue on GitHub with logs and reproduction steps
|
||||
|
||||
@@ -164,10 +213,17 @@ If you encounter issues:
|
||||
Freedom Loader can be configured either through the settings panel in the UI or by directly editing the `config.json` file located in the application data directory.
|
||||
|
||||
### Configuration File Location
|
||||
|
||||
#### Windows
|
||||
```
|
||||
%APPDATA%\Freedom Loader\config.json
|
||||
```
|
||||
|
||||
#### Linux
|
||||
```
|
||||
~/.config/Freedom Loader/config.json
|
||||
```
|
||||
|
||||
### Available Options
|
||||
```json
|
||||
{
|
||||
@@ -192,24 +248,24 @@ Freedom Loader can be configured either through the settings panel in the UI or
|
||||
|
||||
### Configuration Options
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `autoUpdate` | boolean | `true` | Enable automatic application updates |
|
||||
| `discordRPC` | boolean | `true` | Enable Discord Rich Presence integration |
|
||||
| `customTopBar` | boolean | `true` | Use custom application top bar |
|
||||
| `autoCheckInfo` | boolean | `true` | Automatically fetch video information on URL paste |
|
||||
| `addThumbnail` | boolean | `true` | Embed thumbnail in downloaded audio files |
|
||||
| `addMetadata` | boolean | `true` | Add metadata tags to downloaded files |
|
||||
| `verboseLogs` | boolean | `false` | Enable detailed logging for debugging |
|
||||
| `autoDownloadPlaylist` | boolean | `true` | Automatically download entire playlists |
|
||||
| `createPlaylistFolders` | boolean | `true` | Automatically create a folder for a playlist |
|
||||
| `customCodec` | string | `"h264"` | Video codec for encoding (supported: h264, h265, vp9, av1) |
|
||||
| `logSystem` | boolean | `true` | Enable application logging |
|
||||
| `outputTitleCheck` | boolean | `true` | Verify output file titles |
|
||||
| `downloadSystem` | boolean | `true` | Enable download system |
|
||||
| `notifySystem` | boolean | `true` | Enable system notifications |
|
||||
| `enableHardwareAcceleration` | boolean | `true` | Enable Hardware Acceleration |
|
||||
| `theme` | string | `dark` | Current Theme Name |
|
||||
| Option | Type | Default | Description |
|
||||
|------------------------------|---------|----------|------------------------------------------------------------|
|
||||
| `autoUpdate` | boolean | `true` | Enable automatic application updates |
|
||||
| `discordRPC` | boolean | `true` | Enable Discord Rich Presence integration |
|
||||
| `customTopBar` | boolean | `true` | Use custom application top bar |
|
||||
| `autoCheckInfo` | boolean | `true` | Automatically fetch video information on URL paste |
|
||||
| `addThumbnail` | boolean | `true` | Embed thumbnail in downloaded audio files |
|
||||
| `addMetadata` | boolean | `true` | Add metadata tags to downloaded files |
|
||||
| `verboseLogs` | boolean | `false` | Enable detailed logging for debugging |
|
||||
| `autoDownloadPlaylist` | boolean | `true` | Automatically download entire playlists |
|
||||
| `createPlaylistFolders` | boolean | `true` | Automatically create a folder for a playlist |
|
||||
| `customCodec` | string | `"h264"` | Video codec for encoding (supported: h264, h265, vp9, av1) |
|
||||
| `logSystem` | boolean | `true` | Enable application logging |
|
||||
| `outputTitleCheck` | boolean | `true` | Verify output file titles |
|
||||
| `downloadSystem` | boolean | `true` | Enable download system |
|
||||
| `notifySystem` | boolean | `true` | Enable system notifications |
|
||||
| `enableHardwareAcceleration` | boolean | `true` | Enable Hardware Acceleration |
|
||||
| `theme` | string | `dark` | Current Theme Name |
|
||||
|
||||
### Supported Codecs
|
||||
|
||||
@@ -423,7 +479,7 @@ resources/
|
||||
- Write clear commit messages
|
||||
- Test thoroughly before submitting changes
|
||||
- Update documentation when adding features
|
||||
- Maintain compatibility with Windows 10+
|
||||
- Maintain compatibility with Windows 10+ and Linux
|
||||
|
||||
## Roadmap
|
||||
|
||||
@@ -445,7 +501,7 @@ Use the GitHub Issues system and include:
|
||||
- Clear description of the issue
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Relevant logs from `AppData\Local\FreedomLoader\logs\`
|
||||
- Relevant logs from `AppData\Local\FreedomLoader\logs\` or `~/.local/share/FreedomLoader/logs/`
|
||||
- Screenshots if applicable
|
||||
|
||||
### Feature Requests
|
||||
|
||||
Reference in New Issue
Block a user