mirror of
https://github.com/Blinue/Magpie.git
synced 2026-06-24 02:04:10 +00:00
docs: 更新文档
This commit is contained in:
Xu
parent
debf547ab8
commit
f2888d5c81
11 changed files with 45 additions and 90 deletions
|
|
@ -12,11 +12,7 @@
|
|||
"avatar_url": "https://avatars.githubusercontent.com/u/34770031?v=4",
|
||||
"profile": "https://github.com/Blinue",
|
||||
"contributions": [
|
||||
"maintenance",
|
||||
"code",
|
||||
"review",
|
||||
"doc",
|
||||
"question"
|
||||
"maintenance"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
|
|||
53
README.md
53
README.md
|
|
@ -9,17 +9,13 @@
|
|||
[](./LICENSE)
|
||||
[](https://github.com/Blinue/Magpie/actions/workflows/build.yml)
|
||||
[](#acknowledgement-)
|
||||
[](https://github.com/Blinue/Magpie/releases)
|
||||
[](https://hosted.weblate.org/engage/magpie)
|
||||
|
||||
</div>
|
||||
|
||||
🌍 **English** | [简体中文](./README_ZH.md)
|
||||
|
||||
Magpie is a lightweight window scaling tool that comes equipped with various efficient scaling algorithms and filters. Its primary purpose is to enhance game graphics and enable non-fullscreen games to display in fullscreen mode.
|
||||
|
||||
We are using [Weblate](https://weblate.org/) for localization work and would appreciate your help in translating Magpie into more languages.
|
||||
|
||||
[](https://hosted.weblate.org/engage/magpie/)
|
||||
Magpie is a lightweight tool designed to upscale game windows while enhancing visual quality.
|
||||
|
||||
👉 [Download](https://github.com/Blinue/Magpie/releases)
|
||||
|
||||
|
|
@ -29,50 +25,35 @@ We are using [Weblate](https://weblate.org/) for localization work and would app
|
|||
|
||||
👉 [Compilation guide](https://github.com/Blinue/Magpie/wiki/Compilation%20guide)
|
||||
|
||||
👉 [Contributing](./CONTRIBUTING.md)
|
||||
|
||||
## Features
|
||||
|
||||
* Scale any window to fullscreen
|
||||
* Numerous built-in algorithms, including Lanczos, [Anime4K](https://github.com/bloc97/Anime4K), [FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR), Adaptive Sharpen, various CRT shaders, and more
|
||||
* Supports both fullscreen and windowed scaling
|
||||
* Includes a variety of built-in algorithms and filters, including [Anime4K](https://github.com/bloc97/Anime4K), [FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR), CRT shaders, and more
|
||||
* WinUI-based user interface with support for light and dark themes
|
||||
* Create configuration profiles for specific windows
|
||||
* Multi-monitor support
|
||||
|
||||
## How to use
|
||||
|
||||
1. Configuring scaling modes
|
||||
|
||||
Magpie provides some simple scaling modes by default, but it is recommended to configure them according to your specific use case. Then, change the global scaling mode on the "Profiles"-"Defaults" page.
|
||||
|
||||
2. Scaling a window
|
||||
|
||||
To scale a window, bring the desired window to the foreground and press the shortcut key (default is Win+Shift+A) to display it in fullscreen mode. Note that the window to be scaled must be in windowed mode, not maximized or fullscreen mode. You can also use the "Scale after xs" button on the "Home" page, and Magpie will automatically scale the foreground window after a few seconds.
|
||||
|
||||
3. Creating profiles for windows
|
||||
|
||||
This allows you to save configurations specific to a particular window. Magpie also supports automatically activate scaling when that window is brought to the foreground.
|
||||
|
||||
4. Customizing effects
|
||||
|
||||
Magpie uses Direct3D compute shader to implement effects, but the syntax has been extended to define resources and organize multiple passes. For more information, please refer to [MagpieFX](https://github.com/Blinue/Magpie/wiki/MagpieFX%20(EN)). Those with experience in shader writing can easily create custom effects.
|
||||
|
||||
## Screenshots
|
||||
|
||||
<img src="img/Main window.png" alt= "Main window" height="300">
|
||||
|
||||
## System requirements
|
||||
|
||||
1. Windows 10 v1903+ or Windows 11
|
||||
2. DirectX feature level 11
|
||||
|
||||
## Hints
|
||||
|
||||
1. If you have set DPI scaling and the window you want to scale does not support high DPI (which is common in older games), it is recommended to first enter the program's compatibility settings and set "High DPI scaling override" to "Application".
|
||||
|
||||
2. Some games support zooming the window, but with extremely naive algorithms. Please set the resolution to the built-in (best) option.
|
||||
|
||||
## Acknowledgement ✨
|
||||
## System requirements
|
||||
|
||||
1. Windows 10 v1903+ or Windows 11
|
||||
2. DirectX feature level 11
|
||||
|
||||
## Localization
|
||||
|
||||
Thanks to [Weblate](https://weblate.org) for hosting! Click the image below to visit the translation page.
|
||||
|
||||
[](https://hosted.weblate.org/engage/magpie)
|
||||
|
||||
## Acknowledgement
|
||||
|
||||
Thanks go to these wonderful people:
|
||||
|
||||
|
|
@ -82,7 +63,7 @@ Thanks go to these wonderful people:
|
|||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Blinue"><img src="https://avatars.githubusercontent.com/u/34770031?v=4?s=100" width="100px;" alt="Xu"/><br /><sub><b>Xu</b></sub></a><br /><a href="#maintenance-Blinue" title="Maintenance">🚧</a> <a href="https://github.com/Blinue/Magpie/commits?author=Blinue" title="Code">💻</a> <a href="https://github.com/Blinue/Magpie/pulls?q=is%3Apr+reviewed-by%3ABlinue" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/Blinue/Magpie/commits?author=Blinue" title="Documentation">📖</a> <a href="#question-Blinue" title="Answering Questions">💬</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Blinue"><img src="https://avatars.githubusercontent.com/u/34770031?v=4?s=100" width="100px;" alt="Xu"/><br /><sub><b>Xu</b></sub></a><br /><a href="#maintenance-Blinue" title="Maintenance">🚧</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/hooke007"><img src="https://avatars.githubusercontent.com/u/41094733?v=4?s=100" width="100px;" alt="hooke007"/><br /><sub><b>hooke007</b></sub></a><br /><a href="https://github.com/Blinue/Magpie/commits?author=hooke007" title="Documentation">📖</a> <a href="#question-hooke007" title="Answering Questions">💬</a> <a href="#userTesting-hooke007" title="User Testing">📓</a> <a href="https://github.com/Blinue/Magpie/commits?author=hooke007" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="http://palxex.ys168.com"><img src="https://avatars.githubusercontent.com/u/58222?v=4?s=100" width="100px;" alt="Pal Lockheart"/><br /><sub><b>Pal Lockheart</b></sub></a><br /><a href="#userTesting-palxex" title="User Testing">📓</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://www.stevedonaghy.com/"><img src="https://avatars.githubusercontent.com/u/1029699?v=4?s=100" width="100px;" alt="Steve Donaghy"/><br /><sub><b>Steve Donaghy</b></sub></a><br /><a href="https://github.com/Blinue/Magpie/commits?author=neoKushan" title="Code">💻</a> <a href="#translation-neoKushan" title="Translation">🌍</a></td>
|
||||
|
|
|
|||
59
README_ZH.md
59
README_ZH.md
|
|
@ -9,17 +9,13 @@
|
|||
[](./LICENSE)
|
||||
[](https://github.com/Blinue/Magpie/actions/workflows/build.yml)
|
||||
[](#%E8%B4%A1%E7%8C%AE%E8%80%85-)
|
||||
[](https://github.com/Blinue/Magpie/releases)
|
||||
[](https://hosted.weblate.org/engage/magpie)
|
||||
|
||||
</div>
|
||||
|
||||
🌍 [English](./README.md) | **简体中文**
|
||||
|
||||
Magpie 是一个轻量级的窗口缩放工具，内置了多种高效的缩放算法和滤镜。它主要用于提升游戏画质和让不支持全屏化的游戏也能全屏显示等。
|
||||
|
||||
我们使用 [Weblate](https://weblate.org) 进行本地化工作，请帮助我们把 Magpie 翻译成更多语言。
|
||||
|
||||
[](https://hosted.weblate.org/engage/magpie/)
|
||||
Magpie 是一个轻量级的窗口超分辨率工具，可以在放大游戏窗口的同时提升其视觉质量。
|
||||
|
||||
👉 [下载](https://github.com/Blinue/Magpie/releases)
|
||||
|
||||
|
|
@ -29,51 +25,36 @@ Magpie 是一个轻量级的窗口缩放工具，内置了多种高效的缩放
|
|||
|
||||
👉 [编译指南](https://github.com/Blinue/Magpie/wiki/编译指南)
|
||||
|
||||
👉 [贡献指南](./CONTRIBUTING_ZH.md)
|
||||
|
||||
## 功能
|
||||
|
||||
* 将任何窗口放大至全屏
|
||||
* 众多内置算法，包括 Lanczos、[Anime4K](https://github.com/bloc97/Anime4K)、[FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR)、Adaptive Sharpen、多种 CRT 着色器等
|
||||
* 支持全屏和窗口模式缩放
|
||||
* 众多内置算法和滤镜，如 [Anime4K](https://github.com/bloc97/Anime4K)、[FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR)、CRT 着色器等
|
||||
* 基于 WinUI 的用户界面，支持浅色和深色主题
|
||||
* 为特定窗口创建配置文件
|
||||
* 多屏幕支持
|
||||
|
||||
## 如何使用
|
||||
|
||||
1. 配置缩放模式
|
||||
|
||||
Magpie 预设了一些简单的缩放模式，但建议根据使用场景自行配置。然后在“配置文件”-“默认”页面更改全局缩放模式。
|
||||
|
||||
2. 缩放窗口
|
||||
|
||||
把要缩放的窗口置于前台，按下快捷键（默认为 Win+Shift+A）即可全屏显示。请注意，要缩放的窗口必须处于窗口化状态，而不是最大化或全屏化。也可以使用“主页”上的“x 秒后缩放”按钮，Magpie 将在数秒后自动缩放前台窗口。
|
||||
|
||||
3. 为窗口创建配置文件
|
||||
|
||||
这使你可以保存针对某个窗口的配置，也支持在该窗口位于前台时自动执行缩放。
|
||||
|
||||
4. 自定义效果
|
||||
|
||||
Magpie 使用 Direct3D 计算着色器实现效果，但扩展了语法来定义资源、组织多个通道等，详见 [MagpieFX](https://github.com/Blinue/Magpie/wiki/MagpieFX) 。有着色器编写经验者可以轻松创建自定义效果。
|
||||
* 支持多屏幕
|
||||
|
||||
## 截图
|
||||
|
||||
<img src="img/主窗口.png" alt= "主窗口" height="300">
|
||||
|
||||
## 系统需求
|
||||
|
||||
1. Windows 10 v1903+ 或 Windows 11
|
||||
2. DirectX 功能级别 11
|
||||
|
||||
## 使用提示
|
||||
|
||||
1. 如果你设置了 DPI 缩放，而要放大的窗口没有高 DPI 支持（这在老游戏中很常见），推荐首先进入该程序的兼容性设置，将“高 DPI 缩放替代”设置为“应用程序”。
|
||||
2. 一些游戏支持调整窗口的大小，但只使用简单的缩放算法，这时请先将其设为原始（最佳）分辨率。
|
||||
|
||||
## 贡献者 ✨
|
||||
## 系统需求
|
||||
|
||||
感谢每一位参与贡献的人：
|
||||
1. Windows 10 v1903+ 或 Windows 11
|
||||
2. DirectX 功能级别 11
|
||||
|
||||
## 本地化
|
||||
|
||||
感谢 [Weblate](https://weblate.org) 提供托管服务，点击下面的图片可以进入翻译页面。
|
||||
|
||||
[](https://hosted.weblate.org/engage/magpie)
|
||||
|
||||
## 贡献者
|
||||
|
||||
衷心感谢所有为本项目做出贡献的人：
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
|
|
@ -81,7 +62,7 @@ Magpie 是一个轻量级的窗口缩放工具，内置了多种高效的缩放
|
|||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Blinue"><img src="https://avatars.githubusercontent.com/u/34770031?v=4?s=100" width="100px;" alt="Xu"/><br /><sub><b>Xu</b></sub></a><br /><a href="#maintenance-Blinue" title="Maintenance">🚧</a> <a href="https://github.com/Blinue/Magpie/commits?author=Blinue" title="Code">💻</a> <a href="https://github.com/Blinue/Magpie/pulls?q=is%3Apr+reviewed-by%3ABlinue" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/Blinue/Magpie/commits?author=Blinue" title="Documentation">📖</a> <a href="#question-Blinue" title="Answering Questions">💬</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Blinue"><img src="https://avatars.githubusercontent.com/u/34770031?v=4?s=100" width="100px;" alt="Xu"/><br /><sub><b>Xu</b></sub></a><br /><a href="#maintenance-Blinue" title="Maintenance">🚧</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/hooke007"><img src="https://avatars.githubusercontent.com/u/41094733?v=4?s=100" width="100px;" alt="hooke007"/><br /><sub><b>hooke007</b></sub></a><br /><a href="https://github.com/Blinue/Magpie/commits?author=hooke007" title="Documentation">📖</a> <a href="#question-hooke007" title="Answering Questions">💬</a> <a href="#userTesting-hooke007" title="User Testing">📓</a> <a href="https://github.com/Blinue/Magpie/commits?author=hooke007" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="http://palxex.ys168.com"><img src="https://avatars.githubusercontent.com/u/58222?v=4?s=100" width="100px;" alt="Pal Lockheart"/><br /><sub><b>Pal Lockheart</b></sub></a><br /><a href="#userTesting-palxex" title="User Testing">📓</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://www.stevedonaghy.com/"><img src="https://avatars.githubusercontent.com/u/1029699?v=4?s=100" width="100px;" alt="Steve Donaghy"/><br /><sub><b>Steve Donaghy</b></sub></a><br /><a href="https://github.com/Blinue/Magpie/commits?author=neoKushan" title="Code">💻</a> <a href="#translation-neoKushan" title="Translation">🌍</a></td>
|
||||
|
|
@ -131,4 +112,4 @@ Magpie 是一个轻量级的窗口缩放工具，内置了多种高效的缩放
|
|||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
本项目遵循 [all-contributors](https://allcontributors.org/) 规范。欢迎任何形式的贡献！
|
||||
本项目遵循 [all-contributors](https://allcontributors.org/) 规范，欢迎任何形式的贡献！
|
||||
|
|
|
|||
|
|
@ -126,6 +126,9 @@ Magpie ships with a handful of effects that can be used in combinations. Most of
|
|||
* CuNNy family：Suitable for visual novel-style images. The DS variants offer a subtle denoise effect. Provided by [CuNNy](https://github.com/funnyplanter/CuNNy)
|
||||
* Output size: twice that of the input
|
||||
|
||||
* CuNNy2 family: An enhanced version of CuNNy
|
||||
* Output size: twice that of the input
|
||||
|
||||
* Deband
|
||||
* Output size: the same as the input
|
||||
* Parameters
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ Magpie provides several capture methods. They have their pros and cons in differ
|
|||
| Supports recording/streaming | No under extreme conditions<sup>[1]</sup> | No | Yes | Yes |
|
||||
| Support the source window to span multiple screens | No under extreme conditions<sup>[1]</sup> | No | Yes | Yes |
|
||||
| Ignores DPI virtualization<sup>[2]</sup> | No | No | Yes| Yes |
|
||||
| Notes | The most recommended capture method | Requires Win10 v2004 | | Low VRAM usage |
|
||||
| Notes | The most recommended capture method | Requires Win10 v2004 | | Not recommended due to unstable performance |
|
||||
|
||||
|
||||
[1]: (1) The source window does not support regular window capture. (2) The operating system is Windows 11.
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ To enable touch input support, TouchHelper.exe needs to be signed. While signing
|
|||
3. Run the following command in the root directory of the repository:
|
||||
|
||||
```bash
|
||||
python publish.py x64 unpackaged <pfx path> <pfx password>
|
||||
python scripts/publish.py --pfx-path=<pfx path> --pfx-password=<pfx password>
|
||||
```
|
||||
|
||||
This will compile Magpie and sign TouchHelper.exe. The compiled files will be located in `publish\x64`.
|
||||
|
|
|
|||
|
|
@ -2,15 +2,11 @@
|
|||
|
||||
When displaying performance monitor like RTSS (Rivatuner Statistics Server), there might be 2 OSD layers displayed with Magpie scaling. This is caused by d3d, the screen capture method since v0.7.0. It will be captured by RTSS as well. You can fix this issue by adding it to the blacklist.
|
||||
|
||||
## The hot keys don't work, but "Scale after x s" works.
|
||||
## The hot keys don't work, but "Scale after `x`s" works.
|
||||
|
||||
1. Try changing the hot keys.
|
||||
2. Try running Magpie as Administrator.
|
||||
|
||||
## Does Magpie support multiple monitors?
|
||||
|
||||
Supported from v0.8.
|
||||
|
||||
## Lagging/latency
|
||||
|
||||
Please check the [Performance optimization](https://github.com/Blinue/Magpie/wiki/Performance%20optimization) page.
|
||||
|
|
|
|||
|
|
@ -2,15 +2,11 @@
|
|||
|
||||
使用性能计数器屏显时，例如 RTSS (Rivatuner Statistics Server)，你可能会在缩放时看到两个叠加层。这是由于 Magpie 使用 Direct3D 呈现画面，它也会被 RTSS 捕捉。如果你不关心 Magpie 的性能，请将 Magpie 添加到黑名单。
|
||||
|
||||
### 快捷键不起作用，但可以使用 "x秒后缩放"
|
||||
### 快捷键不起作用，但可以使用 "`x` 秒后缩放"
|
||||
|
||||
1. 尝试更换快捷键
|
||||
2. 尝试以管理员身份运行 Magpie
|
||||
|
||||
### 是否支持多屏？
|
||||
|
||||
从 v0.8 开始支持。
|
||||
|
||||
### 卡顿/延迟
|
||||
|
||||
请查看[性能优化建议](https://github.com/Blinue/Magpie/wiki/性能优化建议)。
|
||||
|
|
|
|||
|
|
@ -126,6 +126,9 @@ Magpie 内置了大量效果供组合使用，大部分提供了参数选项以
|
|||
* CuNNy 族：适合视觉小说风格图像的缩放，由 [CuNNy](https://github.com/funnyplanter/CuNNy) 提供。DS 变体有轻微降噪效果
|
||||
* 输出尺寸：输入的两倍
|
||||
|
||||
* CuNNy2 族：CuNNy 的改进版
|
||||
* 输出尺寸：输入的两倍
|
||||
|
||||
* Deband：去除色带
|
||||
* 输出尺寸：和输入相同
|
||||
* 参数
|
||||
|
|
|
|||
|
|
@ -6,8 +6,7 @@ Magpie 提供数种捕获方式，根据使用场景，它们各有优劣。无
|
|||
| 支持录制/串流 | 特殊情况下不支持<sup>[1]</sup> | 否 | 是 | 是 |
|
||||
| 支持源窗口跨越多个屏幕 | 特殊情况下不支持<sup>[1]</sup> | 否 | 是 | 是 |
|
||||
| 无视 DPI 虚拟化<sup>[2]</sup> | 否 | 否 | 是| 是 |
|
||||
| 备注 | 首选捕获方式 | 要求 Win10 v2004 | | 占用的显存较少 |
|
||||
|
||||
| 备注 | 首选捕获方式 | 要求 Win10 v2004 | | 性能不稳定，不建议使用 |
|
||||
|
||||
[1]: (1) 源窗口不支持常规的窗口捕获 (2) 操作系统为 Windows 11
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@
|
|||
3. 在存储库根目录下执行以下命令：
|
||||
|
||||
```bash
|
||||
python publish.py x64 unpackaged <pfx 路径> <pfx 密码>
|
||||
python scripts/publish.py --pfx-path=<pfx 路径> --pfx-password=<pfx 密码>
|
||||
```
|
||||
|
||||
这将编译 Magpie 并为 TouchHelper.exe 签名。编译出的程序位于 `publish\x64`。
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue