Add Lucide icon theme (#2632)

vkbo · web-flow · commit 60d7bd301bc5 · 2025-12-29T16:07:49.000+01:00
diff --git a/CREDITS.md b/CREDITS.md
@@ -69,6 +69,7 @@ constraints. These themes include a subset of icons from:
 
 * **Font Awesome** by Fonticons Inc (CC BY 4.0)
 * **Remix** by RemixIcon (Apache 2.0 w/non-free clause)
+* **Lucide** by Cole Bemis and Lucide Contributors (ISC License)
 
 ## Colour Themes
 
diff --git a/novelwriter/assets/text/credits_en.htm b/novelwriter/assets/text/credits_en.htm
@@ -86,6 +86,7 @@ <h3>Icon Themes</h3>
   <ul>
     <li><b>Font Awesome</b> by Fonticons Inc (CC BY 4.0)</li>
     <li><b>Remix</b> by RemixIcon (Apache 2.0 w/non-free clause)</li>
+    <li><b>Lucide</b> by Cole Bemis and Lucide Contributors (ISC License)</li>
   </ul>
 
   <h3>Colour Themes</h3>
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,7 +7,7 @@ name = "novelWriter"
 authors = [{ name = "Veronica Berglyd Olsen", email = "code@vkbo.net" }]
 description = "A plain text editor for planning and writing novels"
 readme = { file = "setup/description_pypi.md", content-type = "text/markdown" }
-license = "GPL-3.0-or-later AND Apache-2.0 AND CC-BY-4.0"
+license = "GPL-3.0-or-later AND Apache-2.0 AND CC-BY-4.0 AND ISC"
 license-files = ["LICENSE.md", "setup/LICENSE-Apache-2.0.txt"]
 dynamic = ["version"]
 requires-python = ">=3.11"
diff --git a/setup/debian/copyright b/setup/debian/copyright
@@ -56,3 +56,23 @@ License: CC-BY-4.0
  International. To view a copy of this license, visit
  .
  https://creativecommons.org/licenses/by/4.0/
+
+Files: novelwriter/assets/icons/lucide.*
+Copyright: Cole Bemis, Lucide Contributors
+License: ISC
+ Copyright (c) for portions of Lucide are held by Cole Bemis 2013-2023
+ as part of Feather (MIT). All other copyright (c) for Lucide are held
+ by Lucide Contributors 2025.
+ .
+ Permission to use, copy, modify, and/or distribute this software for
+ any purpose with or without fee is hereby granted, provided that the
+ above copyright notice and this permission notice appear in all copies.
+ .
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+ WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
+ BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
+ OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+ WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+ SOFTWARE.
diff --git a/utils/icon_themes.py b/utils/icon_themes.py
@@ -37,12 +37,14 @@
 ICON_SOURCES = {
     "material":     "https://github.com/google/material-design-icons.git",
     "font_awesome": "https://github.com/FortAwesome/Font-Awesome/archive/refs/tags/7.1.0.zip",
-    "remix":        "https://github.com/Remix-Design/RemixIcon/archive/refs/tags/v4.6.0.zip",
+    "remix":        "https://github.com/Remix-Design/RemixIcon/archive/refs/tags/v4.8.0.zip",
+    "lucide":       "https://github.com/lucide-icons/lucide/archive/refs/tags/0.562.0.zip",
 }
 ICON_EXTRACT = {
     "material":     "material-design-icons",
     "font_awesome": "Font-Awesome-7.1.0",
-    "remix":        "RemixIcon-4.6.0",
+    "remix":        "RemixIcon-4.8.0",
+    "lucide":       "lucide-0.562.0",
 }
 ICONS = [
     # Remember to also update tests/files/all_icons.json for test coverage
@@ -189,14 +191,6 @@ def _loadMap(name: str) -> dict[str, str]:
     return icons
 
 
-def _fixXml(svg: ET.Element) -> str:
-    """Clean up the SVG XML and add needed fields."""
-    svg.set("fill", "#000000")
-    svg.set("height", "128")
-    svg.set("width", "128")
-    return ET.tostring(svg).decode()
-
-
 def _writeThemeFile(
     path: Path, name: str, author: str, license_: str, icons: dict[str, ET.Element]
 ) -> None:
@@ -210,7 +204,8 @@ def _writeThemeFile(
         out.write("\n")
         out.write("# Icons\n")
         for key, svg in icons.items():
-            out.write(f"icon:{key:<15s} = {_fixXml(svg)}\n")
+            icon = ET.tostring(svg).decode().replace("\n", "")
+            out.write(f"icon:{key:<15s} = {icon}\n")
         print(f"- Wrote: {len(icons)} icons")
         print(f"- Target: {path.relative_to(UTILS.parent)}")
 
@@ -261,7 +256,11 @@ def processMaterialIcons(workDir: Path, iconsDir: Path, jobs: dict) -> None:
                 fileName = f"{icon}_24px.svg"
             iconFile = iconSrc / icon / f"materialsymbols{style}" / fileName
             if iconFile.is_file():
-                icons[key] = ET.fromstring(iconFile.read_text(encoding="utf-8"))
+                svg = ET.fromstring(iconFile.read_text(encoding="utf-8"))
+                svg.set("fill", "#000000")
+                svg.set("height", "128")
+                svg.set("width", "128")
+                icons[key] = svg
             else:
                 print(f"Not Found: {iconFile}")
 
@@ -304,6 +303,9 @@ def processFontAwesome(workDir: Path, iconsDir: Path, jobs: dict) -> None:
                 viewbox = [int(x) for x in svg.get("viewBox", "").split()]
                 viewbox = [viewbox[2]//2 - 256, 0, 512, 512]
                 svg.set("viewBox", " ".join(str(x) for x in viewbox))
+                svg.set("fill", "#000000")
+                svg.set("height", "128")
+                svg.set("width", "128")
                 for elem in svg.iter():
                     elem.attrib.pop("fill", None)
                 icons[key] = svg
@@ -317,6 +319,37 @@ def processFontAwesome(workDir: Path, iconsDir: Path, jobs: dict) -> None:
     print("")
 
 
+def processLucide(workDir: Path, iconsDir: Path, jobs: dict) -> None:
+    """Process Lucide icons of a given spec and write output file."""
+    srcRepo = workDir / ICON_EXTRACT["lucide"]
+    if not srcRepo.is_dir():
+        _downloadIconPack(workDir, "lucide")
+
+    for file, job in jobs.items():
+        name: str = job["name"]
+        print(f"Processing: {name}")
+
+        icons: dict[str, ET.Element] = {}
+        iconSrc = srcRepo / "icons"
+        for key, icon in _loadMap("lucide").items():
+            iconFile = iconSrc / f"{icon}.svg"
+            if iconFile.is_file():
+                svg = ET.fromstring(iconFile.read_text(encoding="utf-8"))
+                ET.indent(svg, space="")
+                svg.set("fill", "none")
+                svg.set("stroke", "#000000")
+                svg.set("height", "128")
+                svg.set("width", "128")
+                icons[key] = svg
+            else:
+                print(f"Not Found: {iconFile}")
+
+        target = iconsDir / f"{file}.icons"
+        _writeThemeFile(target, name, "Cole Bemis, Lucide Contributors", "ISC/MIT License", icons)
+
+    print("")
+
+
 def processRemix(workDir: Path, iconsDir: Path, jobs: dict) -> None:
     """Process Remix icons of a given spec and write output file."""
     srcRepo = workDir / ICON_EXTRACT["remix"]
@@ -351,7 +384,11 @@ def processRemix(workDir: Path, iconsDir: Path, jobs: dict) -> None:
                     print(f"Not Found: {fileName}")
                     continue
 
-            icons[key] = ET.fromstring(iconFile.read_text(encoding="utf-8"))
+            svg = ET.fromstring(iconFile.read_text(encoding="utf-8"))
+            svg.set("fill", "#000000")
+            svg.set("height", "128")
+            svg.set("width", "128")
+            icons[key] = svg
 
         target = iconsDir / f"{file}.icons"
         _writeThemeFile(target, name, "Remix Icon", "Apache 2.0", icons)
@@ -418,6 +455,13 @@ def main(args: argparse.Namespace) -> None:
             },
         })
 
+    if style in ("all", "optional", "free", "lucide"):
+        processLucide(workDir, iconsDir, {
+            "lucide": {
+                "name": "Lucide",
+            },
+        })
+
     if style in ("all", "optional", "non_free", "remix"):
         processRemix(workDir, iconsDir, {
             "remix_outline": {
diff --git a/utils/icon_themes/lucide.json b/utils/icon_themes/lucide.json
@@ -0,0 +1,130 @@
+{
+    "alert_error": "shield-alert",
+    "alert_info": "info",
+    "alert_question": "message-circle-question-mark",
+    "alert_warn": "triangle-alert",
+
+    "cls_archive": "archive",
+    "cls_character": "users",
+    "cls_custom": "star",
+    "cls_entity": "university",
+    "cls_none": "square",
+    "cls_novel": "book",
+    "cls_object": "hammer",
+    "cls_plot": "hat-glasses",
+    "cls_template": "book-dashed",
+    "cls_timeline": "history",
+    "cls_trash": "trash-2",
+    "cls_world": "earth",
+
+    "prj_folder": "folder",
+    "prj_document": "file-text",
+    "prj_title": "file-text",
+    "prj_chapter": "file-text",
+    "prj_scene": "file-text",
+    "prj_note": "file-check",
+
+    "fmt_bold": "bold",
+    "fmt_italic": "italic",
+    "fmt_mark": "highlighter",
+    "fmt_strike": "strikethrough",
+    "fmt_subscript": "subscript",
+    "fmt_superscript": "superscript",
+    "fmt_underline": "underline",
+    "fmt_toolbar": "panel-left-dashed",
+
+    "search": "search",
+    "search_cancel": "x",
+    "search_case": "case-sensitive",
+    "search_loop": "repeat-2",
+    "search_preserve": "a-large-small",
+    "search_project": "book-search",
+    "search_regex": "regex",
+    "search_replace": "replace",
+    "search_word": "whole-word",
+
+    "bullet-off": "circle",
+    "bullet-on": "circle-check-big",
+    "unfold-hide": "chevron-right",
+    "unfold-show": "chevron-down",
+
+    "sb_build": "blocks",
+    "sb_details": "view",
+    "sb_novel": "book",
+    "sb_outline": "layout-list",
+    "sb_project": "folder-tree",
+    "sb_search": "book-search",
+    "sb_stats": "chart-bar-big",
+
+    "theme_light": "sun",
+    "theme_dark": "moon",
+    "theme_auto": "contrast",
+
+    "btn_ok": "circle-check-big",
+    "btn_cancel": "circle-slash",
+    "btn_yes": "circle-check-big",
+    "btn_no": "circle-minus",
+    "btn_open": "square-arrow-out-up-right",
+    "btn_close": "circle-x",
+    "btn_save": "save",
+    "btn_browse": "folder-open",
+    "btn_list": "list",
+    "btn_new": "circle-plus",
+    "btn_create": "sparkles",
+    "btn_reset": "rotate-ccw",
+    "btn_insert": "import",
+    "btn_apply": "square-check-big",
+    "btn_build": "blocks",
+    "btn_print": "printer",
+    "btn_preview": "eye",
+
+    "add": "plus",
+    "bookmarks": "bookmark",
+    "browse": "folder-open",
+    "build_settings": "file-cog",
+    "cancel": "circle-slash",
+    "checked": "circle-check-big",
+    "chevron_down": "arrow-down",
+    "chevron_left": "arrow-left",
+    "chevron_right": "arrow-right",
+    "chevron_up": "arrow-up",
+    "close": "x",
+    "copy": "copy",
+    "document_add": "file-plus-corner",
+    "document": "bookmark",
+    "edit": "pencil",
+    "exclude": "ban",
+    "export": "file-output",
+    "filter": "funnel",
+    "fit_height": "chevrons-up-down",
+    "fit_width": "chevrons-left-right",
+    "folder": "folder",
+    "font": "type",
+    "import": "file-input",
+    "language": "languages",
+    "lines": "list-ordered",
+    "list": "list",
+    "margin_bottom": "arrow-down-to-line",
+    "margin_left": "arrow-left-to-line",
+    "margin_right": "arrow-right-to-line",
+    "margin_top": "arrow-up-to-line",
+    "maximise": "expand",
+    "minimise": "minimize",
+    "more_arrow": "chevron-right",
+    "more_vertical": "ellipsis-vertical",
+    "noncheckable": "circle",
+    "panel": "panels-left-bottom",
+    "pin": "pin",
+    "project_copy": "book-copy",
+    "quote": "quote",
+    "refresh": "refresh-cw",
+    "remove": "minus",
+    "revert": "undo-2",
+    "settings": "settings",
+    "stats": "chart-area",
+    "text": "file-text",
+    "timer_off": "timer-off",
+    "timer": "timer",
+    "unchecked": "circle-x",
+    "view": "eye"
+}
diff --git a/utils/icon_themes/remix.json b/utils/icon_themes/remix.json
@@ -99,7 +99,7 @@
     "fit_height": "expand-height-line",
     "fit_width": "expand-width-line",
     "folder": "folder-6",
-    "font": "font-sans",
+    "font": "font-sans-serif",
     "import": "import",
     "language": "translate-2",
     "lines": "menu-2",
