# Technical Documentation: vladelaina/Catime

> ℹ️ **Provenance:** Hybrid Fusion: `vladelaina/Catime` (README + 1 In-Tree Chapters) · [CodeWiki Reference](https://codewiki.google/github.com/vladelaina/Catime) · Recency: Active (< 180 days)

## 1. Project Overview & Quickstart (vladelaina/Catime)

## 🎨 Powerful Tray Animations

Your tray icon can now come alive! Catime brings powerful custom animation features:

- **Custom Animations**: Use **GIF**, **WebP**, **ANI**, and static images like **PNG** & **JPG** as your tray icon.
- **System Status:** Supports real-time display of **CPU %**, **Memory %**, **Battery %**, and **Caps Lock** status.



> [!TIP]
> Looking for more fun animations? Check out our companion project, [MemeTray](https://github.com/MemeTray/MemeTray)!



## 💫[Plugins](https://github.com/vladelaina/Catime-Plugins)

> Plugins write to **./output.txt**, Catime displays it — that simple.







> [!TIP]
> Looking for more useful Plugins? Check out our companion project, [Catime-Plugins](https://github.com/vladelaina/Catime-Plugins)!




## ❤️‍🔥Staying tuned with us
>  **Star us** and witness how this pure C-crafted minimalist time tool continues to evolve - don't miss any exciting updates!
<a href="https://github.com/vladelaina/Catime" target="_blank">
    
</a>




## 📥 Download

<a href="https://apps.microsoft.com/detail/9n3mzdf1z34v?referrer=appbadge&mode=full" target="_blank"  rel="noopener noreferrer">
	
</a>

- GitHub Releases

  Download the latest release from [GitHub Releases](https://github.com/vladelaina/Catime/releases/latest).

- Scoop

  ```
  scoop bucket add extras

  scoop install catime
  ```

-  Winget

    ```
    winget install --id VladElaina.Catime
    ```

## [📑User Guide](https://vladelaina.github.io/Catime/guide)

- **Left-click tray icon**: Set **time**
- **Right-click tray icon**: Set **menu**
- **Edit mode**: Drag to adjust position, scroll wheel to resize, Ctrl+scroll wheel to adjust opacity, 🖱️ right-click to exit edit mode

> Configuration file saved at `%LOCALAPPDATA%\Catime\config.ini`

## ⚡[Font Optimization](https://vladelaina.github.io/Catime/tools/font-tool/)

Reduce custom font file size by **90%+** with the official [Font Simplification Tool](https://vladelaina.github.io/Catime/tools/font-tool).

> Since Catime only displays numbers and symbols (`0-9`, `:`, `.`), most font characters are unnecessary.
>
> **Recommendation**: Keep your original font files as backups. Future software updates may require additional characters beyond the current set.

## 🛠️ Development

**Prerequisites**: MinGW and CMake are required to build Catime.

## Getting Started

```bash
git clone https://github.com/vladelaina/Catime.git
cd Catime

# INSTALL DEPENDENCIES
# Ubuntu/Debian
sudo apt update && sudo apt install -y mingw-w64 cmake

# Arch Linux  
sudo pacman -Syu --noconfirm mingw-w64 cmake

# Windows - See setup instructions below
```


📋 Windows Setup Instructions

### 📦 Required Tools

| Tool       | Description            | Recommended Version Format                                    | Download Link                                                                     |
| ---------- | ---------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| **MinGW**  | GCC Compiler           | `x86_64-<version>-release-win32-seh-ucrt-rtv<num>-rev<num>.7z` | [MinGW Build](https://github.com/niXman/mingw-builds-binaries/releases/latest)  |
| **CMake**  | Build Tool             | `cmake-<version>-windows-x86_64.msi`                         | [CMake](https://cmake.org/download/)                                            |

### 🔧 Installation Steps

#### 1. Install MinGW
1. Download `x86_64-<version>-release-win32-seh-ucrt-rtv<num>-rev<num>.7z` from [MinGW Build](https://github.com/niXman/mingw-builds-binaries/releases/latest)
2. Extract to `C:\mingw64`
3. Add `C:\mingw64\bin` to your PATH environment variable:
   - Open: `Control Panel → System → Advanced System Settings → Environment Variables`
   - Find `Path` in **System variables**, click "Edit"
   - Add: `C:\mingw64\bin`

#### 2. Install CMake
1. Download and run `cmake-<version>-windows-x86_64.msi` from [CMake](https://cmake.org/download/)
2. During installation, select "Add CMake to the system PATH"

#### 3. Verify Installation
```bash
gcc --version
cmake --version
```



## Building

```bash
chmod +x build.sh && ./build.sh   # Linux
build.bat                         # Windows
```

# 🎁 [Support](https://vladelaina.github.io/Catime/support.html)




<a href="https://vladelaina.github.io/Catime/support.html">
  
</a>

## Sponsors




## Project Status



## 🌟Star History

<a href="https://www.star-history.com/#vladelaina/Catime&Date">
 
   
   
   
 
</a>



## [✨Acknowledgements](https://vladelaina.github.io/Catime/#thanks) 

With special appreciation to [猫屋敷梨梨Official](https://space.bilibili.com/26087398) for the beautiful icon design.

> Special thanks to the following contributors(chronological order):


| [**MAX°孟兆**](https://github.com/MadMaxChow) | [**XuJilong**](https://github.com/sumruler) | [**点滴进度作者**](https://www.diandiapp.com/) | [**zggsong**](https://github.com/ZGGSONG) | [**猫屋敷梨梨Official**](https://space.bilibili.com/26087398) | [**MOJIもら**](https://space.bilibili.com/6189012) | [**李康**](https://space.bilibili.com/475437261) |
| --- | --- | --- | --- | --- | --- | --- |
| [**我是无名吖**](https://space.bilibili.com/1708573954) | [**金麟**](https://github.com/flying-hilichurl) | [**双脚猫**](https://space.bilibili.com/161061562) | [**rsyqvthv**](https://github.com/rsyqvthv) | [**君影**](https://space.bilibili.com/297146893) | [**学习马楼**](https://space.bilibili.com/3546380188519387) | [**睡着的火山**](https://space.bilibili.com/8010065) |
| [**星空下数羊**](https://space.bilibili.com/5549978) | [**青阳忘川**](https://space.bilibili.com/13129221) | [**William**](https://github.com/llfWilliam) | [**王野**](https://github.com/wangye99) | [**煮酒论科技**](https://space.bilibili.com/572042200) | [**风增**](https://space.bilibili.com/470931145) | [**田春**](https://space.bilibili.com/266931550) |
| [**behappy425**](https://github.com/behappy425) | [**x.j**](https://github.com/xxtui-main/xxtui) | [**kissholic**](https://github.com/kissholic) | **Alnilam** | [**柒**](https://github.com/pyqmlp) | [**枫谷剑仙**](https://github.com/Mapaler) | [**Marial**](https://github.com/Crazy-A2) |
| [**卓越方达**](https://space.bilibili.com/507572706) | [**choyy**](https://github.com/choyy) | [**益渊Yyuan**](https://space.bilibili.com/378034263?spm_id_from=333.1007.0.0) | [**上条教主**](https://github.com/xiaodao0036) | [**jin-gubang**](https://github.com/jin-gubang) | [**xlr134**](https://github.com/xlr134) | [**莫颜**](https://github.com/leisure365) |
| [**LuSrackhall**](https://github.com/LuSrackhall) | [**是玄夜不是玄月**](https://github.com/sakuraxy2004) | [**YangCangShu**](https://github.com/YangCangShu) | [**valuex**](https://meta.appinn.net/u/valuex/summary) | [**lxzrjyff**](https://meta.appinn.net/u/lxzrjyff/summary) | [**DaYe**](https://github.com/darkmatter2048) | [**zct4257**](https://github.com/zct4257) |
| **小败叶** | [**闲人不梦君Q**](https://space.bilibili.com/25249757) | [**李良**](https://space.bilibili.com/1191321078) | [**imxhe**](https://github.com/imxhe) | [**mua**](https://github.com/haeob) | [**析木**](https://b23.tv/iRKb7Ua) | **溜溜大神校长来了** |
| [**Seredo**](https://github.com/Seredo) | [**红树林**](https://b23.tv/HVVVykm) | [**Snow-kal**](https://github.com/Snow-kal) | [**TCWei**](https://github.com/mayjay-wei) | [**YuYinLC**](https://github.com/YuYinLC) | [**Fireman**](https://meta.appinn.net/u/fireman) | [**Kder**](https://github.com/Kder) |
| [**DZAladan**](https://github.com/DZAladan) | [**埘間**](https://github.com/shi-jian520) | [**Mei_Fsto**](https://github.com/NisQz) | [**方勾勾**](https://linux.do/u/r1cky/summary) | [**此后每天天天不及那天**](https://space.bilibili.com/34952098?spm_id_from=333.337.0.0) | [**O-Illusions**](https://space.bilibili.com/627799460) |  |





## 🗝️Copyright Notice

This project is released under the Apache License 2.0 open source license.

Icon copyright notice:
- The software icon was created by [猫屋敷梨梨Official](https://space.bilibili.com/26087398) who reserves all rights. Without explicit authorization from the original creator, it may not be used for any commercial purposes.

Font licenses:
- MIT: 
  - ProFontWindows Essence.ttf
- SIL Open Font License: 
  - DaddyTimeMono Essence.otf, DepartureMono Essence.otf,
    Rec Mono Casual Essence.ttf, Terminess Nerd Font Essence.ttf
- OFL (Open Font License):
  - Jacquard 12 Essence.ttf, Jacquarda Bastarda 9 Essence.ttf,
    Pixelify Sans Essence.ttf, Rubik Burned Essence.ttf,
    Rubik Glitch Essence.ttf, Rubik Marker Hatch Essence.ttf,
    Rubik Puddles Essence.ttf, Wallpoet Essence.ttf

Wallpaper:
- Author: [猫屋敷梨梨Official](https://space.bilibili.com/26087398)
    - Dynamic wallpaper link: [猫屋敷梨梨「星之所在」曲绘夜晚版](https://steamcommunity.com/sharedfiles/filedetails/?id=3171487185) & [猫屋敷梨梨-「星之所在」曲绘黄昏版](https://steamcommunity.com/sharedfiles/filedetails/?id=3171483657)
---

## 2. In-Tree Documentation Chapters (vladelaina/Catime)

## 🎨 Powerful Tray Animations

Your tray icon can now come alive! Catime brings powerful custom animation features:

- **Custom Animations**: Use **GIF**, **WebP**, **ANI**, and static images like **PNG** & **JPG** as your tray icon.
- **System Status:** Supports real-time display of **CPU %**, **Memory %**, **Battery %**, and **Caps Lock** status.



> [!TIP]
> Looking for more fun animations? Check out our companion project, [MemeTray](https://github.com/MemeTray/MemeTray)!



## 💫[Plugins](https://github.com/vladelaina/Catime-Plugins)

> Plugins write to **./output.txt**, Catime displays it — that simple.







> [!TIP]
> Looking for more useful Plugins? Check out our companion project, [Catime-Plugins](https://github.com/vladelaina/Catime-Plugins)!




## ❤️‍🔥Staying tuned with us
>  **Star us** and witness how this pure C-crafted minimalist time tool continues to evolve - don't miss any exciting updates!
<a href="https://github.com/vladelaina/Catime" target="_blank">
    
</a>




## 📥 Download

<a href="https://apps.microsoft.com/detail/9n3mzdf1z34v?referrer=appbadge&mode=full" target="_blank"  rel="noopener noreferrer">
	
</a>

- GitHub Releases

  Download the latest release from [GitHub Releases](https://github.com/vladelaina/Catime/releases/latest).

- Scoop

  ```
  scoop bucket add extras

  scoop install catime
  ```

-  Winget

    ```
    winget install --id VladElaina.Catime
    ```

## [📑User Guide](https://vladelaina.github.io/Catime/guide)

- **Left-click tray icon**: Set **time**
- **Right-click tray icon**: Set **menu**
- **Edit mode**: Drag to adjust position, scroll wheel to resize, Ctrl+scroll wheel to adjust opacity, 🖱️ right-click to exit edit mode

> Configuration file saved at `%LOCALAPPDATA%\Catime\config.ini`

## ⚡[Font Optimization](https://vladelaina.github.io/Catime/tools/font-tool/)

Reduce custom font file size by **90%+** with the official [Font Simplification Tool](https://vladelaina.github.io/Catime/tools/font-tool).

> Since Catime only displays numbers and symbols (`0-9`, `:`, `.`), most font characters are unnecessary.
>
> **Recommendation**: Keep your original font files as backups. Future software updates may require additional characters beyond the current set.

## 🛠️ Development

**Prerequisites**: MinGW and CMake are required to build Catime.

## Getting Started

```bash
git clone https://github.com/vladelaina/Catime.git
cd Catime

# INSTALL DEPENDENCIES
# Ubuntu/Debian
sudo apt update && sudo apt install -y mingw-w64 cmake

# Arch Linux  
sudo pacman -Syu --noconfirm mingw-w64 cmake

# Windows - See setup instructions below
```


📋 Windows Setup Instructions

### 📦 Required Tools

| Tool       | Description            | Recommended Version Format                                    | Download Link                                                                     |
| ---------- | ---------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| **MinGW**  | GCC Compiler           | `x86_64-<version>-release-win32-seh-ucrt-rtv<num>-rev<num>.7z` | [MinGW Build](https://github.com/niXman/mingw-builds-binaries/releases/latest)  |
| **CMake**  | Build Tool             | `cmake-<version>-windows-x86_64.msi`                         | [CMake](https://cmake.org/download/)                                            |

### 🔧 Installation Steps

#### 1. Install MinGW
1. Download `x86_64-<version>-release-win32-seh-ucrt-rtv<num>-rev<num>.7z` from [MinGW Build](https://github.com/niXman/mingw-builds-binaries/releases/latest)
2. Extract to `C:\mingw64`
3. Add `C:\mingw64\bin` to your PATH environment variable:
   - Open: `Control Panel → System → Advanced System Settings → Environment Variables`
   - Find `Path` in **System variables**, click "Edit"
   - Add: `C:\mingw64\bin`

#### 2. Install CMake
1. Download and run `cmake-<version>-windows-x86_64.msi` from [CMake](https://cmake.org/download/)
2. During installation, select "Add CMake to the system PATH"

#### 3. Verify Installation
```bash
gcc --version
cmake --version
```



## Building

```bash
chmod +x build.sh && ./build.sh   # Linux
build.bat                         # Windows
```

# 🎁 [Support](https://vladelaina.github.io/Catime/support.html)




<a href="https://vladelaina.github.io/Catime/support.html">
  
</a>

## Sponsors




## Project Status



## 🌟Star History

<a href="https://www.star-history.com/#vladelaina/Catime&Date">
 
   
   
   
 
</a>



## [✨Acknowledgements](https://vladelaina.github.io/Catime/#thanks) 

With special appreciation to [猫屋敷梨梨Official](https://space.bilibili.com/26087398) for the beautiful icon design.

> Special thanks to the following contributors(chronological order):


| [**MAX°孟兆**](https://github.com/MadMaxChow) | [**XuJilong**](https://github.com/sumruler) | [**点滴进度作者**](https://www.diandiapp.com/) | [**zggsong**](https://github.com/ZGGSONG) | [**猫屋敷梨梨Official**](https://space.bilibili.com/26087398) | [**MOJIもら**](https://space.bilibili.com/6189012) | [**李康**](https://space.bilibili.com/475437261) |
| --- | --- | --- | --- | --- | --- | --- |
| [**我是无名吖**](https://space.bilibili.com/1708573954) | [**金麟**](https://github.com/flying-hilichurl) | [**双脚猫**](https://space.bilibili.com/161061562) | [**rsyqvthv**](https://github.com/rsyqvthv) | [**君影**](https://space.bilibili.com/297146893) | [**学习马楼**](https://space.bilibili.com/3546380188519387) | [**睡着的火山**](https://space.bilibili.com/8010065) |
| [**星空下数羊**](https://space.bilibili.com/5549978) | [**青阳忘川**](https://space.bilibili.com/13129221) | [**William**](https://github.com/llfWilliam) | [**王野**](https://github.com/wangye99) | [**煮酒论科技**](https://space.bilibili.com/572042200) | [**风增**](https://space.bilibili.com/470931145) | [**田春**](https://space.bilibili.com/266931550) |
| [**behappy425**](https://github.com/behappy425) | [**x.j**](https://github.com/xxtui-main/xxtui) | [**kissholic**](https://github.com/kissholic) | **Alnilam** | [**柒**](https://github.com/pyqmlp) | [**枫谷剑仙**](https://github.com/Mapaler) | [**Marial**](https://github.com/Crazy-A2) |
| [**卓越方达**](https://space.bilibili.com/507572706) | [**choyy**](https://github.com/choyy) | [**益渊Yyuan**](https://space.bilibili.com/378034263?spm_id_from=333.1007.0.0) | [**上条教主**](https://github.com/xiaodao0036) | [**jin-gubang**](https://github.com/jin-gubang) | [**xlr134**](https://github.com/xlr134) | [**莫颜**](https://github.com/leisure365) |
| [**LuSrackhall**](https://github.com/LuSrackhall) | [**是玄夜不是玄月**](https://github.com/sakuraxy2004) | [**YangCangShu**](https://github.com/YangCangShu) | [**valuex**](https://meta.appinn.net/u/valuex/summary) | [**lxzrjyff**](https://meta.appinn.net/u/lxzrjyff/summary) | [**DaYe**](https://github.com/darkmatter2048) | [**zct4257**](https://github.com/zct4257) |
| **小败叶** | [**闲人不梦君Q**](https://space.bilibili.com/25249757) | [**李良**](https://space.bilibili.com/1191321078) | [**imxhe**](https://github.com/imxhe) | [**mua**](https://github.com/haeob) | [**析木**](https://b23.tv/iRKb7Ua) | **溜溜大神校长来了** |
| [**Seredo**](https://github.com/Seredo) | [**红树林**](https://b23.tv/HVVVykm) | [**Snow-kal**](https://github.com/Snow-kal) | [**TCWei**](https://github.com/mayjay-wei) | [**YuYinLC**](https://github.com/YuYinLC) | [**Fireman**](https://meta.appinn.net/u/fireman) | [**Kder**](https://github.com/Kder) |
| [**DZAladan**](https://github.com/DZAladan) | [**埘間**](https://github.com/shi-jian520) | [**Mei_Fsto**](https://github.com/NisQz) | [**方勾勾**](https://linux.do/u/r1cky/summary) | [**此后每天天天不及那天**](https://space.bilibili.com/34952098?spm_id_from=333.337.0.0) | [**O-Illusions**](https://space.bilibili.com/627799460) |  |





## 🗝️Copyright Notice

This project is released under the Apache License 2.0 open source license.

Icon copyright notice:
- The software icon was created by [猫屋敷梨梨Official](https://space.bilibili.com/26087398) who reserves all rights. Without explicit authorization from the original creator, it may not be used for any commercial purposes.

Font licenses:
- MIT: 
  - ProFontWindows Essence.ttf
- SIL Open Font License: 
  - DaddyTimeMono Essence.otf, DepartureMono Essence.otf,
    Rec Mono Casual Essence.ttf, Terminess Nerd Font Essence.ttf
- OFL (Open Font License):
  - Jacquard 12 Essence.ttf, Jacquarda Bastarda 9 Essence.ttf,
    Pixelify Sans Essence.ttf, Rubik Burned Essence.ttf,
    Rubik Glitch Essence.ttf, Rubik Marker Hatch Essence.ttf,
    Rubik Puddles Essence.ttf, Wallpoet Essence.ttf

Wallpaper:
- Author: [猫屋敷梨梨Official](https://space.bilibili.com/26087398)
    - Dynamic wallpaper link: [猫屋敷梨梨「星之所在」曲绘夜晚版](https://steamcommunity.com/sharedfiles/filedetails/?id=3171487185) & [猫屋敷梨梨-「星之所在」曲绘黄昏版](https://steamcommunity.com/sharedfiles/filedetails/?id=3171483657)
---

--- METRICS ---
- Files Extracted: 2
- Estimated Token Budget: ~4453 tokens
- Recency Window: Active (< 180 days)
- Canonical Reference: https://codewiki.google/github.com/vladelaina/Catime