List-KR 开源项目使用手册
1. 项目目录结构及介绍
List-KR 是一个专注于韩国网站广告过滤的开源项目,它提供了高级的用户脚本和过滤规则,适用于AdGuard和uBlock Origin等广告拦截器。以下是该仓库的基本目录结构概述:
- README.md: 项目的主要说明文件,介绍了项目的目的、支持的功能以及如何添加到广告拦截器中。
- List-KR: 包含核心过滤列表的主目录,可能包含多个
.txt
或相关配置文件用于不同类型的广告过滤。 - microShield: 用户脚本项目,专门用来阻止Ad-Shield广告及其防广告屏蔽机制。
microShield.ts
: 主要的TypeScript代码文件。- 可能还有其他相关配置和资源文件。
- NamuLink: 针对NamuWiki上特定广告(PowerLink)的用户脚本。
NamuLink.ts
: 类似地,这个文件包含了处理NamuWiki广告逻辑的TypeScript代码。
- 社区相关: 如有,可能包含社区维护的部分,如JavaScript编写的其他辅助工具或文档。
- 其它: 可能包括一些解析器、测试文件、文档说明等。
每个子目录通常含有各自的说明文件或Readme,以提供关于其内部组件的详细信息。
2. 项目的启动文件介绍
由于List-KR主要是基于文本的过滤规则集合和用户脚本,没有传统的“启动文件”概念。对于广告过滤列表的使用,用户不需要直接“启动”项目。相反,应用这些规则到你的广告拦截插件中即可生效,具体操作是访问插件设置,导入对应的过滤规则列表地址或者安装用户脚本至浏览器。
对于microShield和NamuLink这类用户脚本,启动过程涉及在浏览器中安装Tampermonkey或其他用户脚本管理扩展,然后从项目的GitHub页面安装脚本。
3. 项目的配置文件介绍
核心过滤列表配置
- 无需直接配置: 对于直接使用的过滤列表,如
List-KR
提供的.txt文件,用户通常是通过广告拦截器的界面进行管理和更新,无需手动编辑这些文件。
用户脚本配置
- microShield, NamuLink: 这些项目作为用户脚本,其配置主要在脚本本身(
.ts
文件)中定义,并且它们的运行依赖于用户脚本管理器的设定。一般情况下,用户可以通过用户脚本管理器提供的界面来控制是否启用脚本,但具体的配置选项通常被编码在脚本内部,不提供外部配置文件让用户直接修改。
总之,List-KR项目侧重于提供即用型的过滤规则和用户脚本,它的“配置”更多体现在用户如何将其集成到自己的浏览环境中,而非传统意义上的程序配置文件。