# Fcitx5 Breeze

**Repository Path**: scratch-er/fcitx5-breeze

## Basic Information

- **Project Name**: Fcitx5 Breeze
- **Description**: 适配KDE Breeze主题的Fcitx5皮肤。
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-01-20
- **Last Updated**: 2024-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Fcitx5-breeze

适配KDE Breeze主题的Fcitx5主题。

Fcitx5 theme to match KDE's Breeze style.

对于ArchLinux用户，可以从官方仓库直接安装该主题。

For Arch Linux users, this theme is available in the official repository as `fcitx5-breeze`.

## 构建项目 Build

先安装inkscape,然后运行`build.py`以构建项目。

Run `bulid.py` to build this theme. You need to have inkscape installed.

这个主题使用svg矢量图制作，然而，fcitx5主题使用png格式。构建脚本首先从.svg.in文件生成.svg文件、从.conf.in文件生成各个主题的配置文件，然后使用inkscape将svg格式转换为png格式。

This themes uses svg as the source format. However, in fcitx5 themes, png images are used. The build scripts generates .svg files from .svg.in files, generates theme config files from .conf.in files and convert .svg files to png with inkscape.

## 安装主题 Installation

在构建主题之后，运行`install.sh`以安装主题。您也可以从发行版页面下载一个已经构建好的版本。默认情况下，主题会安装到`/usr/local`。

To install this theme, you need to build it first or get a pre-built package from the releases page. Then run `install.sh`. By default, this will install the theme into `/usr/local`.

```shell
sudo ./install.sh
```
您可以指定其他的安装路径，例如，使用以下命令可以将主题安装到`/usr`。

To specify another installation prefix, for example, if you want install this theme into `/usr`.

```shell
sudo ./install.sh /usr
```
同理，如果想要仅仅为当前用户安装主题（这样就不需要root权限），可以使用以下命令：

If you want to install this theme only for yourself without root privilege, you need to set installation prefix to `~/.local`.

```shell
./install.sh ~/.local
```
要删除该主题，请运行命令`./uninstall.sh <安装路径>`，例如：

To uninstall this theme, run `./uninstall.sh <installation-prefix>`, for example:

```shell
./uninstall.sh ~/.local
```

## 构建脚本的工作原理 How this works

构建脚本的职责是从后缀为`.svg.in`与`.conf.in`的模板文件生成svg矢量图与配置文件。在模板文件中，两个`$`符号之间的内容被视为变量名，而`build.json`中记录了各个变量的可能取值。构建脚本会遍历这些变量的所有可能取值，将模板文件中对应的变量名替换为变量值。

The build script generates config files and svg files from the `.conf.in` and `.svg.in` templates. In an template file, any string quoted by `$` are variable names. `build.json` contains the possible values of the variables. The build scripts generates all possible combinations of the values of the variables, an replaces the variable names in the templates with corresponding values.

## 致谢 Acknowledgements

本项目基于Fcitx5的自带主题，以及KDE Plasma的Breeze主题。

This theme is based on the default Fcitx5 theme and Breeze Plasma theme.