Introduction

🚧 Documentation incomplete, work in progress...

This project is currently in beta and may be subject to breaking changes.

❓ What is a rice?

Ricing refers to the process of customizing the visual appearance and functionality of a desktop environment, usually in Linux or Unix-based systems.
It involves tweaking themes, icons, fonts, and configurations to achieve a unique and aesthetically pleasing interface.
A well-customized setup, called a "rice", showcases the user's attention to detail, personality and creativity.

Take a look at r/unixporn for inspiration.

🤔 What does PimpMyRice do?

PimpMyRice allows you to generate, organize and apply themes to your system.
It applies them through modules, each module being responsible for styling a specific program (eg: discord).

⚙️ Features

• 🚀 Easy to get started
• 🛠️ Infinitely customizable
• 📜 Powerful file and shell command templating using Jinja
• 🐍 Extendable through Python
• ⚡ Fast enough
• 📝 Autocomplete in editor and terminal*
• 🌈 Color extraction*
• 🔗 Server with API*
• 🖼️ GUI (coming soon™)

*WIP

🚀 Quick start

📥 Install

Follow the installation instructions.

Verify

Print the help message by running:

pimp

📦 Add some modules

Create your own modules from scratch or clone from the starter modules to get started.

For example, clone the alacritty module:

pimp clone module pimp://alacritty

🎨 Generate and apply a new theme

Generate a theme from an image:

pimp gen Downloads/example.png
# or
pimp gen https://website.com/example.png

Set the generated theme:

pimp set theme example

🌟 Start ricing

Edit the current theme:

pimp edit theme

Edit the base style:

pimp edit base-style

Enjoy ricing! 🍙

🙏 Related Projects / Thanks

• pywal
• wpgtk
• r/unixporn