From 8190d46c6692d33693cad02d15915880567b35c7 Mon Sep 17 00:00:00 2001 From: Maplespe <43676879+Maplespe@users.noreply.github.com> Date: Mon, 15 Jan 2024 02:45:10 +0800 Subject: [PATCH] update readme --- README.md | 65 +++++++++++++++++++++++++++++++++++++++---- README_ZH.md | 78 +++++++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 124 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f5ccd74..9be4266 100644 --- a/README.md +++ b/README.md @@ -15,32 +15,85 @@ This project uses [LGNU V3 license](/COPYING.LESSER). ## Effects * Adds a blur effect to the global system title bar. * Customizable blur radius. -* Customizable mixed background colors. +* Customizable blend background colors. * Customizable title bar text color. +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/001911.png) + ## Compatibility +Supported as low as **Windows 1709** and as high as the **latest version of Windows 11** (if not otherwise specified). + +Can be used with third party themes to further customize DWM. + +We do not modify the rendering logic of the application itself, which is completely different from the logic of MicaForEveryone and therefore maximizes compatibility with third-party programs. + +Compatible with [ExplorerBlurMica](https://github.com/Maplespe/ExplorerBlurMica), works better together. + +Compatible with [TranslucentFlyouts](https://github.com/ALTaleX531/TranslucentFlyouts). (**It should be noted that even though this project is compatible with TF, EBMv2 is not fully compatible with TFv2**) ## Catalog -- [Overview](#overview) +- [Gallery](#gallery) - [How to use](#how-to-use) -- [Dependencies](#Dependencies) +- [Language files](#language-files) +- [Dependencies](#dependencies) -## Overview +## Gallery
Windows 11 + +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/10307.png) + +> Enable "Override DWMAPI mica effect (win11)" +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/013521.png)
Windows 10 +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/001911.png) +
## How to use ### Install -1. Download the compiled program archive from the [Release](https://github.com/Maplespe/ExplorerBlurMica/releases) page. +1. Download the compiled program archive from the [Release](https://github.com/Maplespe/DWMBlurGlass/releases) page. 2. Unzip it to a location such as "`C:\Program Files`". +
3. Run the DWMBlurGlass.exe GUI program and click Install. + +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/012746.png) + +>If the prompt "Installation was successful! But you have not yet downloaded a valid symbol file, please download it from the "Symbols" page before you can use it!" then you need to click on the Symbols page and click Download before you can use it. + +>**Note that you may receive similar notifications in the future, especially after system updates.** + +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/012924.png) + +
### Uninstall +1. Run the DWMBlurGlass.exe GUI program and click Uninstall. +2. Delete relevant files + +## Language files +We offer basic languages English and Simplified Chinese. +If you would like to help us translate into other languages, please see below for language file formats. + +1. First, you need to fork this repository and clone it locally. +2. Open the "`Languagefiles`" folder and select an existing language such as "`en-US.xml`" and make a copy. +3. Rename the code to the name of the [target language](https://learn.microsoft.com/en-us/windows/win32/intl/locale-names) and open the xml file in your favorite text editor. +4. In the second line, in the "`local`" field, change it to your target language code, which should be the same as the filename (without the .xml extension). +5. You can put your name in the "`author`" field. +6. Next, please translate the field values in the xml format (be careful not to translate the field names) The correct format is:`Config` to `xxxx`. +7. Save your file when finished and copy it to the "data\lang" directory in the folder where the DWMBlurGlass.exe program is located. +8. Next, open DWMBlurGlass.exe and test the language file to see if it works correctly. If it doesn't, check the language code settings and check that the file conforms to the xml format specification. +9. Finally, commit the file to your own forked repository and send pull requests to the main branch of the project. +10. After the request is approved, your file will be released with a future software update. + ## Dependencies -[minhook](https://github.com/m417z/minhook). +* MiaoUI interface library v2 (Private) +* [minhook](https://github.com/m417z/minhook). +* [VC_LTL](https://github.com/Chuyu-Team/VC-LTL5) +* [Windows Implementation Libraries](https://github.com/Microsoft/wil) + +Since the GUI program uses private libraries, only insiders can compile the GUI, which does not affect the compilation of the libraries. diff --git a/README_ZH.md b/README_ZH.md index 35386bc..a33f424 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -18,29 +18,81 @@ This project uses [LGNU V3 license](/COPYING.LESSER). * 可自定义混合背景颜色 * 可自定义标题栏文本颜色 -## Compatibility +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/001701.png) -## Catalog -- [Overview](#overview) -- [How to use](#how-to-use) -- [Dependencies](#Dependencies) +## 兼容性 +最低支持 **Windows 10 1709** 最高支持到 **Windows 11 最新版**(如果未另行说明) -## Overview +可以与第三方主题一起使用进一步定制DWM. + +我们不会修改应用程序本身的渲染逻辑，与MicaForEveryone原理完全不同，因此也最大程度与第三方程序兼容. + +与[ExplorerBlurMica](https://github.com/Maplespe/ExplorerBlurMica)兼容，一起使用效果更佳. + +与[TranslucentFlyouts](https://github.com/ALTaleX531/TranslucentFlyouts)兼容. (**需要注意的是即使本项目与TF兼容，但EBMv2与TFv2并不完全兼容**) + +## 目录 +- [预览](#预览) +- [如何使用](#如何使用) +- [语言文件](#语言文件) +- [依赖](#依赖) + +## 预览
Windows 11 + +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/78930.png) + +> 启用 "覆盖使用DWMAPI设置的云母效果(win11)" +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/013521.png)
Windows 10 +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/001701.png) + +
+ +## 如何使用 + +### 安装 +1. 从 [Release](https://github.com/Maplespe/DWMBlurGlass/releases) 页面下载压缩包. +2. 解压到一个位置 例如 "`C:\Program Files`". +
3. 运行 DWMBlurGlass.exe GUI 程序 并点击安装. + +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/013025.png) + +>如果提示 "安装成功! 但您还没有下载有效的符号文件，在"符号文件"页面下载后才能生效" 则需要前往"符号"页面下载符号 + +>**请注意，之后可能还会收到类似提示，特别是系统更新后 届时下载新的符号即可** +> +>如果下载失败 则可能需要使用代理，在中国大陆部分地区可能无法访问微软服务器 + +![image](https://github.com/Maplespe/DWMBlurGlass/blob/master/Screenshot/013100.png) +
-## How to use +### 卸载 +1. 运行 DWMBlurGlass.exe GUI 程序 并点击卸载. +2. 手动删除相关剩余文件. -### Install -1. Download the compiled program archive from the [Release](https://github.com/Maplespe/ExplorerBlurMica/releases) page. -2. Unzip it to a location such as "`C:\Program Files`". +## 语言文件 +我们提供基本的语言 英语和简体中文 如果您愿意帮助我们翻译其他语言，请参阅以下内容，了解语言文件格式. +1. 首先需要fork并克隆此储存库到本地. +2. 打开"`Languagefiles`"文件夹 并选择一个现有的语言文件 例如"`zh-CN.xml`" 并复制它. +3. 重命名此文件为[目标区域代码名称](https://learn.microsoft.com/en-us/windows/win32/intl/locale-names)并使用您喜欢的文本编辑器编辑此xml文档. +4. 修改第二行的"`local`"字段的值为目标区域代码名称(它应该和文件名一样 但不包括xml后缀). +5. 可以在"`author`"字段中填写您的名称. +6. 接下来翻译剩下的字段值(注意不要翻译字段名称) 正确的格式为: `Config` 翻译为 `xxxx`. +7. 完成后保存文件，并将其复制到 DWMBlurGlass.exe 程序所在文件夹下的 "`data\lang`" 目录中. +8. 接下来，打开 DWMBlurGlass.exe，测试语言文件是否正常工作，如果不正常，请检查语言代码设置，并检查文件是否符合 xml 格式规范. +9. 最后，将文件提交到自己fork的仓库，并向项目的主分支发送拉取请求. +10. 请求通过后，您的文件将随未来的软件更新一起发布. -### Uninstall +## 依赖 +* MiaoUI interface library v2 (Private) +* [minhook](https://github.com/m417z/minhook). +* [VC_LTL](https://github.com/Chuyu-Team/VC-LTL5) +* [Windows Implementation Libraries](https://github.com/Microsoft/wil) -## Dependencies -[minhook](https://github.com/m417z/minhook). +由于GUI程序使用了私有的库，因此只有内部人员才可以编译GUI，这并不影响库的编译.