TwitchNoSub 项目使用教程

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

TwitchNoSub/
├── assets/
│   └── icons/
├── src/
├── tools/
├── userscript/
├── .gitignore
├── LICENSE
├── README.md
├── firefox-manifest.json
├── manifest.json
└── package.json

目录结构介绍

• assets/: 存放项目的图标资源。
  • icons/: 存放扩展程序的图标文件。
• src/: 存放项目的源代码文件。
• tools/: 存放项目使用的工具脚本。
• userscript/: 存放用户脚本文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• firefox-manifest.json: Firefox 浏览器的扩展配置文件。
• manifest.json: Chrome 等浏览器的扩展配置文件。
• package.json: 项目的依赖管理文件。

2. 项目的启动文件介绍

manifest.json

manifest.json 是 Chrome 扩展程序的核心配置文件，定义了扩展程序的基本信息、权限、启动文件等。以下是该文件的主要内容：

{
  "manifest_version": 2,
  "name": "TwitchNoSub",
  "version": "1.0",
  "description": "An extension to watch sub only VOD on Twitch",
  "permissions": [
    "https://*.twitch.tv/*"
  ],
  "background": {
    "scripts": ["background.js"]
  },
  "content_scripts": [
    {
      "matches": ["https://*.twitch.tv/*"],
      "js": ["content.js"]
    }
  ],
  "browser_action": {
    "default_popup": "popup.html"
  }
}

启动文件介绍

• background.js: 后台脚本文件，负责处理扩展程序的后台逻辑。
• content.js: 内容脚本文件，注入到 Twitch 页面中，处理页面内容。
• popup.html: 扩展程序的弹出窗口页面。

3. 项目的配置文件介绍

package.json

package.json 是 Node.js 项目的配置文件，定义了项目的依赖、脚本命令等。以下是该文件的主要内容：

{
  "name": "twitchnosub",
  "version": "1.0.0",
  "description": "An extension to watch sub only VOD on Twitch",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "Apache-2.0",
  "dependencies": {
    "some-dependency": "^1.0.0"
  }
}

配置文件介绍

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目的入口文件。
• scripts: 定义了项目的脚本命令，如测试命令 test。
• dependencies: 项目的依赖包列表。

通过以上内容，您可以了解 TwitchNoSub 项目的目录结构、启动文件和配置文件的基本信息。