odyseus / cinnamontools Goto Github PK

Applets/Extensions/Themes for the Cinnamon desktop environment.

Bug reports, feature requests and contributions must be done in GitLab . Repository mirror:

The application used in this repository to build xlets and several other tasks requires Python 3.7+ to be available in /usr/bin/python3. All xlets that are shipped with Python scripts to perform different tasks have the exact same requirement.

Additionally, each xlet can depend on certain commands to be available on PATH or packages to be installed on a system. These dependencies are listed in each xlet help pages. See Xlets help pages.

All xlets in this repository aren't directly usable, they need to be built. The same principle applies to the themes in this repository (they need to be built).

The app.py script found at the root of the repository is the application that takes care of the xlet building process. It has to be run from a terminal opened inside the repository's folder.

The following command starts a CLI (Command Line Interface) interactive menu from which one can select the xlets to build or build all xlets/themes at once. From this menu all building tasks are interactive and all chosen options are saved for later reuse.

$ ./app.py menu

The command bellow will perform the following actions:

$ ./app.py build_xlets --all-xlets --domain="domain.com" --output="$HOME/.local/share/cinnamon" --no-confirmation --restart-cinnamon

• --all-xlets: Build all xlets found on the repository.
• --output: All built xlets will be stored directly into Cinnamon's xlets storage for the current user.
• --domain: The domain domain.com will be used as part of all xlets UUIDs.
• --no-confirmation: All existent xlets will be overwritten without confirmation.
• --restart-cinnamon: Cinnamon will be restarted when the build process is finished.

Note: Refer to the documentation for detailed command line usage.

The theme building process is interactive (the build process will ask for Cinnamon version, GTK+ 3/4 versions, etc.). There are 11 theme variants in this repository, but an infinite number of variants can be created. See How to create a custom theme variant?.

The command bellow will perform the following actions:

$ ./app.py build_themes --theme-name="MyThemeName" --output="$HOME/.themes" --no-confirmation --restart-cinnamon

• Build all variants of the theme found on this repository.
• --theme-name: MyThemeName will be used as part of the generated theme names. MyThemeName-ThemeVariant will be the final result.
• --output: Themes will be stored into Cinnamon's themes storage for the current user.
• --no-confirmation: All existent themes will be overwritten without confirmation.
• --restart-cinnamon: Cinnamon will be restarted when the build process is finished.

Note: Refer to the documentation for detailed command line usage.

Most of the xlets in this repository come with help pages that describe their usage, Cinnamon version compatibility, list of dependencies (if any), list of contributors, change logs, etc. These help pages can be read on-line, before an xlet is actually installed on the system. Or they can be read off-line, after an xlet has been installed.

The help pages are standalone HTML files named HELP.html that can be found inside each xlet folder.

Applet's help pages can be accessed from an applet context menu (item named Help).

• Argos for Cinnamon
• Cinnamon Menu (Fork By Odyseus)
• Desktop Capture (Fork By Odyseus)
• Desktop Handler
• Feeds Reader (Fork By Odyseus)
• Mailnag (Fork By Odyseus)
• Panel Drawer (Fork By Odyseus)
• Quick Menu
• Simple ToDo List
• System Monitor (Fork By Odyseus)
• Weather (Fork By Odyseus)
• Window list (Fork By Odyseus)

• Cinnamon Tweaks
• Color Blindness Assistant
• Desktop Effects Applier
• Multi Translator

The documentation of this repository is mainly a development documentation, but it also documents the xlets/themes building processes.

The documentation also has a Cinnamon tips & tricks section which describes some basic concepts and how to recover from an unresponsive Cinnamon session, amongst other things.

Anyone is free to redistribute any of the xlets in this repository as long as the following points are respected:

1. Respect the license (GPL-3.0).
2. Complete eradication of my name (Odyseus) from all xlets file names and files content.
3. Complete eradication of references to this repository (or any of its mirrors) from all xlets files content.