Scratch Addons 开源项目安装与使用教程

Scratch Addons 开源项目安装与使用教程

ScratchAddons All-in-one browser extension for Scratch. 项目地址: https://gitcode.com/gh_mirrors/sc/ScratchAddons

---

1. 项目目录结构及介绍

ScratchAddons 是一个专为 Scratch 平台设计的一站式浏览器扩展程序，旨在通过JavaScript和CSS增强网站和项目编辑器的功能与主题定制。下面是其主要目录结构及其简介：

• _locales: 包含扩展程序自身的多语言翻译字符串。
• addon-api: 实现了供用户脚本使用的JavaScript API。
• addons: 每个插件都有自己的目录，包括必需的addon.json清单文件，定义了插件的功能和设置。
• background: 扩展程序的背景脚本，处理非界面相关的任务。
• content-scripts: 内容脚本，用于在网页上执行用户脚本和注入样式表。
• images: 存放图标、截图等图像资源（不包含插件特定图片）。
• libraries: 第三方库和其他工具，可能被插件使用。
• popups: 只可通过扩展弹出窗口访问的插件页面。
• webpages: 包括设置页面、扩展弹出窗口等内容页面。
• .editorconfig, .gitattributes, .gitignore, prettierrc, LICENSE, README.md: 开发配置和项目文档。
• manifest.json: 浏览器扩展的主清单文件，定义扩展的基本信息和权限。

2. 项目的启动文件介绍

在ScratchAddons项目中，并没有传统意义上的“启动文件”，因为这是一个浏览器扩展，它的运行依赖于浏览器环境。然而，关键的入口点可以认为是：

• manifest.json：此文件是任何Chrome或Firefox扩展的核心，它指定扩展的名称、版本、所需权限、背景脚本、图标等基本信息。加载并初始化扩展时，浏览器首先读取这个文件。

• 在content-scripts和background目录中的脚本：这些脚本在适当的上下文（如访问特定网站时）自动启动，负责扩展功能的实际实现。

3. 项目的配置文件介绍

主要配置文件：manifest.json

• 说明：这是浏览器扩展的关键配置文件，包含了扩展的元数据（如名称、描述）、必要的权限声明、脚本文件路径、图标等。
• 重要字段示例：
  • "name" 和 "description"：定义扩展的名称和简短描述。
  • "version"：当前扩展的版本号。
  • "permissions"：列出扩展所需的浏览器权限。
  • "browser_action" 或 "page_action"：定义扩展按钮的行为。
  • "content_scripts"：指定了哪些脚本在何时注入到哪些URL。

插件配置：每个插件下的addon.json

• 说明：在每个插件目录中，addon.json文件是该插件的配置文件，它定义了用户脚本和样式表的注入条件、插件的描述、设置选项等。
• 关键属性：
  • "script" 或 "style"：关联的用户脚本或CSS文件。
  • "matches"：指定脚本或样式应在哪个URL模式下激活。
  • "description"：插件功能的简述。
  • 其他自定义键值对，用于存储插件特有配置。

安装与调试步骤：

由于直接启动不是典型过程，以下是获取和测试该项目的流程：

1. 使用Git克隆仓库：git clone https://github.com/ScratchAddons/ScratchAddons.git。
2. 对于开发与调试，在Chrome浏览器中，前往chrome://extensions页面，启用开发者模式。
3. 点击“加载已解压的扩展程序”，选择ScratchAddons目录进行加载。
4. 若要进行Firefox的临时测试，前往about:debugging，点击“此Firefox”标签，选择“临时载入扩展程序”，并选取manifest.json文件。

请注意，具体到实际的开发工作，还需参考项目的CONTRIBUTING.md和在线文档，以确保遵循正确的开发流程和编码规范。

ScratchAddons All-in-one browser extension for Scratch. 项目地址: https://gitcode.com/gh_mirrors/sc/ScratchAddons