Differences

This shows you the differences between two versions of the page.

--- gnome:extensions:create_an_extension [2022/07/23 09:58] – created 194.32.120.110
+++ gnome:extensions:create_an_extension [2022/07/23 12:39] (current) – [Complete Extension Zip File Layout] 194.32.120.105
@@ Line 1: / Line 1: @@
 ====== Gnome - Extensions - Create an Extension ======
-[[Gnome:Extensions:Create an Extension|Create an Extension]]
+===== Creating the files for an extension =====
+Extensions only require two mandatory files, so create them:
+  * [[Gnome:Extensions:extension.js|extension.js]]
+  * [[Gnome:Extensions:metadata.json|metadata.json]]
+Optionally create additional files:
+  * See [[Gnome:Extensions:prefs.js|prefs.js]]
+----
+===== Distributing an Extension =====
+Extensions are distributed as Zip files with the two required files:
+<code bash>
+example@blah.zip
+    extension.js
+    metadata.json
+</code>
+----
+==== Complete Extension Zip File Layout ====
+If additional optional files were also used in the extension, then the zip extension usually looks like this:
+<code bash>
+example@blah.zip
+    locale/
+        de/
+          LC_MESSAGES/
+              example.mo
+    schemas/
+        gschemas.compiled
+        org.gnome.shell.extensions.example.gschema.xml
+    extension.js
+    metadata.json
+    prefs.js
+    stylesheet.css
+</code>
+<WRAP info>
+**NOTE:**
+  * The topic of GSettings and the schemas/ directory is explained on the [[https://gjs.guide/extensions/development/preferences.html|Preferences]] page.
+  * The topic of Gettext and the locale/ directory is explained on the [[https://gjs.guide/extensions/development/translations.html|Translations]] page
+</WRAP>
+----
+===== Installation of an extension =====
+Extension are installed in one of two places.
+For User Extensions,
+<code bash>
+~/.local/share/gnome-shell/extensions/example@blah/
+</code>
+For System Extensions,
+<code bash>
+/usr/share/gnome-shell/extensions/example@blah/
+</code>
+----
+===== References =====
+http://smasue.github.io/gnome-shell-tw
+https://gjs.guide/extensions/overview/anatomy.html#metadata-json-required