xixu-me/xget-now
1
0 Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: align readmes with create-readme

Browse Source
This commit is contained in:
xixu-me committed 2026-04-11 21:54:58 +08:00
1 parent 70fa0cb9c1
commit 3fec6dab96
2 files changed
+281 -327
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.en.md
+142 -165
View File
@@ -4,16 +4,30 @@
A cross-browser extension for Chromium and Firefox that accelerates file downloads by seamlessly forwarding them to an [Xget](https://github.com/xixu-me/Xget) instance. A cross-browser extension for Chromium and Firefox that accelerates file downloads by seamlessly forwarding them to an [Xget](https://github.com/xixu-me/Xget) instance.
## 🚀 Features > [!NOTE]
> Quick start: install the store version, enter your Xget domain such as `xget.xi-xu.me`, and leave the target platform toggles enabled.
- **🎯 Automatic Download Acceleration**: Seamlessly redirect downloads through Xget for faster speeds ## Overview
- **⚙️ Configurable Settings**: Customize your Xget domain and platform preferences
- **🔔 Smart Notifications**: Visual feedback when downloads are redirected
- **🛡️ Privacy-First**: All processing happens locally in your browser
- **🎛️ Per-Platform Control**: Enable/disable acceleration for specific platforms
- **🌐 Cross-Browser Support**: Works on both Chromium and Firefox browsers
## 📦 Installation Xget Now detects real download links on supported websites, rewrites them to your Xget domain, and keeps the browser's native download flow intact. You do not need to modify the original site or manually copy download URLs.
## Features
- Automatic download acceleration: seamlessly redirect downloads through Xget for faster speeds.
- Configurable settings: customize your Xget domain and platform preferences.
- Smart notifications: visual feedback when downloads are redirected.
- Privacy-first: all processing happens locally in your browser.
- Per-platform control: enable or disable acceleration for specific platforms.
- Cross-browser support: works on both Chromium and Firefox browsers.
## Supported Platforms
- Code hosting: GitHub, GitLab, Gitea, Codeberg, SourceForge, AOSP.
- AI / ML: Hugging Face.
- Package and distribution platforms: npm, PyPI, PyPI Files, Conda, Conda Community, Maven Central, Apache Downloads, Gradle Plugin Portal, RubyGems, CRAN, CPAN, CTAN, Go Modules, NuGet, Crates.io, Packagist.
- Other platforms: arXiv, F-Droid.
## Installation
### Store Availability ### Store Availability
@@ -24,206 +38,166 @@ A cross-browser extension for Chromium and Firefox that accelerates file downloa
### Manual Installation ### Manual Installation
If you prefer to manually install the extension or if the store version is unavailable, you can download and install it directly: If you prefer manual installation, or if a store listing is unavailable, you can install Xget Now from GitHub releases or directly from source.
#### Option 1: Install from GitHub Releases (Recommended) #### Option 1: Install from GitHub Releases
1. **Download the Extension** 1. Go to the [Releases page](https://github.com/xixu-me/Xget-Now/releases/latest).
- Go to the [Releases page](https://github.com/xixu-me/Xget-Now/releases/latest) 2. Download the package for your browser:
- Download the appropriate extension file for your browser: - `Xget-Now_x.x.x.chromium.zip`: for Chromium-based browsers such as Chrome, Edge, and Opera.
- `Xget-Now_x.x.x.chromium.zip` - For all Chromium-based browsers (Chrome, Edge, Opera, etc.) - `Xget-Now_x.x.x.firefox.xpi`: for Firefox.
- `Xget-Now_x.x.x.firefox.zip` - For Firefox browsers 3. Install in Chrome:
- Extract the Chromium `.zip` package.
2. **Install in Chrome** - Open `chrome://extensions/`.
- Extract the downloaded Chromium version .zip file - Enable "Developer mode" in the top-right corner.
- Open Chrome and navigate to `chrome://extensions/` - Click "Load unpacked" and select the extracted folder.
- Enable "Developer mode" (toggle in the top right corner) 4. Install in Firefox:
- Click "Load unpacked" and select the extracted folder - Open `about:debugging`.
- Click "This Firefox".
3. **Install in Firefox** - Click "Load Temporary Add-on".
- Open Firefox and navigate to `about:debugging` - Select the Firefox `.xpi` file, or the `manifest.json` file from an extracted package.
- Click "This Firefox" 5. Install in Edge:
- Click "Load Temporary Add-on" - Extract the Chromium `.zip` package.
- Select the downloaded Firefox version .zip file or the `manifest.json` file from the extracted folder - Open `edge://extensions/`.
- Enable "Developer mode" in the left sidebar.
4. **Install in Edge** - Click "Load unpacked" and select the extracted folder.
- Extract the downloaded Chromium version .zip file 6. Install in other Chromium-based browsers:
- Open Edge and navigate to `edge://extensions/` - Use the Chromium package.
- Enable "Developer mode" (toggle in the left sidebar) - Enable that browser's developer mode first.
- Click "Load unpacked" and select the extracted folder - Follow the browser-specific extension loading instructions.
5. **Install in Other Chromium-Based Browsers**
- Use the Chromium version of the extension package
- Follow similar steps as Chrome or Edge, ensuring "Developer mode" is enabled first
- Refer to your specific browser's extension installation guide
#### Option 2: Install from Source #### Option 2: Install from Source
1. **Clone the Repository** 1. Clone the repository:
```bash ```bash
git clone https://github.com/xixu-me/Xget-Now.git git clone https://github.com/xixu-me/Xget-Now.git
cd Xget-Now cd Xget-Now
``` ```
2. **Build the Extension (Optional)** 2. Build the extension if needed:
If you want to use the optimized version: `build.py` only uses the Python standard library, so Python 3.7+ is enough.
```bash ```bash
# Install Python 3.7+ python build.py --platform chrome
pip install -r requirements.txt # If there's a requirements file python build.py --platform firefox
python build.py --platform all
# Build for specific browser python build.py --platform all --package
python build.py --platform chrome # Build Chrome version
python build.py --platform firefox # Build Firefox version
python build.py --platform all # Build all versions
``` ```
3. **Load in Browser** 3. Load it in the browser:
- Chromium browsers:
**Chromium Browsers:** - Open `chrome://extensions/` or `edge://extensions/`.
- Open your browser's extensions management page (`chrome://extensions/` or `edge://extensions/`) - Enable "Developer mode".
- Enable "Developer mode" - Click "Load unpacked" and select either the repository root, or `build/chrome/` if you built the packaged version.
- Click "Load unpacked" and select: - Firefox:
- The repository root directory (if using raw source) - Open `about:debugging`.
- The `build/chrome/` directory (if using built version) - Click "This Firefox".
- Click "Load Temporary Add-on".
**Firefox Browser:** - Select `manifest-firefox.json` from the repository root, or `build/firefox/manifest.json` from a build output.
- Open `about:debugging`
- Click "This Firefox"
- Click "Load Temporary Add-on"
- Select either:
- `manifest-firefox.json` from the repository root (if using raw source)
- `manifest.json` from the `build/firefox/` directory (if using built version)
#### Verify Installation #### Verify Installation
After installation, you should see the Xget extension icon in your browser toolbar. Click it to configure your Xget domain and start accelerating downloads! After installation, you should see the Xget Now icon in the browser toolbar. Click it, configure your Xget domain, and start accelerating downloads.
## ⚙️ Configuration ## Configuration
1. **Configure Xget Domain** 1. Click the extension icon in the browser toolbar.
- Click the extension icon in the toolbar 2. Enter your Xget domain, for example `xget.xi-xu.me`.
- Enter your Xget domain (e.g., `xget.xi-xu.me`) 3. Enable the extension and toggle supported platforms on or off as needed.
- Enable the extension 4. Visit any supported platform and click download links as usual.
5. Downloads will automatically be routed through Xget.
2. **Select Platforms** ## How It Works
- Toggle switches for individual platforms as needed
- All platforms are enabled by default
3. **Start Downloading** 1. Detection: the extension monitors download links on supported platforms.
- Visit any supported platform 2. Transformation: URLs are converted to an Xget-compatible format.
- Click download links as usual 3. Redirection: downloads are routed through your configured Xget domain.
- Downloads will automatically be accelerated through Xget 4. Acceleration: Xget's CDN and optimization features provide faster download speeds.
## 🔧 How It Works ## Requirements
1. **Detection**: The extension monitors download links on supported platforms
2. **Transformation**: URLs are automatically converted to Xget-compatible format
3. **Redirection**: Downloads are routed through your configured Xget domain
4. **Acceleration**: Xget's global CDN and optimization features provide faster download speeds
## 📋 Requirements
### Browser Support ### Browser Support
**Chromium Browsers:** - Chrome: 88+.
- Edge: 88+.
- **Chrome**: Version 88+ - Opera: 74+.
- **Edge**: Version 88+ - Other Chromium-based browsers: versions with Manifest V3 support.
- **Opera**: Version 74+ - Firefox: 109+.
- **Other Chromium-based browsers**: Versions supporting Manifest V3 - Firefox ESR: 109+.
**Firefox Browsers:**
- **Firefox**: Version 109+
- **Firefox ESR**: Version 109+
### Xget Instance ### Xget Instance
Use the pre-deployed instance `xget.xi-xu.me` or deploy your own by following the [Xget deployment documentation](https://github.com/xixu-me/Xget#-deployment). Use the pre-deployed instance `xget.xi-xu.me`, or deploy your own by following the [Xget deployment documentation](https://github.com/xixu-me/Xget#-deployment).
## 🔒 Privacy & Security ## Privacy and Security
- **Local Processing**: All URL transformations happen in your browser - Local processing: all URL transformations happen in your browser.
- **No Data Collection**: The extension doesn't collect or transmit personal data - No data collection: the extension does not collect or transmit personal data.
- **Minimal Permissions**: Only requests necessary permissions for functionality - Minimal permissions: it only requests permissions needed for the feature set.
- **Open Source**: Full source code available for inspection - Open source: the full source code is available for inspection.
See our [Privacy Policy](PRIVACY_POLICY.md) for complete details. See the [Privacy Policy](PRIVACY_POLICY.md) for complete details.
## 🐛 Troubleshooting ## Troubleshooting
### Common Issues ### Common Issues
**Extension Not Working?** **Extension not working?**
- Ensure you've configured a valid Xget domain - Ensure you configured a valid Xget domain.
- Check if the extension is enabled in the popup - Check whether the extension is enabled in the popup.
- Verify the target platform is enabled - Verify that the target platform is enabled.
- Try refreshing the page after changing settings - Refresh the page after changing settings.
**Downloads Not Being Redirected?** **Downloads not being redirected?**
- Refresh the page after changing settings - Refresh the page after changing settings.
- Check browser console for error messages (F12 → Console) - Check the browser console for error messages (`F12` -> Console).
- Ensure the link is a recognized download type - Ensure the link is a recognized download type.
- Verify you're clicking an actual download link, not a navigation link - Confirm that you clicked an actual download link rather than a navigation link.
**Xget Domain Issues?** **Xget domain issues?**
- Domain should be without the `https://` protocol - Enter the domain without the `https://` protocol.
- Example: `xget.xi-xu.me` (not `https://xget.xi-xu.me`) - Example: `xget.xi-xu.me`, not `https://xget.xi-xu.me`.
- Check if the domain is accessible in your browser - Check whether the domain is reachable in your browser.
- Try using the default pre-deployed instance: `xget.xi-xu.me` - Try the default pre-deployed instance first: `xget.xi-xu.me`.
**Performance Issues?** **Performance issues?**
- Check your network connection - Check your network connection.
- Try a different Xget domain if available - Try another Xget domain if one is available.
- Verify the target platform's servers are responsive - Verify that the target platform is responding normally.
- Clear browser cache and reload the extension - Clear the browser cache and reload the extension.
**Firefox-Specific Issues?** **Firefox-specific issues?**
- Ensure Firefox version is 109+ - Ensure Firefox is version 109 or newer.
- Check if the extension is properly loaded in `about:debugging` - Check whether the extension is correctly loaded in `about:debugging`.
- Firefox may require a browser restart to fully apply extension settings - Firefox may require a restart to fully apply extension settings.
- Check Firefox's Privacy & Security settings aren't blocking extension features - Review Firefox Privacy & Security settings to make sure they are not blocking extension behavior.
### Debug Mode ### Debug Mode
**Chromium Browsers:** In Chromium browsers, open DevTools and inspect the Console tab. In Firefox, open `about:debugging`, click "This Firefox", find Xget Now, click "Inspect", and review the console output there.
Enable Chrome DevTools and check the Console tab for debug messages: Common debug messages:
**Firefox Browser:** - Extension loaded: `Xget Now: Content script loaded`
- Download redirect: `Redirecting download: [original] -> [Xget]`
- Settings changed: `Settings updated! Click to refresh page`
1. Open `about:debugging` ## FAQ
2. Click "This Firefox"
3. Find the Xget Now extension and click "Inspect"
4. View console messages in the opened developer tools
**Common Debug Messages:**
- Extension loaded: "Xget Now: Content script loaded"
- Download redirect: "Redirecting download: [original] -> [Xget]"
- Settings changed: "Settings updated! Click to refresh page"
## 📄 License
This repository is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
## ❓ FAQ
### Is this extension free? ### Is this extension free?
Yes, the extension is completely free and open source under the GPL-3.0 license. Yes. The extension is completely free and open source under GPL-3.0.
### Can I use my own Xget server? ### Can I use my own Xget server?
Absolutely! You can deploy your own Xget instance using the [Xget repository](https://github.com/xixu-me/Xget) and configure the extension to use your domain. Yes. You can deploy your own Xget instance from the [Xget repository](https://github.com/xixu-me/Xget) and point the extension to your own domain.
### Why are some downloads still going through the original server? ### Why are some downloads still going through the original server?
@@ -231,37 +205,40 @@ The extension only redirects recognized download links. Navigation links, previe
### Will my browsing data be collected? ### Will my browsing data be collected?
No, the extension runs entirely locally. No browsing data is collected or transmitted. See our [Privacy Policy](PRIVACY_POLICY.md) for details. No. The extension runs entirely locally, and no browsing data is collected or transmitted. See the [Privacy Policy](PRIVACY_POLICY.md) for details.
### How much faster are the downloads? ### How much faster are the downloads?
Speed improvements vary depending on your location, network, and file size. Typical improvements range from 2x to 10x faster. Speed improvements depend on your location, network conditions, and file size. Typical gains range from roughly 2x to 10x.
### Can I disable the extension for specific websites? ### Can I disable the extension for specific websites?
Yes, use the per-platform toggle switches in the extension popup to disable acceleration for specific platforms. Yes. Use the per-platform toggle switches in the popup to disable acceleration for specific supported platforms.
### Why are there different versions for Chrome and Firefox? ### Why are there different versions for Chrome and Firefox?
Due to browser architecture differences, we've optimized for each browser: The two versions are optimized for different browser architectures:
- **Chrome version**: Uses Manifest V3, supporting the latest extension APIs and security features - Chrome version: uses Manifest V3 and newer extension APIs.
- **Firefox version**: Uses Manifest V2, ensuring optimal compatibility with Firefox's extension system - Firefox version: uses Manifest V2 for Firefox compatibility.
The core functionality is identical across both versions, with only slight technical implementation differences. The core behavior remains the same, while the implementation details differ slightly.
### Can I use it in both Chrome and Firefox simultaneously? ### Can I use it in Chrome and Firefox at the same time?
Absolutely! You can install and use Xget Now in multiple browsers simultaneously, and they'll work independently with their own settings. Yes. You can install Xget Now in multiple browsers at once, and each browser keeps its own settings.
## 🌟 Support Us ## Support
If you find this extension useful, please: If Xget Now is useful to you, consider:
- ⭐ Star this repository - Starring the repository.
- 📝 Leave a review: - Leaving a review:
- [Chrome Web Store](https://chromewebstore.google.com/detail/ajiejgobfcifcikbahpijopolfjoodgf?hl=en) - [Chrome Web Store](https://chromewebstore.google.com/detail/ajiejgobfcifcikbahpijopolfjoodgf?hl=en)
- [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/xget-now/) - [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/xget-now/)
- [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/jigpfhbegabdenhihpplcjhpfdcgnalc) - [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/jigpfhbegabdenhihpplcjhpfdcgnalc)
- 🐛 Report bugs or suggest features via [GitHub Issues](https://github.com/xixu-me/Xget-Now/issues) - Reporting bugs or suggesting features via [GitHub Issues](https://github.com/xixu-me/Xget-Now/issues).
- 📢 Share with others who might benefit from faster downloads - Sharing it with others who might benefit from faster downloads.
> [!NOTE]
> This repository is licensed under GPL-3.0. See [LICENSE](LICENSE) for the full text.
README.md
+139 -162
View File
@@ -2,23 +2,37 @@
***[English](README.en.md)*** ***[English](README.en.md)***
一个适用于 Chromium 和 Firefox 的跨浏览器扩展，通过将文件下载无缝转交给 [Xget](https://github.com/xixu-me/Xget) 实例来加速下载。
> [!TIP] > [!TIP]
> 欢迎加入“Xget 开源与 AI 交流群”，一起交流开源项目、AI 应用、工程实践、效率工具和独立开发；如果你也在做产品、写代码、折腾项目或者对开源和 AI 感兴趣，欢迎[**进群**](https://file.xi-xu.me/QR%20Codes/%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.png)认识更多认真做事、乐于分享的朋友。 > 欢迎加入“Xget 开源与 AI 交流群”，一起交流开源项目、AI 应用、工程实践、效率工具和独立开发；如果你也在做产品、写代码、折腾项目或者对开源和 AI 感兴趣，欢迎[**进群**](https://file.xi-xu.me/QR%20Codes/%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.png)认识更多认真做事、乐于分享的朋友。
一个适用于 Chromium 和 Firefox 的跨浏览器扩展，通过将文件下载无缝转交给 [Xget](https://github.com/xixu-me/Xget) 实例来加速下载。 > [!NOTE]
> 想快速开始：安装商店版本，填入你的 Xget 域名，例如 `xget.xi-xu.me`，保持目标平台开关开启即可。
## 🚀 功能特性 ## 概览
- **🎯 自动下载加速**：无缝重定向下载通过 Xget 获得更快速度 Xget Now 会在受支持的平台上识别真实下载链接，把请求重写到你的 Xget 域名，并继续使用浏览器原生下载流程。你不需要改动原始站点，也不需要手动复制链接。
- **⚙️ 可配置设置**：自定义你的 Xget 域名和平台偏好
- **🔔 智能通知**：下载重定向时的可视化反馈
- **🛡️ 隐私优先**：所有处理都在你的浏览器本地进行
- **🎛️ 按平台控制**：为特定平台启用/禁用加速
- **🌐 跨浏览器支持**：同时支持 Chromium 和 Firefox 浏览器
## 📦 安装 ## 功能特性
### 商店可用性 - 自动下载加速：无缝重定向下载，通过 Xget 获得更快速度。
- 可配置设置：自定义你的 Xget 域名和平台偏好。
- 智能通知：下载重定向时提供可视化反馈。
- 隐私优先：所有处理都在你的浏览器本地进行。
- 按平台控制：为特定平台启用或禁用加速。
- 跨浏览器支持：同时支持 Chromium 和 Firefox 浏览器。
## 支持的平台
- 代码托管平台：GitHub、GitLab、Gitea、Codeberg、SourceForge、AOSP。
- AI / ML 平台：Hugging Face。
- 包管理与分发平台：npm、PyPI、PyPI Files、Conda、Conda Community、Maven Central、Apache Downloads、Gradle Plugin Portal、RubyGems、CRAN、CPAN、CTAN、Go Modules、NuGet、Crates.io、Packagist。
- 其他平台：arXiv、F-Droid。
## 安装
### 商店安装
- [Chrome 应用商店](https://chromewebstore.google.com/detail/ajiejgobfcifcikbahpijopolfjoodgf?hl=zh-CN) - [Chrome 应用商店](https://chromewebstore.google.com/detail/ajiejgobfcifcikbahpijopolfjoodgf?hl=zh-CN)
- [Chrome 应用商店镜像](https://chromewebstore.xi-xu.me/detail/ajiejgobfcifcikbahpijopolfjoodgf) - [Chrome 应用商店镜像](https://chromewebstore.xi-xu.me/detail/ajiejgobfcifcikbahpijopolfjoodgf)
@@ -27,206 +41,166 @@
### 手动安装 ### 手动安装
如果你更喜欢手动安装扩展或应用商店版本不可用，你可以直接下载并安装： 如果你更喜欢手动安装扩展，或者应用商店版本不可用，可以直接下载发布包或从源码加载。
#### 选项 1：从 GitHub Releases 安装（推荐） #### 方式 1：从 GitHub Releases 安装
1. **下载扩展** 1. 前往 [Releases 页面](https://github.com/xixu-me/Xget-Now/releases/latest)。
- 前往 [Releases 页面](https://github.com/xixu-me/Xget-Now/releases/latest) 2. 下载对应浏览器的扩展文件：
- 下载对应浏览器的扩展文件： - `Xget-Now_x.x.x.chromium.zip`：适用于所有基于 Chromium 的浏览器，例如 Chrome、Edge、Opera。
- `Xget-Now_x.x.x.chromium.zip` - 适用于所有基于 Chromium 的浏览器（Chrome、Edge、Opera 等） - `Xget-Now_x.x.x.firefox.xpi`：适用于 Firefox 浏览器。
- `Xget-Now_x.x.x.firefox.zip` - 适用于 Firefox 浏览器 3. 在 Chrome 中安装：
- 解压 Chromium 版本 `.zip` 文件。
- 打开 `chrome://extensions/`。
- 启用右上角的“开发者模式”。
- 点击“加载已解压的扩展程序”，选择解压后的文件夹。
4. 在 Firefox 中安装：
- 打开 `about:debugging`。
- 点击“此 Firefox”。
- 点击“临时载入附加组件”。
- 选择下载的 Firefox `.xpi` 文件，或解压后目录中的 `manifest.json` 文件。
5. 在 Edge 中安装：
- 解压 Chromium 版本 `.zip` 文件。
- 打开 `edge://extensions/`。
- 启用左侧边栏中的“开发人员模式”。
- 点击“加载解压缩的扩展”，选择解压后的文件夹。
6. 在其他基于 Chromium 的浏览器中安装：
- 使用 Chromium 版本的扩展包。
- 先启用浏览器的“开发者模式”。
- 按照对应浏览器的扩展安装指南完成加载。
2. **在 Chrome 中安装** #### 方式 2：从源码安装
- 解压下载的 Chromium 版本 .zip 文件
- 打开 Chrome 并前往 `chrome://extensions/`
- 启用「开发者模式」（右上角的切换开关）
- 点击「加载已解压的扩展程序」并选择解压的文件夹
3. **在 Firefox 中安装** 1. 克隆仓库：
- 打开 Firefox 并前往 `about:debugging`
- 点击「此 Firefox」
- 点击「临时载入附加组件」
- 选择下载的 Firefox 版本 .zip 文件或解压后的 `manifest.json` 文件
4. **在 Edge 中安装**
- 解压下载的 Chromium 版本 .zip 文件
- 打开 Edge 并前往 `edge://extensions/`
- 启用「开发人员模式」（左侧边栏的切换开关）
- 点击「加载解压缩的扩展」并选择解压的文件夹
5. **在其他基于 Chromium 的浏览器中安装**
- 使用 Chromium 版本的扩展包
- 遵循与 Chrome 或 Edge 类似的步骤，确保首先启用「开发者模式」
- 按照相应浏览器的扩展安装指南进行操作
#### 选项 2：从源码安装
1. **克隆存储库**
```bash ```bash
git clone https://github.com/xixu-me/Xget-Now.git git clone https://github.com/xixu-me/Xget-Now.git
cd Xget-Now cd Xget-Now
``` ```
2. **构建扩展（可选）** 2. 可选构建：
如果你想使用优化过的版本： `build.py` 仅依赖 Python 标准库，安装 Python 3.7+ 后即可运行。
```bash ```bash
# 安装 Python 3.7+ python build.py --platform chrome
pip install -r requirements.txt # 如果有依赖文件 python build.py --platform firefox
python build.py --platform all
# 构建特定浏览器版本 python build.py --platform all --package
python build.py --platform chrome # 构建 Chrome 版本
python build.py --platform firefox # 构建 Firefox 版本
python build.py --platform all # 构建所有版本
``` ```
3. **在浏览器中加载** 3. 在浏览器中加载：
- Chromium 浏览器：
**Chromium 浏览器：** - 打开 `chrome://extensions/` 或 `edge://extensions/`。
- 打开浏览器的扩展管理页面（`chrome://extensions/` 或 `edge://extensions/`） - 启用“开发者模式”。
- 启用「开发者模式」 - 点击“加载已解压的扩展程序”，选择源码根目录，或选择构建后的 `build/chrome/` 目录。
- 点击「加载已解压的扩展程序」并选择： - Firefox 浏览器：
- 源码根目录（如果使用原始源码） - 打开 `about:debugging`。
- `build/chrome/` 目录（如果使用构建版本） - 点击“此 Firefox”。
- 点击“临时载入附加组件”。
**Firefox 浏览器：** - 选择源码根目录中的 `manifest-firefox.json`，或构建后的 `build/firefox/manifest.json`。
- 打开 `about:debugging`
- 点击「此 Firefox」
- 点击「临时载入附加组件」
- 选择以下文件之一：
- 源码根目录中的 `manifest-firefox.json`
- `build/firefox/` 目录中的 `manifest.json`（如果使用构建版本）
#### 验证安装 #### 验证安装
安装后，你应该在浏览器工具栏中看到 Xget 扩展图标。点击它来配置你的 Xget 域名并开始加速下载！ 安装后，你应该能在浏览器工具栏中看到 Xget Now 图标。点击图标，配置你的 Xget 域名并开始加速下载。
## ⚙️ 设置 ## 上手配置
1. **配置 Xget 域名** 1. 点击工具栏中的扩展图标。
- 点击工具栏中的扩展图标 2. 输入你的 Xget 域名，例如 `xget.xi-xu.me`。
- 输入你的 Xget 域名（例如 `xget.xi-xu.me`） 3. 启用扩展，并按需打开或关闭各个平台的开关。
- 启用扩展 4. 访问任何受支持的平台，像往常一样点击下载链接。
5. 下载会自动通过 Xget 转发和加速。
2. **选择平台** ## 工作原理
- 根据需要切换各个平台的开关
- 默认启用所有平台
3. **开始下载** 1. 检测：扩展监控受支持平台上的下载链接。
- 访问任何受支持的平台 2. 转换：URL 自动转换为 Xget 兼容格式。
- 像往常一样点击下载链接 3. 重定向：下载通过你配置的 Xget 域名路由。
- 下载将自动通过 Xget 加速 4. 加速：Xget 的全球 CDN 和优化能力提供更快的下载速度。
## 🔧 工作原理 ## 运行要求
1. **检测**：扩展监控受支持平台上的下载链接
2. **转换**：URL 自动转换为 Xget 兼容格式
3. **重定向**：下载通过你配置的 Xget 域名路由
4. **加速**：Xget 的全球 CDN 和优化功能提供更快的下载速度
## 📋 要求
### 浏览器支持 ### 浏览器支持
**Chromium 浏览器：** - Chrome：88+。
- Edge：88+。
- **Chrome**：版本 88+ - Opera：74+。
- **Edge**：版本 88+ - 其他基于 Chromium 的浏览器：支持 Manifest V3 的版本。
- **Opera**：版本 74+ - Firefox：109+。
- **其他基于 Chromium 的浏览器**：支持 Manifest V3 的版本 - Firefox ESR：109+。
**Firefox 浏览器：**
- **Firefox**：版本 109+
- **Firefox ESR**：版本 109+
### Xget 实例 ### Xget 实例
使用预部署实例 `xget.xi-xu.me` 或参考 [Xget 部署文档](https://github.com/xixu-me/Xget#-%E9%83%A8%E7%BD%B2) 自行部署。 你可以直接使用预部署实例 `xget.xi-xu.me`，也可以参考 [Xget 部署文档](https://github.com/xixu-me/Xget#-%E9%83%A8%E7%BD%B2) 自行部署。
## 🔒 隐私与安全 ## 隐私与安全
- **本地处理**：所有 URL 转换都在你的浏览器中进行 - 本地处理：所有 URL 转换都在你的浏览器中进行。
- **无数据收集**：扩展不收集或传输个人数据 - 无数据收集：扩展不收集或传输个人数据。
- **最小权限**：仅请求功能所需的必要权限 - 最小权限：仅请求功能所需的必要权限。
- **开源**：完整源码可供检查 - 开源可审计：完整源码可供检查。
查看我们的 [隐私政策](PRIVACY_POLICY.md) 了解完整详情。 查看 [隐私政策](PRIVACY_POLICY.md) 了解完整细节。
## 🐛 故障排除 ## 故障排除
### 常见问题 ### 常见问题
**扩展不工作？** **扩展不工作？**
- 确保你已配置有效的 Xget 域名 - 确保你已配置有效的 Xget 域名。
- 检查扩展在弹出窗口中是否已启用 - 检查扩展在弹出窗口中是否已启用。
- 验证目标平台是否已启用 - 验证目标平台是否已启用。
- 更改设置后尝试刷新页面 - 更改设置后尝试刷新页面。
**下载没有被重定向？** **下载没有被重定向？**
- 更改设置后刷新页面 - 更改设置后刷新页面。
- 检查浏览器控制台的错误消息（F12 → 控制台） - 检查浏览器控制台的错误消息（`F12` -> “控制台”）。
- 确保链接是被识别的下载类型 - 确保链接是被识别的下载类型。
- 验证你点击的是实际的下载链接，而不是导航链接 - 验证你点击的是实际下载链接，而不是导航链接。
**Xget 域名问题？** **Xget 域名问题？**
- 域名应该不带 `https://` 协议 - 域名应该不带 `https://` 协议。
- 示例：`xget.xi-xu.me`（不是 `https://xget.xi-xu.me`） - 示例：`xget.xi-xu.me`，而不是 `https://xget.xi-xu.me`。
- 检查域名在浏览器中是否可访问 - 检查域名在浏览器中是否可访问。
- 尝试使用默认的预部署实例：`xget.xi-xu.me` - 可以先尝试默认的预部署实例：`xget.xi-xu.me`。
**性能问题？** **性能问题？**
- 检查你的网络连接 - 检查你的网络连接。
- 如果可用，尝试其他 Xget 域名 - 如果可用，尝试其他 Xget 域名。
- 验证目标平台的服务器是否响应 - 验证目标平台的服务器是否响应。
- 清除浏览器缓存并重新加载扩展 - 清除浏览器缓存并重新加载扩展。
**Firefox 特定问题？** **Firefox 特定问题？**
- 确保 Firefox 版本为 109+ - 确保 Firefox 版本为 109+。
- 在 `about:debugging` 中检查扩展是否正确加载 - 在 `about:debugging` 中检查扩展是否正确加载。
- Firefox 可能需要重启浏览器才能完全应用扩展设置 - Firefox 可能需要重启浏览器才能完全应用扩展设置。
- 检查 Firefox 的「隐私和安全」设置是否阻止了扩展功能 - 检查 Firefox 的“隐私和安全”设置是否阻止了扩展功能。
### 调试模式 ### 调试模式
**Chromium 浏览器：** Chromium 浏览器中，打开开发者工具并查看 Console 选项卡。Firefox 中，打开 `about:debugging`，点击“此 Firefox”，找到 Xget Now 扩展并点击“检查”，然后查看控制台消息。
启用 Chrome 开发者工具并检查控制台选项卡中的调试消息： 常见调试消息：
**Firefox 浏览器：** - 扩展加载：`Xget Now: Content script loaded`
- 下载重定向：`Redirecting download: [original] -> [Xget]`
- 设置更改：`Settings updated! Click to refresh page`
1. 打开 `about:debugging` ## 常见问题
2. 点击「此 Firefox」
3. 找到 Xget Now 扩展并点击「检查」
4. 在打开的开发者工具中查看控制台消息
**通用调试消息：**
- 扩展加载：「Xget Now：内容脚本已加载」
- 下载重定向：「重定向下载：[原始] -> [Xget]」
- 设置更改：「设置已更新！点击刷新页面」
## 📄 许可证
本存储库采用 GPL-3.0 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
## ❓ 常见问题
### 这个扩展是免费的吗？ ### 这个扩展是免费的吗？
是的，扩展完全免费且在 GPL-3.0 许可证下开源。 是的，扩展完全免费，并且以 GPL-3.0 许可证开源。
### 我可以使用自己的 Xget 服务器吗？ ### 我可以使用自己的 Xget 服务器吗？
当然可以！你可以使用 [Xget 存储库](https://github.com/xixu-me/Xget) 部署自己的 Xget 实例，并配置扩展使用你的域名。 当然可以。你可以使用 [Xget 存储库](https://github.com/xixu-me/Xget) 部署自己的 Xget 实例，并配置扩展使用你的域名。
### 为什么有些下载仍然通过原始服务器？ ### 为什么有些下载仍然通过原始服务器？
@@ -234,37 +208,40 @@
### 我的浏览数据会被收集吗？ ### 我的浏览数据会被收集吗？
不会，扩展完全在本地运行。不收集或传输浏览数据。查看我们的 [隐私政策](PRIVACY_POLICY.md) 了解详情。 不会。扩展完全在本地运行，不收集或传输浏览数据。更多说明见 [隐私政策](PRIVACY_POLICY.md)。
### 下载能快多少？ ### 下载能快多少？
速度提升因你的位置、网络和文件大小而异。典型的改进范围从 2 倍到 10 倍。 速度提升取决于你的地理位置、网络状况和文件大小。典型改进范围约为 2 倍到 10 倍。
### 我可以为特定网站禁用扩展吗？ ### 我可以为特定网站禁用扩展吗？
是的，使用扩展弹出窗口中的按平台切换开关来禁用特定平台的加速。 可以。使用扩展弹出窗口中的按平台开关，即可为特定平台禁用加速。
### 为什么 Chrome 和 Firefox 版本不同？ ### 为什么 Chrome 和 Firefox 版本不同？
由于浏览器架构差异，我们针对不同浏览器进行了优化： 由于浏览器架构差异，我们分别做了适配：
- **Chrome 版本**：使用 Manifest V3，支持最新的扩展 API 和安全特性 - Chrome 版本：使用 Manifest V3，支持较新的扩展 API 和安全特性。
- **Firefox 版本**：使用 Manifest V2，确保与 Firefox 扩展系统的最佳兼容性 - Firefox 版本：使用 Manifest V2，以确保与 Firefox 扩展系统的兼容性。
两个版本的核心功能完全相同，只是技术实现略有不同。 两者的核心功能保持一致，差异主要在底层实现。
### 可以同时在 Chrome 和 Firefox 中使用吗？ ### 可以同时在 Chrome 和 Firefox 中使用吗？
当然可以！你可以在多个浏览器中同时安装和使用 Xget Now，它们会独立工作，各自维护自己的设置。 可以。你可以在多个浏览器中同时安装和使用 Xget Now，它们会独立工作，并分别保存各自的设置。
## 🌟 支持我们 ## 支持与反馈
如果你觉得这个扩展有用，请： 如果你觉得这个扩展有用，可以：
- ⭐ 为此存储库点星 - 为仓库点个 Star。
- 📝 留下评价： - 在应用商店留下评价：
- [Chrome 应用商店](https://chromewebstore.google.com/detail/ajiejgobfcifcikbahpijopolfjoodgf?hl=zh-CN) - [Chrome 应用商店](https://chromewebstore.google.com/detail/ajiejgobfcifcikbahpijopolfjoodgf?hl=zh-CN)
- [Firefox 附加组件](https://addons.mozilla.org/zh-CN/firefox/addon/xget-now/) - [Firefox 附加组件](https://addons.mozilla.org/zh-CN/firefox/addon/xget-now/)
- [Edge 加载项](https://microsoftedge.microsoft.com/addons/detail/jigpfhbegabdenhihpplcjhpfdcgnalc?hl=zh-CN&gl=CN) - [Edge 加载项](https://microsoftedge.microsoft.com/addons/detail/jigpfhbegabdenhihpplcjhpfdcgnalc?hl=zh-CN&gl=CN)
- 🐛 通过 [GitHub Issues](https://github.com/xixu-me/Xget-Now/issues) 报告错误或建议功能 - 通过 [GitHub Issues](https://github.com/xixu-me/Xget-Now/issues) 报告错误或建议功能。
- 📢 与其他可能受益于更快下载的人分享 - 分享给其他可能受益于更快下载的人。
> [!NOTE]
> 本仓库采用 GPL-3.0 许可证。完整条款见 [LICENSE](LICENSE)。