____ ___  _   _ _  ____   __ __        ___     ____        
                       / ___/ _ \| \ | | |/ /\ \ / / \ \      / / |   |  _ \        
                      | |  | | | |  \| | ' /  \ V /___\ \ /\ / /| |   | |_) |        
                      | |__| |_| | |\  | . \   | |_____\ V  V / | |___|  _ <         
                       \____\___/|_| \_|_|\_\  |_|      \_/\_/  |_____|_| \_\       

Love Conky and want it to run natively on Wayland?

You're in the right place!

🎯 What is this project?

This repository is an experimental attempt to build a native Wayland backend for Conky. This repository is structured as a step-by-step exploration of Wayland rendering, progressing from a minimal client to a modular widget framework.

I’m not a professional developer — my experience comes mostly from small Bash, Python, HTML & CSS projects.
But Conky deserves to run properly on Wayland without X11, XWayland, or hacks… so here we are.

This project:

• may take a long time,
• may fail in some parts,
• will definitely evolve,
• is open to anyone who wants to experiment or contribute

---

🌟 Project Vision

• Build a Wayland-native backend for Conky
• Support text, graphs, and Lua-based widgets
• Provide cross-compositor compatibility
• Encourage community-driven experimentation and contributions

---

🚀 Current Status

Important. Current phase of the project - PAUSE. 
Work is underway and a custom system widget for plasma (kwin).      

This repository currently serves as:

• a research sandbox,
• a learning space for Wayland + SHM + Cairo,
• and a step-by-step progression toward a functional prototype.

Milestones are updated manually as development progresses.

Milestone	Progress
Project Foundation	🔹 25%
Wayland Architecture Research	🔹 66%
Prototype Rendering Layer	🔹 66%

See Milestones for details.
Track issues progress here.

---

📂 Repository Structure

Files/
 ├── 00.wayland_protocol_headers/   → generated xdg-shell headers
 ├── 01.hello_wayland/              → minimal Wayland client test
 ├── 02.wayland_shm/                → SHM surface + raw drawing
 ├── 03.wayland_shm_cairo/          → SHM + Cairo rendering
 ├── 04.wayland_shm_cairo_db/       → SHM + Cairo + double buffer - widget prototype
 └── 05.wayland_movable             → SHM + Cairo + double buffer + xdg_move + config
Screenshots/                        → test output images

Each subdirectory contains its own README.md with instructions.

---

📦 Installation

(Under development – instructions will be added once the prototype is ready.)

---

📝 Contributing

It will be open to contributors once there is a functional basis.
For now, it is being used for experimenting with Wayland.

• See CONTRIBUTING.md for detailed guidelines

---

🎯 Milestones Overview

1. Project Foundation – setup, documentation, roadmap
2. Wayland Architecture Research – backend study, rendering options, Lua feasibility
3. Prototype Rendering Layer – minimal Wayland surface, text and shape rendering, placeholder for widgets

---

Development Path

      hello_wayland (v01)
           │
           ▼
      Wayland SHM buffers (v02)
           │
           ▼
      SHM + Cairo rendering (v03)
           │
           ▼
      Double buffering (v03)
           │
           ▼
      Widget prototype (v04)
           │
           ▼
      Widget framework (v05)

Development Progress

✅ First step completed: hello_wayland.c skeleton created and successfully tested.

This minimal Wayland client creates a surface and confirms the connection to the compositor.
See file

✅ Version 02 : SHM buffer allocation + drawing

Basic shared memory buffer rendering implemented.
See file

✅ Version 03 : Cairo-based text rendering

Text rendering using Cairo integrated with Wayland SHM buffers.
See file

✅ Version 04 : Modular rendering architecture - widget prototype

  - real-time rendering (tick-based redraw)       
  - double buffering       
  - modular architecture       
  - dynamic system information (Time, CPU, RAM)       
  - transparency and alpha blending       

See files

✅ Version 05 milestone: system widgets and window interaction Features introduced:

  - Cairo graphics and text rendering
  - system monitoring modules
  - modular widgets
  - configuration system
  - graphs and progress bars
  - drag-to-move window support (xdg_move)       

See files

Architecture Overview

               Wayland Compositor
                       │
                       ▼
               Wayland Client
             (wayland_movable.c)
                       │
                       ▼
               SHM Buffer System
            (shared memory buffers)
                       │
                       ▼
                Cairo Renderer
       ┌───────────────┼───────────────┐
       ▼               ▼               ▼     
  Shapes / UI      Text Rendering     Graphs      
(cairo_graphics)   (cairo_text)     (progress/graphs)       
       │               │               │       
       └───────────────┴───────────────┘        
                       │      
                       ▼       
                   Widgets       
        (combine graphics + text + data)
                       │
                       ▼
               System Information
      CPU / RAM / GPU / Network / Storage

🔜

🖼 Screenshots / Demos

Wayland_SHM

📄 View README

---

Wayland_SHM_Cairo_text

📄 View README

---

Wayland_SHM_Cairo_widget_prototype

📄 View README

---

Wayland_movable

📄 View README

---

📚 References

• Conky
• Wayland
• Wayland book
• wlroots Documentation
• Cairo Graphics
• Lua 5.x for widget scripts

---

📝 Note

This project is intended as a personal experiment and community contribution. There is no guarantee that everything will work immediately, but every step forward is welcome.