# HikerDepotRules

**Repository Path**: reborn0/HikerDepotRules

## Basic Information

- **Project Name**: HikerDepotRules
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-27
- **Last Updated**: 2021-02-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HikerRules

感谢 [https://github.com/mabDc/eso_source](https://github.com/mabDc/eso_source) 的合并脚本和 Github action 提供了很大的参考。

（其实顺手修复了一下合并脚本第一个JSON对象会重复出现的问题）

# 仓库规则（README也抄了🙈️）
[manifest.json](https://raw.githubusercontent.com/RebornQ/HikerDepotRules/master/manifest.json) 是合并后的规则，链接：

`https://raw.githubusercontent.com/RebornQ/HikerDepotRules/master/manifest.json`

网络问题可以使用[jsdelivr cdn](https://www.jsdelivr.com/?docs=gh)，即[manifest.json from jsdelivr](https://cdn.jsdelivr.net/gh/RebornQ/HikerDepotRules/manifest.json)，链接：

`https://cdn.jsdelivr.net/gh/RebornQ/HikerDepotRules/manifest.json`

或

`https://raw.staticdn.net/RebornQ/HikerDepotRules/master/manifest.json`

> jsdelivr 加 @latest 这种方法并不能拿到最新的内容，它是根据url缓存的。具体说明的链接在这里 [利用jsDelivr白嫖全球超高速静态资源访问服务！](https://www.bilibili.com/read/cv4297993/)

# 仓库开发者使用说明
## 初步使用
1. 首先，你需要 fork 这个项目，然后把我的规则 rules/xxx.json 全删掉（Github没有文件夹删除选项只有一个文件一个文件删所以只能自己想办法啰~）；
2. 申请一个 github access token，然后点击项目的`Settings-Secrets-New Secret`；填完信息然后`Add`；
    - `name`必须填`ACCESS_TOKEN`
    - `value`填刚刚申请到的 access token
3. 初次使用需要先点一次上面的 Github Actions 为项目开启该功能；
4. 进入 rules 目录添加`{规则名}.json`文件开始填自己的规则吧，**一个文件只能一个规则噢**~

> 文件说明：
> - xxx.json: 单个规则文件
> - notice.json: 仓库通知
>
> **注意：除了上面两种文件其他的都不能动**

## 进阶
### 分类仓库开发者使用说明
大家可以先看看我的模板目录结构：[https://github.com/RebornQ/HikerDepotRules/tree/master/classes/noSniffer](https://github.com/RebornQ/HikerDepotRules/tree/master/classes/noSniffer)

文件说明与初步使用的一样，同样自己删除我的规则。

新建的分类仓库**只需要**有 "xxx.json" 和 "notice.json" **两种文件**即可，其他的文件会都自动生成。

但是**有一点不同的是要改一个文件**：`项目根目录/.github/workflows/main.yml`；

下面说说怎么改：
1. 在这个文件中搜索`# Runs merge`，找到下面的run结点，删掉我的分类仓库规则：

   ```bash
   bash merge_classes.sh ./classes/noSniffer/ $home
   ```
2. 每添加一个**大分类**都要在这个结点下添加以下代码：

   ```shell
   bash merge_classes.sh ./{你的大分类目录路径} $home
   ```

   **合并后的规则在每个大分类目录下的 manifest_{小分类名}.json 文件**

   > 解释一下什么叫大分类：
   >
   > 举例我的目录 "./classes/noSniffer/":
   > - classes 就是 分类 的意思
   > - 大分类 是指 noSniffer (免嗅)
   > - 其中有很多 小分类 { anime video video_short } 分别代表 { 动漫 影视 短视频 }<br><br>
   >
   > PS：不一定要分很多个大分类，也可以把所有小分类丢到一个文件夹，这个文件夹就是所有小分类的大分类
   >
   > 即大分类目录结构要满足：
   > ```bash
   > .
   > └── 大分类
   >     ├── 小分类1
   >     │   ├── notice.json
   >     │   ├── 规则1.json
   >     │   └── 规则2.json
   >     └── 小分类2
   >     │   ├── notice.json
   >     │   ├── 规则1.json
   >     │   └── 规则2.json
   >     └── ...
   > ```

完成这些配置之后，在分类中添加 "{规则名}.json" 和 "notice.json" 通知文件开始填自己的规则吧，**一个JSON文件只能一个规则噢**~

### 强制刷新 JsDeliver CDN 缓存

访问该链接 [https://purge.jsdelivr.net/gh/RebornQ/HikerDepotRules/manifest.json](https://purge.jsdelivr.net/gh/RebornQ/HikerDepotRules/manifest.json) 即可刷新，自行替换用户名、仓库以及文件名

> 如果你等不及，那就可以考虑一下😂️

### 同步仓库到码云 gitee（可选）

> 嫌 CDN 刷新慢的可以考虑这个方案，但是配置有点复杂

有点懒，先看着这个链接的教程吧，要配置的东西是一样的😂️

教程链接：[https://gyx8899.gitbook.io/blog/share/syncgithubtogitee](https://gyx8899.gitbook.io/blog/share/syncgithubtogitee)