LoonKissSurge 项目食用指南
项目网站:https://surge.qingr.moe
项目 Telegram 公告频道:https://t.me/LoonKissSurge
了解这个项目
这个项目的缘由是因为我在发现依赖于 Surge 本身的运行环境来进行 Loon 插件的转换时的连接情况较差,此时我选择尝试将这种高负载的工作转移到托管服务器,籍此降低 Surge 的负载来提高效能。在我尝试中我发现很多时候 Script-Hub 的运行是重复的,插件(仅针对我常用的去广告和工具类插件而言)的维护周期是较长的,但是Script-Hub本身的产品设计就决定了我们只能进行一次又一次徒劳的转换,所以我想尝试把常用的那些插件集合起来降低这些徒劳转换的资源浪费。
根据我自己的实践,我使用Surge很多的实际需求就是去广告,所以我选择根据目前维护最好、最全的 @iKelee 大佬的Loon 仓库作为我的转换目标,在 PR 实现 Script-Hub 的 Docker 版本支持和自动构建推送以后,便顺理成章的根据 Github Action 完成了这个项目的目标,这也是我起名为 LoonKissSurge 的原因。
但是出于多方面原因,这项目本身我曾经一度考虑删除,因为他提供的转换支持在一定程度上给某些开发者带来了麻烦,尤其是版权和遵守原分发要求方面是很难做到完全合规的,最后我也要感谢 @xream 一佬以及各位在开源世界给 Surge 环境资源做出贡献的前辈开发者们的精神让这项目走向了更大的目标。
目前项目开源的代码仅包括 自构建 surge.qingr.moe 的TS代码,这些代码感谢 @SukkaW 大佬无私的奉献提供了我所参考的源头,顾依照原许可证开源并保留原许可证分发。另外一点说来惭愧,我承诺更改为自有 CSS 样式已经许久,但是因为个人时间安排未能实际动笔,如果有这方面大佬愿意提供 CSS 的 PR 我十分感激。对于自动同步上游的代码出于多方面考虑我撤销了开源实现,这些原因非常多样化请恕我向想要了解他的朋友致歉,但是我可以透露 Script-Hub 是其基石,请允许我在此对 @xream 佬在此表达感谢,如果您愿意更近一步获取实现细节可以提供您可以参与维护的承诺后获取源代码。
凭水一言
做这些事情的初心:
请我自己不要成为一只'吸取帮助的吸血鬼(help vampire)'
建议实践
1、如果您了解了基本的 Surge 使用知识以后,便可以很快速的上手本项目:只需打开 项目网站 然后点击 Surge 图标即可作为远程模块添加到 Surge 中,无需任何前置支持即可食用。
2、如果您了解大部分使用知识并且阅读了 Surge 手册以及 理解 Surge 以后,一种更为推荐的办法是点击 Script-Hub 图标作为本地模块导入 Surge ,这给您修改一部分过时或者欠缺维护的部分提供了更多的可能,当然他需要一定的知识基础和必要的辅助工具来完成(本地模块 需配合 Scriptable + Script Hub 的 Surge 模块工具)。
3、寻找本模块的上游,在服务器自部署您私人的 Script-Hub 然后使用您趁手的方式来食用这些模块,本方法适合理解 Surge 底层原理和诸多特性的高级使用者,为您提供更及时和更自如的食用感受。
重要分支
Beta 文件夹其下模块提供了最新 Surge 特性的支持,此后该文件夹下文件将在转换时优先满足 Surge 最新功能,目前满足的订阅功能为 JQ 修改支持。
对于维护中的正常模块,他们将不会开启破坏性的订阅功能支持(指的是例如 Pre-match 在不支持的版本被过滤的特性会添加,但是 JQ 重写支持这种导致未订阅 Surge 便不可使用的不会被添加),这些 Beta 组专属测试属性将在半年后合并到主维护模块区,这意味着对于这些订阅功能支持您有半年空窗期可以考虑来择机维持 Surge 的订阅。
项目网站:https://surge.qingr.moe
项目 Telegram 公告频道:https://t.me/LoonKissSurge
了解这个项目
这个项目的缘由是因为我在发现依赖于 Surge 本身的运行环境来进行 Loon 插件的转换时的连接情况较差,此时我选择尝试将这种高负载的工作转移到托管服务器,籍此降低 Surge 的负载来提高效能。在我尝试中我发现很多时候 Script-Hub 的运行是重复的,插件(仅针对我常用的去广告和工具类插件而言)的维护周期是较长的,但是Script-Hub本身的产品设计就决定了我们只能进行一次又一次徒劳的转换,所以我想尝试把常用的那些插件集合起来降低这些徒劳转换的资源浪费。
根据我自己的实践,我使用Surge很多的实际需求就是去广告,所以我选择根据目前维护最好、最全的 @iKelee 大佬的Loon 仓库作为我的转换目标,在 PR 实现 Script-Hub 的 Docker 版本支持和自动构建推送以后,便顺理成章的根据 Github Action 完成了这个项目的目标,这也是我起名为 LoonKissSurge 的原因。
但是出于多方面原因,这项目本身我曾经一度考虑删除,因为他提供的转换支持在一定程度上给某些开发者带来了麻烦,尤其是版权和遵守原分发要求方面是很难做到完全合规的,最后我也要感谢 @xream 一佬以及各位在开源世界给 Surge 环境资源做出贡献的前辈开发者们的精神让这项目走向了更大的目标。
目前项目开源的代码仅包括 自构建 surge.qingr.moe 的TS代码,这些代码感谢 @SukkaW 大佬无私的奉献提供了我所参考的源头,顾依照原许可证开源并保留原许可证分发。另外一点说来惭愧,我承诺更改为自有 CSS 样式已经许久,但是因为个人时间安排未能实际动笔,如果有这方面大佬愿意提供 CSS 的 PR 我十分感激。对于自动同步上游的代码出于多方面考虑我撤销了开源实现,这些原因非常多样化请恕我向想要了解他的朋友致歉,但是我可以透露 Script-Hub 是其基石,请允许我在此对 @xream 佬在此表达感谢,如果您愿意更近一步获取实现细节可以提供您可以参与维护的承诺后获取源代码。
凭水一言
做这些事情的初心:
Life is a two-way street
请我自己不要成为一只'吸取帮助的吸血鬼(help vampire)'
建议实践
1、如果您了解了基本的 Surge 使用知识以后,便可以很快速的上手本项目:只需打开 项目网站 然后点击 Surge 图标即可作为远程模块添加到 Surge 中,无需任何前置支持即可食用。
2、如果您了解大部分使用知识并且阅读了 Surge 手册以及 理解 Surge 以后,一种更为推荐的办法是点击 Script-Hub 图标作为本地模块导入 Surge ,这给您修改一部分过时或者欠缺维护的部分提供了更多的可能,当然他需要一定的知识基础和必要的辅助工具来完成(本地模块 需配合 Scriptable + Script Hub 的 Surge 模块工具)。
3、寻找本模块的上游,在服务器自部署您私人的 Script-Hub 然后使用您趁手的方式来食用这些模块,本方法适合理解 Surge 底层原理和诸多特性的高级使用者,为您提供更及时和更自如的食用感受。
重要分支
Beta 文件夹其下模块提供了最新 Surge 特性的支持,此后该文件夹下文件将在转换时优先满足 Surge 最新功能,目前满足的订阅功能为 JQ 修改支持。
对于维护中的正常模块,他们将不会开启破坏性的订阅功能支持(指的是例如 Pre-match 在不支持的版本被过滤的特性会添加,但是 JQ 重写支持这种导致未订阅 Surge 便不可使用的不会被添加),这些 Beta 组专属测试属性将在半年后合并到主维护模块区,这意味着对于这些订阅功能支持您有半年空窗期可以考虑来择机维持 Surge 的订阅。