Skip to content

README_TEMPLATE.md

Latest commit

 

History

History
98 lines (55 loc) · 2.72 KB

README_TEMPLATE.md

File metadata and controls

98 lines (55 loc) · 2.72 KB

Dank Material Shell Plugins

This repository contains a collection of plugins for Dank Material Shell

https://plugins.danklinux.com/

Contributing

To add your Plugin to the list please read the contribution guidelines and create a pull request.

Installing Plugins

Via DMS Settings UI

On DMS open the settings Mod + , go to Plugins tab and click on Browse button.

Via dms CLI

On your teminal run dms then navigate to the plugins option or run dms plugins install {plugin-name} directly.

Manually

Clone the plugin repository into your ~/.config/DankMaterialShell/plugins/ folder and restart your dms session with dms restart. NOTE: Some plugins may have additional dependencies that need to be installed manually, please refer to the plugin documentation for more information, some plugins are part of a monorepo and need to be installed by copying the relevant path to the plugins folder.

With Nix

Follow the Nix usage documentation

Disclaimer

Some plugins are created by third-party developers and are not officially supported by the Dank Material Shell team. Use them at your own risk. In case of issues, please contact the plugin author directly.

Plugins

Categories: {% for category in categories %}[{{ category.name }}](#{{ category.name | lower | replace(" ", "-") }}){% if not loop.last %} | {% endif %}{% endfor %}

{% for category in categories %}

{{ category.name }}

{% for plugin in category.plugins %}

[{{ plugin.name }}]({{ plugin.repo }})

{{ plugin.description }}

{%if plugin.requires_dms %}requires DMS version: {{plugin.requires_dms}}{%endif%}

  • id: {{ plugin.id }}
  • name: {{ plugin.name }}
  • author: {{ plugin.author }}
  • compositors: {{ plugin.compositors | join(", ") }}
  • capabilities: {{ plugin.capabilities | join(", ") }}
  • dependencies: {{ plugin.dependencies | join(", ") }}
  • distro: {{ plugin.distro | join(", ") }}

{% if plugin.path %}

Note

This plugin is part of a monorepo, please copy the contents of the [{{ plugin.path }}]({{ plugin.repo }}/tree/main/{{ plugin.path }}) folder to your ~/.config/DankMaterialShell/plugins/ folder.

{% endif %}

{% if plugin.screenshot %}

Screenshot

![screenshot]({{ plugin.screenshot }})

{% endif %}

{% endfor %}

{% endfor %}

Themes

{% if themes %} {% for theme in themes %}

{{ theme.name }}

{{ theme.description }}

  • Author: {{ theme.author }}
  • ID: {{ theme.id }} Version: {{ theme.version }}

![{{ theme.name }}](themes/{{ theme._dirname }}/preview.svg)

{% endfor %} {% endif %}