Skip to content

Commit

Permalink
update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
R3c0ger committed Aug 24, 2024
1 parent c21887f commit 8cf06ec
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 4 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,20 @@

## Feature Introduction

KalloPic is a folder-based image viewer, filter, and archiver. It helps users achieve the following functionalities:
KalloPic is a folder-based image viewer, filter, and archiver. It has been packaged as a single-file executable program that can be used on the Windows 10/11 platform. It helps users achieve the following functionalities:

### 1. Simple Image Browsing

- **Folder-Based**: Specify a **source folder**, and the software will open all images within it.
- **Recursive Viewing**: Recursively view all images in the specified folder, including those in subfolders.
- **Supported Formats**: `jpg`, `png`, `bmp`, `gif` (static preview only), `webp`, etc.
- **Various Operations and Browsing Modes**: Sort by time/name/size, reverse sorting, delete, view basic information, set browsing mode, adjust background color, invert colors, rotate, full screen, etc.
- **Various Operations and Browsing Modes**: Sort by time/name/size, reverse sorting, delete, view basic information, set browsing mode, adjust background color, invert colors, rotate, full screen, right-click menu, etc.
- **Hotkey Support**: Most functions have corresponding hotkeys; press <kbd>F12</kbd> to view all hotkeys.

![img_README_zh-CN_0](resources/illustration/viewer.png)

![img_README_zh-CN_1](resources/illustration/helper.png)

### 2. Image Filtering

After entering a valid source folder path, press <kbd>F9</kbd> to enter the filtering interface.
Expand All @@ -57,18 +61,24 @@ After entering a valid source folder path, press <kbd>F9</kbd> to enter the filt
- Delete images with duplicate filenames;
- Delete images with high similarity (choose from **Hash**, **Cosine Similarity**, **MSE** comparison methods);

![img_README_zh-CN_2](resources/illustration/filter.png)

### 3. Image Archiving

This feature may not be widely applicable but can be helpful for specific user groups. For example, when you have a large number of unsorted images that need manual classification, and they appear disorganized in File Explorer no matter how you sort them, the thumbnail view is unclear, and many images require closer inspection. In such cases, KalloPic's **Image Archiving** function comes into play.

Press <kbd>Esc</kbd> to enter archiving mode, and an input box will appear in the top-right corner of the image browser. After specifying a **target folder**, you can enter lowercase alphabetical **quick keywords** in the input box. Click on the dropdown list options or press the corresponding 1-5 number keys to move the currently opened image to a subfolder under the specified folder named after the selected option.

![img_README_zh-CN_3](resources/illustration/archiver.png)

A folder name can correspond to multiple quick keywords, and multiple **folder name-keywords** pairs form a **dictionary**. Press <kbd>F10</kbd> to edit this dictionary, supporting operations such as adding, deleting, modifying, moving up/down, saving, loading preset dictionaries/saved dictionaries, importing, exporting, and clearing.

Note that this dictionary has a priority order, which determines the order of options when quick keywords correspond to multiple possibilities, allowing users to place frequently used options at the front.

The software includes a preset dictionary containing most character names from the Touhou Project series, with quick keywords mostly being English names, Chinese pinyin and abbreviations, and Chinese nicknames.

![img_README_zh-CN_4](resources/illustration/dict_editor.png)

## Environment Requirements

**Operating Systems Supported for Using the Software**: Windows 10/11
Expand All @@ -81,6 +91,7 @@ The software includes a preset dictionary containing most character names from t
- pypinyin
- opencv-python
- imagehash
- numpy
- pyinstaller

## Installation and Configuration
Expand Down
15 changes: 13 additions & 2 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,20 @@

## 功能介绍

KalloPic 是一个基于文件夹的图片查看器、过滤器和归档器。它可以帮助用户实现如下功能:
KalloPic 是一个基于文件夹的图片查看器、过滤器和归档器,现已打包为可在 Windows 10/11 平台上使用的单文件可执行程序。它可以帮助用户实现如下功能:

### 1. 简单的图片浏览

- **以文件夹为单位**:需指定一个 **源文件夹**,软件才能打开该文件夹下的所有图片。
- **支持递归浏览**:可以递归查看指定文件夹下的所有图片,包括文件夹下的所有文件夹中的图片。
- **可查看基本的图片格式**`jpg``png``bmp``gif`(仅支持静态预览)、`webp` 等。
- **支持多种操作和浏览模式**:按时间/文件名/大小排序、倒序排序、删除、查看基本信息、设置浏览方式、调整背景颜色、反色、旋转、全屏等
- **支持多种操作和浏览模式**:按时间/文件名/大小排序、倒序排序、删除、查看基本信息、设置浏览方式、调整背景颜色、反色、旋转、全屏、右键菜单等
- **快捷键支持**:绝大多数功能均有相应快捷键,按下 <kbd>F12</kbd> 可查看所有快捷键。

![img_README_zh-CN_0](resources/illustration/viewer.png)

![img_README_zh-CN_1](resources/illustration/helper.png)

### 2. 图片过滤

在输入了有效的源文件夹路径之后,按下 <kbd>F9</kbd> 键可进入过滤界面。
Expand All @@ -57,18 +61,24 @@ KalloPic 是一个基于文件夹的图片查看器、过滤器和归档器。
- 删除文件名重复的图片;
- 删除相似度过高的图片(可选择 **哈希、余弦相似度、MSE** 三种比较方式);

![img_README_zh-CN_2](resources/illustration/filter.png)

### 3. 图片归档

该功能的应用场景并不普遍,对于一些有特定需求的用户群体,可能会有一定的帮助。比如当你手上有一大大大堆需要分类的图片,且不幸的是:你必须手动去分类;这些图片在文件资源管理器中无论用什么排序方式都显得杂乱无章;缩略图看的不清楚,很多图片都需要放大细看,那么这时候,KalloPic 的 **图片归档** 功能就派上用场了。

按下 <kbd>Esc</kbd> 键可进入归档模式,图片浏览器右上角会出现输入框,在指定了 **目标文件夹** 后,可以在输入框中输入仅有小写英文字母的 **快捷关键词**,点击下拉列表中的选项或按下相应的1-5数字键,即可将当前打开的图片,移动到指定文件夹下以选项为名的文件夹。

![img_README_zh-CN_3](resources/illustration/archiver.png)

一个文件夹名可以对应多个快捷关键词,多个 **文件夹名-关键词** 键值对形成一个 **字典**,这一字典可以通过按下 <kbd>F10</kbd> 键进行编辑。支持的操作包括:添加、删除、修改、上/下移、保存、读取预设字典/已保存的字典、导入、导出、清空等。

注意这一字典具有优先级顺序,这是为了在归档时,如果输入的快捷关键字对应多个可能的选项。用户可以根据优先级,将常用的选项排在前面。

本软件已预设一套字典,该字典为东方 Project 系列的绝大部分角色名,快捷关键词大多为角色名的英文、中文拼音及缩写、中文外号及缩写等。

![img_README_zh-CN_4](resources/illustration/dict_editor.png)

## 需求环境

**软件运行所需操作系统**:Windows 10/11
Expand All @@ -81,6 +91,7 @@ KalloPic 是一个基于文件夹的图片查看器、过滤器和归档器。
- pypinyin
- opencv-python
- imagehash
- numpy
- pyinstaller

## 安装配置
Expand Down
Binary file added resources/illustration/archiver.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/illustration/dict_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/illustration/filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/illustration/helper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/illustration/viewer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8cf06ec

Please sign in to comment.