Skip to content

Repository files navigation

可达鸭官方在线脚本库

FF14卫月可达鸭插件的官方在线库

如果你是脚本作者,那么可以直接通过提 pr 的方式,来让官方在线库收录你的脚本。

如何贡献

  1. Fork 本仓库。
  2. 仓库根目录新建以你的 GitHub 用户名命名的文件夹。
    • 例如 Karlin-Z/;用户名不区分大小写,建议完全一致
    • 如果是联合作者,则用 作者a & 作者b 的格式(带空格)
  3. .cs 文件放进去。一个 .cs 文件必须包含且只包含一处 [ScriptType(...)]
  4. main 分支提交 Pull Request。

自动审核:

  • 通过 → 自动 squash 合并,并重建索引;
  • 不通过 → 在 PR 下留言列出问题,不会合并,改好后重新推送即可。

每个 PR 只能改你自己文件夹里的 .cs

改别人的文件夹、.github/ 文件夹或根目录的文件,都会被拒绝。

脚本编写说明

脚本模板

  • SimpleScript.cs 是官方示例,可直接复制来改。

  • 复制时务必改掉 guidGUID生成器

[ScriptType(name: "M1s绘图", territorys: [1226], guid: "8010d865-7d6d-4c23-92e0-f4b0120e18ac",version: "0.0.0.9", author: "Karlin")]
public class M1s { }

ScriptType 参数

参数 类型 是否必填 说明
guid string 脚本唯一标识,不能与别人或自己的其它脚本重复
name string 建议 脚本名,缺省为 Default Script
territorys uint[] 建议 生效地图 ID,如 [1226];空数组或缺省表示不按地图过滤
version string 建议 版本号,缺省为 0.0.0.1;插件用 NuGetVersion 解析,0.0.1 / 0.0.0.9 / 1.0.0-beta 均可
author string 缺省、留空或写成 Unknown 时,自动使用你的文件夹名
note string 备注(鼠标悬停显示)
updateInfo string 更新说明

审核规则

阻塞合并的检查(必须全部通过):

  1. 改动路径的第一层文件夹必须等于 PR 作者的 GitHub 用户名;重命名时,改名前后两个路径都要满足。
  2. 只允许新增 / 修改 / 删除 .cs 文件。
  3. 每个 .cs 必须包含恰好一处 [ScriptType(...)](或 [ScriptTypeAttribute(...)]):
    • 一处都没有,或出现两处及以上 → 拒绝(注释、字符串里的写法不计入);
    • guid 必须是非空字符串;
    • version 必须是合法版本号;
    • territorys 必须是 0~4294967295 的整数数组,如 [1226, 1228]
    • name / author 必须能安全用作文件名(插件按 Name_Author.cs 保存下载的脚本), 不能含 / \ : * ? " < > |、控制字符、..,也不能是 CON / NUL 这类 Windows 保留名。
  4. guid 不能与已有脚本冲突:
    • 别人的脚本占用 → 拒绝;
    • 你自己文件夹里的另一个文件占用 → 拒绝;
    • 同一个 PR 里两个文件用了同一个 guid → 拒绝;
    • 重命名 / 移动自己的文件(guid 不变)→ 放行。
  5. 文件必须是合法 UTF-8;不允许符号链接、子模块;单文件不超过 2 MB;单个 PR 不超过 100 个文件。

只提醒、不阻塞的检查(会出现在 PR 评论里):

  • 没写 name / version / territorys,将使用插件默认值;
  • 没写 author 或写成 Unknown,改用文件夹名;
  • guid 不是标准 UUID 格式(插件按字符串处理仍可用,建议修正);
  • note / updateInfo 引用了本文件里找不到的 const,将按空字符串处理。

About

No description, website, or topics provided.

Resources

Stars

6 stars

Watchers

0 watching

Forks

Contributors

Languages