NPP 开发快速上手指南 ​

插件开发规范 ​

nitaiPage 给开发者的自由度很高，Npp 几乎可以做常规 JS 文件能做的任何事情，但请遵守以下规范：

1. 在执行敏感操作(包括但不限于收集信息、修改页面元素、发送网络请求等)时，务必将行为告知用户，做好相关日志记录，避免对用户的数据造成风险
2. NPP 内容应遵守法律法规
3. 由 NPP 导致的问题应由 NPP 开发者承担，与 nitaiPage 及 nitaiPage 作者无关
4. NPP 相关 API 可能变动，请关注此文档
5. NPP 相关最终解释权归 nitaiPage 作者 所有

开发环境 ​

1. 文本编辑器
2. 浏览器

创建插件 ​

创建插件文件 ​

创建一个新的 JavaScript 文件（例如 myFirstNpp.js），并添加以下基本结构：

// ==Npplication==
// @name 第一个插件
// @id 1000000000000_xxxxxxxx-0000-0000-0000-0x0x0x0x0x0x
// @version 1.0.0
// ==/Npplication==

console.log('hello world!');

// 函数
function myFirstNppFunction() {
    alert('hello world!');
}

// 事件监听
document.addEventListener('DOMContentLoaded', function() {
    // 页面加载完成后执行
    console.log('页面已加载');
    myFirstNppFunction();
});

关于元数据 ​

MetaData 详解

测试 ​

1. 开启文件服务器，获取 JS 文件 URL (注意跨域(CORS)问题)
2. 开启 NitaiPage 浏览器控制台
3. 执行 installNpplication(JSUrl) 安装插件

发布插件 ​

1. 将插件代码上传到可公开访问的服务器 (注意跨域(CORS)问题)
2. 确保插件文件可以通过 HTTP/HTTPS 访问
3. 在 Npplication 商店源 中添加插件信息

常见问题 ​

Q: 插件无法加载怎么办？ ​

A: 检查浏览器控制台是否有错误信息，确保插件元数据格式正确，依赖项已安装。

Q: 如何更新插件？ ​

A: 更新插件文件并增加版本号，nitaiPage 会自动检测更新。 A: 或者再次在控制台执行 installNpplication(JSUrl) 覆盖安装插件