# WingHexPyScript

**Repository Path**: wing-cloud/WingHexPyScript

## Basic Information

- **Project Name**: WingHexPyScript
- **Description**: 羽云十六进制编辑器的脚本仓库
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-08-01
- **Last Updated**: 2022-09-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## WingHexPyScript

  为了更好的建设“羽云十六进制编辑器”的脚本支持生态，本仓库用来存储实用的脚本，欢迎大家前来 PR ！

## 授权协议

  由于是脚本收集仓库，故本仓库无法决定遵守哪个协议，仓库中的每一个脚本的代码协议归作者决定。在使用脚本前请知情脚本所遵守的开源协议，一旦你使用该脚本，就默许了它的开源许可。

## 使用

  在使用脚本的时候，我建议你安装`git`，这一般`Linux`系统都自带着，你可以在终端打开输入如下指令检查一下：

```bash
git --version
```

  如果输出类似下面的信息，就说明安装好了：

```bash
git version 2.20.1
```

  在该插件安装目录下，也就是`/opt/WingHexExplorer/plugin`，输入如下指令：

```bash
git clone https://gitee.com/wing-cloud/WingHexPyScript
```

  只需重启羽云十六进制编辑器就可以使用了。

  为了方便大家更新仓库内的所有脚本，我写了一个`update.sh`文件，只需运行它就可以将脚本更新到最新，前提你得安装`git`。

## 开发基础知识

  会使用 Python 编写脚本且具有 Qt 文本、表格、列表、树状列表组件使用基础，并且知道“羽云十六进制编辑器”的插件机制以及脚本接口。

  对于 Python ，推荐菜鸟教程：[学习传送门](https://www.runoob.com/python/python-intro.html) 。

  对于 Qt ，建议直接搜 `QTextBrowser`/`QTableWidget`/`QListWidget`/`QTreeWidget`，找到官方文档即可。

  对于剩下的，请参考 Wiki ：[学习传送门](https://code.gitlink.org.cn/wingsummer/WingHexPy/wiki/%E6%95%99%E7%A8%8B) 。

## 脚本递交规范

  我通过举个例子的方式来说明。我自己写了一个脚本，名字叫`hello.py`，里面代码 balabala ……

  然后我需要克隆该仓库，然后到该文件夹下，找一找有没有名字为`World`的文件夹，因为我想把我的脚本放到该分类下。没有，好新建一个。由于我的脚本叫`hello.py`，我需要新建一个`hello`的文件夹。 **注意脚本名称一定要和这个新建的文件夹保持一致，否则 PR 不予通过。**

  新建完`hello`文件夹之后，放进入`hello.py`。到这步骤还没有完成，你需要编写注册文件，用来让插件系统识别你的脚本，与此同时也可以加点私货 (bushi) 。具体编写还是要参考 Wiki ：[学习传送门](https://code.gitlink.org.cn/wingsummer/WingHexPy/wiki/%E6%95%99%E7%A8%8B) 。

  然后我又 balabala 写了`hello.json`文件：

```json
{
  "author": "wingsummer", 
  "license": "GPL", 
  "commnet": "A useful script!", 
  "version": 1
}
```

  写好后，把它保存放到文件夹下，就可以向该仓库进行 PR 啦！

## 注意事项

  在编写脚本的时候注意我也同时写脚本进行测试，往 WingHexPy 添加新的接口以增加脚本编写体验。如果你是开发者请关注该仓库动态。

## 相关仓库

- Gitee : https://gitee.com/wing-cloud/WingHexPyScript
- Gitea : https://code.gitlink.org.cn/wingsummer/WingHexPyScript