Skip to content

Commit

Permalink
Merge pull request #99 from taj-ny/rename
Browse files Browse the repository at this point in the history
rename project to KWin Better Blur (kwin-better-blur)
  • Loading branch information
taj-ny authored Aug 13, 2024
2 parents 521f7b5 + c614957 commit 4500adb
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.16.0)

project(forceblur)
project(kwin_better_blur)
set(PROJECT_VERSION "1.3.1")
set(PROJECT_VERSION_MAJOR 0)

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# kwin-effects-forceblur [![AUR Version](https://img.shields.io/aur/version/kwin-effects-forceblur)](https://aur.archlinux.org/packages/kwin-effects-forceblur)
Kwin-effects-forceblur (name subject to change) is a fork of the KWin Blur effect for KDE Plasma 6 with several improvements and bug fixes.
# KWin Better Blur [![AUR Version](https://img.shields.io/aur/version/kwin-effects-forceblur)](https://aur.archlinux.org/packages/kwin-effects-forceblur)
Better Blur (formerly kwin-effects-forceblur) is a fork the KWin Blur effect for KDE Plasma 6 with additional features and bug fixes.

Latest features are available on the ``develop`` branch.

Expand All @@ -22,24 +22,24 @@ Fixes for blur-related Plasma bugs that haven't been patched yet.
<details>
<summary>NixOS (flakes)</summary>
<br>

``flake.nix``:
```nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
kwin-effects-forceblur = {
url = "github:taj-ny/kwin-effects-forceblur";
inputs.nixpkgs.follows = "nixpkgs";
};
};
}
```

```nix
{ inputs, pkgs, ... }:
{
environment.systemPackages = [
inputs.kwin-effects-forceblur.packages.${pkgs.system}.default
Expand Down Expand Up @@ -107,18 +107,18 @@ sudo make install
Remove the *build* directory when rebuilding the effect.

# Usage
> [!NOTE]
> [!NOTE]
> If the effect stops working after a system upgrade, you will need to rebuild it.
Since kwin-effects-forceblur is a fork, you need to disable the stock blur effect and any other blur effects you may be using.
This effect will conflict with the stock blur effect and any other forks of it.

1. Install the plugin.
2. Open the *Desktop Effects* page in *System Settings*.
3. Disable any blur effects.
4. Enable the *Force Blur* effect.
4. Enable the *Better Blur* effect.

For more detailed descriptions of some options, check out [this wiki page](https://github.com/taj-ny/kwin-effects-forceblur/wiki/Configuration).

### Window transparency
The window needs to be translucent in order for the blur to be visible. This can be done in multiple ways:
- Use a transparent theme for the program if it supports it
Expand Down
6 changes: 3 additions & 3 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
description = "A fork of the KWin Blur effect for KDE Plasma 6 with the ability to blur any window on Wayland and X11";
description = "Fork of the KWin Blur effect for KDE Plasma 6 with additional features (including force blur) and bug fixes";

inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
Expand Down
4 changes: 2 additions & 2 deletions package.nix
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
}:

stdenv.mkDerivation rec {
pname = "kwin-effects-forceblur";
pname = "kwin-better-blur";
version = "1.3.1";

src = ./.;
Expand All @@ -25,7 +25,7 @@ stdenv.mkDerivation rec {
];

meta = with lib; {
description = "A fork of the KWin Blur effect for KDE Plasma 6 with the ability to blur any window on Wayland and X11";
description = "Fork of the KWin Blur effect for KDE Plasma 6 with additional features (including force blur) and bug fixes";
license = licenses.gpl3;
homepage = "https://github.com/taj-ny/kwin-effects-forceblur";
};
Expand Down
2 changes: 1 addition & 1 deletion src/blur.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

#include <KDecoration2/Decoration>

Q_LOGGING_CATEGORY(KWIN_BLUR, "kwin_effect_forceblur", QtWarningMsg)
Q_LOGGING_CATEGORY(KWIN_BLUR, "kwin_better_blur", QtWarningMsg)

static void ensureResources()
{
Expand Down
14 changes: 7 additions & 7 deletions src/kcm/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
set(kwin_forceblur_config_SRCS blur_config.cpp blur_config.h)
set(kwin_better_blur_config_SRCS blur_config.cpp blur_config.h)

ki18n_wrap_ui(kwin_forceblur_config_SRCS blur_config.ui)
kconfig_add_kcfg_files(kwin_forceblur_config_SRCS ../blurconfig.kcfgc)
ki18n_wrap_ui(kwin_better_blur_config_SRCS blur_config.ui)
kconfig_add_kcfg_files(kwin_better_blur_config_SRCS ../blurconfig.kcfgc)

qt_add_dbus_interface(kwin_forceblur_config_SRCS ${KWIN_EFFECTS_INTERFACE} kwineffects_interface)
qt_add_dbus_interface(kwin_better_blur_config_SRCS ${KWIN_EFFECTS_INTERFACE} kwineffects_interface)

add_library(kwin_forceblur_config MODULE ${kwin_forceblur_config_SRCS})
target_link_libraries(kwin_forceblur_config
add_library(kwin_better_blur_config MODULE ${kwin_better_blur_config_SRCS})
target_link_libraries(kwin_better_blur_config
KF6::KCMUtils
KF6::CoreAddons
KF6::I18n
Qt6::DBus
)

install(TARGETS kwin_forceblur_config DESTINATION ${KDE_INSTALL_PLUGINDIR}/kwin/effects/configs)
install(TARGETS kwin_better_blur_config DESTINATION ${KDE_INSTALL_PLUGINDIR}/kwin/effects/configs)
6 changes: 3 additions & 3 deletions src/metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
}
],
"Category": "Appearance",
"Description": "Blurs the background behind user-specified windows",
"Description": "Fork of the KWin Blur effect for KDE Plasma 6 with force blur and more",
"EnabledByDefault": false,
"License": "GPL",
"Name": "Force Blur"
"Name": "Better Blur (formerly Force Blur)"
},
"X-KDE-ConfigModule": "kwin_forceblur_config"
"X-KDE-ConfigModule": "kwin_better_blur_config"
}

0 comments on commit 4500adb

Please sign in to comment.