ShellTile 项目教程

2024-09-01 15:43:49作者：秋泉律Samson

1. 项目的目录结构及介绍

ShellTile 是一个用于 GNOME Shell 的平铺窗口扩展。以下是项目的目录结构及其介绍：

shelltile/
├── AUTHORS
├── COPYING
├── README.md
├── metadata.json
├── prefs.js
├── shelltile@emasab.it
│   ├── extension.js
│   ├── metadata.json
│   ├── stylesheet.css
│   └── utils.js
└── screenshot.png

AUTHORS: 项目作者信息。
COPYING: 项目许可证信息，遵循 GPL-2.0 许可证。
README.md: 项目说明文档。
metadata.json: 扩展的元数据文件，包含扩展的基本信息。
prefs.js: 扩展的首选项设置文件。
shelltile@emasab.it: 扩展的主要文件夹。
- extension.js: 扩展的主脚本文件。
- metadata.json: 扩展的元数据文件。
- stylesheet.css: 扩展的样式表文件。
- utils.js: 扩展的工具函数文件。
screenshot.png: 扩展的截图文件。

2. 项目的启动文件介绍

ShellTile 扩展的启动文件是 extension.js，它位于 shelltile@emasab.it 目录下。该文件包含了扩展的主要逻辑和功能实现。以下是 extension.js 的主要内容介绍：

const { Gio, GLib, Meta, Shell } = imports.gi;
const ExtensionUtils = imports.misc.extensionUtils;
const Me = ExtensionUtils.getCurrentExtension();
const Utils = Me.imports.utils;

class Extension {
    constructor() {
        this._settings = ExtensionUtils.getSettings('org.gnome.shell.extensions.shelltile');
    }

    enable() {
        // 启用扩展时的逻辑
    }

    disable() {
        // 禁用扩展时的逻辑
    }
}

function init() {
    return new Extension();
}

init(): 初始化函数，返回一个新的 Extension 实例。
Extension 类：包含扩展的主要逻辑，包括启用 (enable()) 和禁用 (disable()) 扩展时的操作。

3. 项目的配置文件介绍

ShellTile 扩展的配置文件是 metadata.json，它位于 shelltile@emasab.it 目录下。该文件包含了扩展的基本信息和配置选项。以下是 metadata.json 的内容介绍：

{
    "name": "ShellTile",
    "description": "A tiling window extension for GNOME Shell",
    "uuid": "shelltile@emasab.it",
    "shell-version": [
        "3.36",
        "3.38",
        "40",
        "41",
        "42",
        "43"
    ],
    "version": 12,
    "url": "https://github.com/emasab/shelltile"
}

name: 扩展的名称。
description: 扩展的描述。
uuid: 扩展的唯一标识符。
shell-version: 支持的 GNOME Shell 版本。
version: 扩展的版本号。
url: 扩展的官方链接。

以上是 ShellTile 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用 ShellTile 扩展。