Skip to content

Deskulpt (Desktop + Sculpt, pronounced /'deskʌlpt/), a cross-platform desktop customization tool.

License

Notifications You must be signed in to change notification settings

CSCI-SHU-410-SE-Project/Deskulpt

Repository files navigation

Deskulpt

Project status license hompage
Repository build test-core
Release release windows macos linux

Introduction

Deskulpt is a cross-platform desktop customization tool that allows you to write React code to define widgets on your desktop. It is powered by Tauri, and written in Rust and TypeScript.

The project was started in 2024 as a final project for the Software Engineering course at NYU Shanghai. It is currently maintained by the original authors.

Similar softwares exist (Rainmeter for Windows, Ubersicht for MacOS), but what makes Deskulpt different is that:

  • Deskulpt is cross-platform. To the best of our knowledge, Deskulpt is the first desktop customization tool that supports all major desktop platforms (Windows, MacOS, Linux).

  • Deskulpt is light-weight and memory-safe. Deskulpt is powered by Tauri, which uses Rust as its backend. Tauri provides a more light-weight solution than other existing frameworks (e.g. Electron), and Rust guarantees the memory safety of Deskulpt.

Currently, Deskulpt supports the following platforms:

  • Windows (10, 11)
  • MacOS
  • Linux (X11, tested on Ubuntu)

Website: https://csci-shu-410-se-project.github.io/Deskulpt/

Download

Download the latest release of Deskulpt here. To install and build Deskulpt from source, see development. Refer to the installation guide for more details.

Development

We welcome new contributors of all experience levels. The goals of the Deskulpt community are to be helpful, welcoming, and effective. The developers' guide has detailed information about contributing code, documentation, tests, and more. We also provide developers' API references for both the frontend and backend of Deskulpt to help contributors better understand the codebase.

Authors