├── i18n └── zh-CN.json ├── kcps-terminal.css ├── package.json ├── .gitignore ├── README.md ├── index.es └── LICENSE /i18n/zh-CN.json: -------------------------------------------------------------------------------- 1 | { 2 | "A poi plugin for KCPS kai": "《舰队收藏 肝帝模拟 改》的poi浏览器插件", 3 | "Providing control & data support for KCPS kai": "为《舰队收藏 肝帝模拟 改》提供控制与数据支持", 4 | "KCPS Termianl": "KCPS终端", 5 | "Port": "端口", 6 | "Token": "口令", 7 | "Zoom": "缩放", 8 | "JPEG Quality": "JPEG质量", 9 | "Please make sure you started poi with a special modification ": "请确保已经按", 10 | "listed here": "此处给出的特殊步骤", 11 | ", otherwise mouse input simulation will fail.": "启动poi，否则无法实现鼠标模拟操作。" 12 | } -------------------------------------------------------------------------------- /kcps-terminal.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --kcps-terminal-blue: #2196F3; 3 | --kcps-terminal-grey: #aaa; 4 | } 5 | 6 | 7 | #kcps-terminal { 8 | padding: 1ex 1em; 9 | } 10 | 11 | #kcps-terminal * { 12 | outline: none; 13 | } 14 | 15 | #kcps-terminal.kcps-terminal-wrapper { 16 | display: flex; 17 | } 18 | 19 | #kcps-terminal.kcps-terminal-wrapper >div { 20 | flex-grow: 1; 21 | } 22 | 23 | 24 | #kcps-terminal input { 25 | padding-top: 0; 26 | padding-bottom: 0; 27 | } 28 | 29 | #kcps-terminal .inplace-edit, 30 | #kcps-terminal .inplace-edit-active { 31 | background: none; 32 | border: none; 33 | border-bottom: 2px solid var(--kcps-terminal-blue); 34 | width: 3em; 35 | line-height: 120%; 36 | display: inline-block; 37 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "poi-plugin-kcps-terminal", 3 | "version": "1.4.7", 4 | "description": "A poi plugin for KCPS kai", 5 | "main": "index.es", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/KanaHayama/poi-plugin-kcps-terminal.git" 12 | }, 13 | "keywords": [ 14 | "data", 15 | "server", 16 | "kcps" 17 | ], 18 | "author": "Kana", 19 | "license": "GPLv3", 20 | "bugs": { 21 | "url": "https://github.com/KanaHayama/poi-plugin-kcps-terminal/issues" 22 | }, 23 | "homepage": "https://github.com/KanaHayama/poi-plugin-kcps-terminal#readme", 24 | "poiPlugin": { 25 | "title": "KCPS Termianl", 26 | "description": "Providing control & data support for KCPS kai", 27 | "icon": "fa/server", 28 | "priority": 66 29 | }, 30 | "dependencies": { 31 | "react-edit-inplace": "^1.1.1" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # poi-plugin-kcps-terminal 2 | 3 | [主页](http://kcps.info) 4 | 5 | ## 介绍 6 | 7 | 这是为 KancollePlayerSimulator Kai/Evol （以下简称KCPS）提供支持的poi浏览器插件。 8 | 9 | 安装方法见下方**安装**一节。 10 | 11 | 它启动一个http服务器，客户端（KCPS）使用Get方法配合参数获取需要的数据。 12 | 13 | （这个仓库只与该插件相关，讨论KCPS的内容请至[KCPS的仓库](http://github.com/KanaHayama/KanCollePlayerSimulator)） 14 | 15 | 提供支持的接口包括： 16 | 17 | + 鼠标动作 18 | + 截取画面 19 | + 刷新页面 20 | + 获取数据 21 | 22 | 考虑到KCPS的目标不只是在poi浏览器上使用，因此保持较少的通用接口且（尽量）不特定于浏览器的返回内容是有必要的。 23 | 24 | 可供修改的选项： 25 | 26 | + 端口 27 | 28 | http服务器监听端口，用于与脚本本体通信。 29 | 30 | + 口令 31 | 32 | 简易的认证机制。原理简单，便于移植。明文通信，虽不能防止中间人窃听，但可以给非要在公网计算机上运行插件的人一种保护机制。 33 | 34 | + 缩放 35 | 36 | 返回画面相对于游戏默认画面大小(1200×720)的比例。传输前会按这个比例将截图缩放，因此影响画面质量的首先是浏览器自身的画面大小。这会影响传输带宽、判断的准确性。这里以默认画面大小为标准的好处是在随意改变窗口大小时返回的图片分辨率也是固定的（实际上KCPS不要求返回的画面大小固定）。 37 | 38 | + JPEG质量 39 | 40 | 设置返回JPEG格式图片的质量。这会影响CPU占用、传输带宽、判断的准确性。 41 | 42 | 因为这些不属于与KCPS通信的接口的定义，因此不影响移植。 43 | 44 | ## 已知问题 45 | 46 | + poi不可以最小化 47 | 48 | 最小化后游戏画面会停止渲染，无法正常获取图像。最小化不可以，但被其他应用遮挡是可以的。 49 | 50 | + poi分离模式下截图服务器会卡住 51 | 52 | 这个是玄学问题，我没有JS开发经验，解决不了，据说可能是remote导致的。 53 | 54 | + 系统显示设置开启HDR后无法截图 55 | 56 | 开启HDR后，截图会变得一片黑。脚本就不能用了。不知道是哪里的问题。 57 | 58 | + 界面简陋 59 | 60 | 那个口令输入框在没有口令时难以选中，需要点好多下。 61 | 62 | ## 安装 63 | 64 | 在poi浏览器“扩展程序”设置中输入本插件包名`poi-plugin-kcps-terminal`点“安装”就可以了。 65 | 66 | 安装（以及禁用后再启用插件）后必须**刷新游戏**，以让插件获得游戏api数据。 67 | 68 | 安装后使用任意网页浏览器访问[localhost:5277/capture](http://localhost:5277/capture)，这时可以看到游戏的截图，说明插件运行正常。 69 | 70 | ### poi 10.7.0 的额外操作（poi 10.8.0 中已修复该问题，所以不再需要此处的步骤） 71 | 72 | 请按以下步骤修改用于启动poi浏览器的快捷方式（不建议修改开始菜单中的那个快捷方式；原因是，poi不知道为什么，每次启动都要重写开始菜单的快捷方式，所以你如果改了那个快捷方式就是白改了；比如可以在桌面上新建一个快捷方式再改）： 73 | + 打开poi快捷方式所在文件夹。 74 | + 打开poi快捷方式的“属性”窗口（右键单击，选择“属性”）。 75 | + 修改`目标(T):`，在原有内容的末尾添加内容` --disable-site-isolation-trials --disable-features=CalculateNativeWinOcclusion`（比如，将`“C:\Program Files\poi\poi.exe”`改为`"C:\Program Files\poi\poi.exe" --disable-site-isolation-trials --disable-features=CalculateNativeWinOcclusion`，注意`"`和`--`之间有空格）。 76 | + 点击“确定”保存修改。 77 | + 在此之后请始终使用此快捷方式启动poi。 78 | 79 | 不进行此修改会导致KCPS无法执行鼠标动作而后报错多次点击失败（10.7之前版本的poi默认自带这个修改，所以该问题仅在10.7版开始出现）。 80 | 81 | ## 开发 82 | 83 | 我在这之前几乎从没接触过Web开发，JavaScript更是过去尝试去学了几次都失败了。 84 | 85 | 这么几行代码也要捣鼓几天才做出个基本的样子。 86 | 87 | Github其实我也不是很会用。 88 | 89 | 要干的事还不少…… 90 | 91 | 欢迎有兴趣的朋友在此基础上继续开发。 92 | 93 | *因发现同行抄袭还不公开源代码，许可变更为GPL，以从道义上避免后续再出现该类状况* 94 | 95 | ## 更新记录 96 | 97 | 1.4.7 98 | + 尝试定位有些用户用10.6版以上poi时获取数据时报错传入undefined的问题。 99 | 100 | 1.4.5 & 1.4.6 101 | + 适配poi 10.7.0 102 | 103 | 1.4.3 & 1.4.4 104 | + 修复不能正确记录基地航空队任务变更的Bug 105 | 106 | 1.4.2 107 | + 移除了WinAPI功能 108 | 109 | 1.4.1 110 | + 适配electron 8.3.0 111 | 112 | 1.4.0 113 | + 适配poi10.5中新版electron的新截图API，同时兼容旧版poi 114 | + 支持新旧最多两种winapi鼠标操作本机代码库 115 | 116 | 1.3.2 117 | + 适配electron 6.1.5 118 | 119 | 1.3.0~1.3.1 120 | + 增加联合舰队类型api 121 | 122 | 1.2.3 123 | + 修复了“基于Windows操作系统API的鼠标模拟机制”模式下系统缩放非100%时无法正确点击的Bug。 124 | 125 | -------------------------------------------------------------------------------- /index.es: -------------------------------------------------------------------------------- 1 | /* 2 | poi-plugin-kcps-terminal, providing control & data support for kcps kai. 3 | Copyright (C) 2018 Kana 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | ///////////////////////////////////////////////////////////////////////// 20 | /// /// 21 | /// Utils /// 22 | /// /// 23 | ///////////////////////////////////////////////////////////////////////// 24 | 25 | const EXTENSION_KEY = "poi-plugin-kcps-terminal" 26 | const {$, i18n, config, getStore} = window 27 | 28 | ///////////////////////////////////////////////////////////////////////// 29 | /// /// 30 | /// User Interface /// 31 | /// /// 32 | ///////////////////////////////////////////////////////////////////////// 33 | 34 | import React, { Component } from "react" 35 | import { connect } from 'react-redux' 36 | import { get } from 'lodash' 37 | import { ButtonToolbar, ToggleButtonGroup, ToggleButton, Checkbox } from 'react-bootstrap' 38 | import { createSelector } from 'reselect' 39 | import { configSelector } from 'views/utils/selectors' 40 | import { join } from 'path-extra' 41 | import InplaceEdit from 'react-edit-inplace' 42 | 43 | const __ = i18n[EXTENSION_KEY].__.bind(i18n[EXTENSION_KEY]) 44 | 45 | const CSS_FILENAME = "kcps-terminal.css" 46 | 47 | const DEFAULT_PORT = 5277 48 | const DEFAULT_TOKEN = "" 49 | const DEFAULT_ZOOM = 1.0 50 | const DEFAULT_QUALITY = 80 51 | const POINTER_TYPE_WIN = true 52 | const POINTER_TYPE_WEB = false 53 | 54 | const CONFIG_PATH_PORT = "plugin.kcpsTerminal.port" 55 | const CONFIG_PATH_TOKEN = "plugin.kcpsTerminal.token" 56 | const CONFIG_PATH_ZOOM = "plugin.kcpsTerminal.zoom" 57 | const CONFIG_PATH_QUALITY = "plugin.kcpsTerminal.quality" 58 | 59 | const MIN_PORT = 0 60 | const MIN_ZOOM = 0.25 61 | const MIN_QUALITY = 0 62 | 63 | const MAX_PORT = 65535 64 | const MAX_ZOOM = 4 //限制最大放大率 65 | const MAX_QUALITY = 100 66 | 67 | const kcpsTerminalConfigSelector = createSelector( 68 | configSelector, 69 | (config) => ({ 70 | port: get(config, CONFIG_PATH_PORT, DEFAULT_PORT), 71 | token: get(config, CONFIG_PATH_TOKEN, DEFAULT_TOKEN), 72 | zoom: get(config, CONFIG_PATH_ZOOM, DEFAULT_ZOOM), 73 | quality: get(config, CONFIG_PATH_QUALITY, DEFAULT_QUALITY) 74 | }) 75 | ) 76 | 77 | const mapStateToProps = (state) => kcpsTerminalConfigSelector(state) 78 | 79 | export class PluginKCPS extends Component { 80 | handlePortChanged = ({newPortText}) => { 81 | config.set(CONFIG_PATH_PORT, parseInt(newPortText, 10)) 82 | } 83 | 84 | handleTokenChanged = ({newTokenText}) => { 85 | config.set(CONFIG_PATH_TOKEN, newTokenText.trim()) 86 | } 87 | 88 | handleZoomChanged = ({newZoomText}) => { 89 | config.set(CONFIG_PATH_ZOOM, parseFloat(newZoomText)) 90 | } 91 | 92 | handleQualityChanged = ({newQualityText}) => { 93 | config.set(CONFIG_PATH_QUALITY, parseInt(newQualityText, 10)) 94 | } 95 | 96 | render() { 97 | return ( 98 |
102 | 106 |
107 |
108 | {__("Port")}({MIN_PORT}~{MAX_PORT}): 109 | +text >= MIN_PORT && +text <= MAX_PORT} 111 | text={String(this.props.port)} 112 | paramName="newPortText" 113 | change={this.handlePortChanged} 114 | stopPropagation 115 | className="inplace-edit" 116 | activeClassName="inplace-edit-active" 117 | /> 118 |
119 |
120 | {__("Token")}: 121 | /^\w*$/.test(text)} 123 | text={this.props.token} 124 | paramName="newTokenText" 125 | change={this.handleTokenChanged} 126 | stopPropagation 127 | className="inplace-edit" 128 | activeClassName="inplace-edit-active" 129 | /> 130 |
131 |
132 | {__("Zoom")}({MIN_ZOOM}~{MAX_ZOOM}): 133 | +text > 0 && +text >= MIN_ZOOM && +text <= MAX_ZOOM} 135 | text={String(this.props.zoom)} 136 | paramName="newZoomText" 137 | change={this.handleZoomChanged} 138 | stopPropagation 139 | className="inplace-edit" 140 | activeClassName="inplace-edit-active" 141 | /> 142 |
143 |
144 | {__("JPEG Quality")}({MIN_QUALITY}~{MAX_QUALITY}): 145 | +text >= MIN_QUALITY && +text <= MAX_QUALITY} 147 | text={String(this.props.quality)} 148 | paramName="newQualityText" 149 | change={this.handleQualityChanged} 150 | stopPropagation 151 | className="inplace-edit" 152 | activeClassName="inplace-edit-active" 153 | /> 154 |
155 |
156 |

{__("Please make sure you started poi with a special modification ")}{__("listed here")}{__(", otherwise mouse input simulation will fail.")}

157 |
158 |
159 |
160 | ) 161 | } 162 | } 163 | 164 | export const reactClass = connect(mapStateToProps)(PluginKCPS) 165 | 166 | ///////////////////////////////////////////////////////////////////////// 167 | /// /// 168 | /// Server /// 169 | /// /// 170 | ///////////////////////////////////////////////////////////////////////// 171 | 172 | //////// 173 | // States 174 | //////// 175 | 176 | //还没有获取到的状态设置为null可以利用本体的cache功能 177 | 178 | //零碎还不好归类的状态（不方便设置为null，所以内部每一项要有默认值，缺点就是刚启动插件没刷新数据时值与实际的会有差别） 179 | const miscellaneousState = { 180 | //联合舰队 181 | combinedFleet : false, //是否是联合舰队 182 | combinedFleetType : 0,//联合舰队类型，同api中定义的值 183 | 184 | //没有用（我就是懒得管理结尾项的逗号） 185 | nouse : false 186 | } 187 | 188 | //基地航空队 189 | var landBasedAirCorpsState = null //[] 190 | 191 | //预设编成 192 | var preSetsState = null //{} 193 | 194 | //////// 195 | // Game Request / Response Storage 196 | //////// 197 | 198 | const gameRequestStorage = new Array() 199 | 200 | var LastRequest 201 | 202 | const handleGameRequest = e => { 203 | LastRequest = e.detail 204 | const { path, body } = e.detail 205 | gameRequestStorage[path] = body 206 | //处理 207 | try { 208 | switch (path.replace("/kcsapi/", "")) { 209 | case "": 210 | 211 | break 212 | } 213 | } catch(ex) { 214 | console.log(ex) 215 | } 216 | } 217 | 218 | const gameResponseStorage = new Array() 219 | 220 | var LastResponse 221 | 222 | const handleGameResponse = e => { 223 | LastResponse = e.detail 224 | const { path, body } = e.detail 225 | gameResponseStorage[path] = body 226 | 227 | //定义变量（case里定义算重复定义，不允许，所以只能放到外面） 228 | //基地航空队 229 | let crops 230 | //处理 231 | try { 232 | switch (path.replace("/kcsapi/", "")) { 233 | case "api_port/port": 234 | //联合舰队 235 | miscellaneousState.combinedFleet = body.api_combined_flag != undefined && body.api_combined_flag > 0 236 | miscellaneousState.combinedFleetType = body.api_combined_flag != undefined && body.api_combined_flag > 0 ? body.api_combined_flag : 0 237 | break 238 | 239 | case "api_get_member/mapinfo": 240 | //基地航空队 241 | landBasedAirCorpsState = body.api_air_base 242 | break 243 | 244 | case "api_get_member/base_air_corps": 245 | //基地航空队 246 | //TODO: 没遇到过 247 | break 248 | 249 | case "api_req_air_corps/set_plane": 250 | //基地航空队//没管null 251 | crops = landBasedAirCorpsState.find(crops => crops.api_area_id == LastRequest.body.api_area_id && crops.api_rid == LastRequest.body.api_base_id) 252 | body.api_plane_info.forEach(p => { 253 | crops.api_plane_info[crops.api_plane_info.findIndex(plane => plane.api_squadron_id == p.api_squadron_id)] = p 254 | }) 255 | break 256 | 257 | case "api_req_air_corps/change_name": 258 | //基地航空队//没管null 259 | crops = landBasedAirCorpsState.find(crops => crops.api_area_id == LastRequest.body.api_area_id && crops.api_rid == LastRequest.body.api_base_id) 260 | crops.api_name = LastRequest.body.api_name 261 | break 262 | 263 | case "api_req_air_corps/set_action": 264 | //基地航空队//没管null 265 | var area = Number(LastRequest.body.api_area_id) 266 | var bases = LastRequest.body.api_base_id.split(",").map(x => +x) 267 | var actions = LastRequest.body.api_action_kind.split(",").map(x => +x) 268 | for (var i = 0; i < bases.length; i++) { 269 | crops = landBasedAirCorpsState.find(crops => crops.api_area_id == area && crops.api_rid == bases[i]) 270 | crops.api_action_kind = actions[i] 271 | } 272 | break 273 | 274 | case "api_req_air_corps/supply": 275 | //基地航空队//没管null 276 | crops = landBasedAirCorpsState.find(crops => crops.api_area_id == LastRequest.body.api_area_id && crops.api_rid == LastRequest.body.api_base_id) 277 | crops.api_distance = body.api_distance 278 | body.api_plane_info.forEach(p => { 279 | crops.api_plane_info[crops.api_plane_info.findIndex(plane => plane.api_squadron_id == p.api_squadron_id)] = p 280 | }) 281 | break 282 | 283 | case "api_req_air_corps/expand_base": 284 | //基地航空队 285 | //TODO: 没遇到过 286 | break 287 | 288 | case "api_req_hensei/combined": 289 | //联合舰队 290 | miscellaneousState.combinedFleet = body.api_combined == 1 291 | miscellaneousState.combinedFleetType = gameRequestStorage[path].api_combined_type 292 | break 293 | 294 | case "api_get_member/preset_deck": 295 | //预设编成 296 | preSetsState = body 297 | break 298 | 299 | case "api_req_hensei/preset_register": 300 | //预设编成//没管null 301 | preSetsState.api_deck[LastRequest.body.api_preset_no] = body 302 | break 303 | 304 | case "api_req_hensei/preset_delete": 305 | //预设编成//没管null 306 | delete preSetsState.api_deck[LastRequest.body.api_preset_no] 307 | break 308 | 309 | case "": 310 | 311 | break 312 | 313 | } 314 | } catch (ex) { 315 | console.log(ex) 316 | } 317 | } 318 | 319 | //////////// 320 | // Page 321 | //////////// 322 | 323 | import { toNumber, toInteger, round } from 'lodash' 324 | import { gameRefreshPage, getTitleBarHeight, getPoiInfoHeight, getYOffset, getRealSize } from 'views/services/utils' 325 | import url from "url" 326 | import semver from 'semver' 327 | import { remote } from 'electron' 328 | const { BrowserWindow } = remote 329 | 330 | import { store } from 'views/create-store' 331 | import { stateSelector, constSelector, basicSelector, fleetsSelector, shipsSelector, equipsSelector, repairsSelector, mapsSelector, sortieSelector, battleSelector } from 'views/utils/selectors' 332 | 333 | const ORIGINAL_GRAPHIC_AREA_WIDTH = 1200 //HTML5版本 334 | const ASPECT_RATIO = 1 / 0.6 335 | 336 | //默认的返回内容 337 | const responseHelloWorld = (response) => { 338 | response.statusCode = 200 339 | response.setHeader("Content-Type", "text/plain; charset=utf-8") 340 | response.write("Hello World") 341 | response.end() 342 | } 343 | 344 | const responseDefault = (response) => { 345 | response.statusCode = 200 346 | response.setHeader("Content-Type", "text/plain; charset=utf-8") 347 | //response.write("Ok") 348 | response.end() 349 | } 350 | 351 | const responseWrongParams = (response) => { 352 | response.statusCode = 400 353 | response.setHeader("Content-Type", "text/plain; charset=utf-8") 354 | //response.write("Wrong parameter") 355 | response.end() 356 | } 357 | 358 | const responseWrongToken = (response) => { 359 | response.statusCode = 403 360 | response.setHeader("Content-Type", "text/plain; charset=utf-8") 361 | //response.write("Wrong token") 362 | response.end() 363 | } 364 | 365 | const responseWrongPath = (response) => { 366 | response.statusCode = 404 367 | response.setHeader("Content-Type", "text/plain; charset=utf-8") 368 | //response.write("Page not found") 369 | response.end() 370 | } 371 | 372 | const responseSeverError = (response) => { 373 | response.statusCode = 500 374 | response.setHeader("Content-Type", "text/plain; charset=utf-8") 375 | //response.write("Internal server error") 376 | response.end() 377 | } 378 | 379 | //提供的功能 380 | 381 | const responseCapture = (request, response) => { 382 | const params = url.parse(request.url, true).query 383 | const format = params.format 384 | const { width, height, windowWidth, windowHeight } = getStore('layout.webview') 385 | const isolate = config.get('poi.isolateGameWindow', false) 386 | const scWidth = isolate ? windowWidth : width 387 | const scHeight = isolate ? windowHeight : height 388 | const rect = { 389 | x: 0, 390 | y: 0, 391 | width: Math.floor(scWidth * devicePixelRatio), 392 | height: Math.floor(scHeight * devicePixelRatio), 393 | } 394 | const handleCapturedImage = image => {//electron nativeImage 395 | try { 396 | //image = image.resize({ width: Math.floor(scWidth), height: Math.floor(scHeight) }) 397 | const quality = config.get(CONFIG_PATH_QUALITY, DEFAULT_QUALITY) 398 | const zoom = config.get(CONFIG_PATH_ZOOM, DEFAULT_ZOOM) 399 | const zoomWidth = toInteger(round(zoom * ORIGINAL_GRAPHIC_AREA_WIDTH)) 400 | //console.log(image.getSize())//缩放设置不是100%时这里的分辨率不对，导致脚本不能用 401 | if (image.getSize().width != zoomWidth) { 402 | image = image.resize({width: zoomWidth}) 403 | } 404 | //const imageString = image.toDataURL()//TODO：使用这个跨进程传输这个图像的数据(ipcMain, ipcRenderer)，使用const image = nativeImage.createFromDataURL(imageString)恢复数据 405 | response.statusCode = 200 406 | let buffer 407 | if (format == "png") {//仅供我自己调试截图用，脚本自身不会要求返回png 408 | response.setHeader("Content-Type", "image/png") 409 | buffer = image.toPNG() 410 | } else { 411 | response.setHeader("Content-Type", "image/jpeg") 412 | buffer = image.toJPEG(quality) 413 | } 414 | response.write(buffer) //buffer里有数据，response也没问题，换成写字符串也能正常返回，但分离模式下为啥就卡在这了？ 415 | } catch (ex) { 416 | console.log(ex) 417 | response.statusCode = 500 418 | } finally { 419 | response.end() 420 | } 421 | } 422 | 423 | if (semver.gte(POI_VERSION, "10.7.0")) { 424 | //10.7里不再需要.getWebContents()了，参见commit 704d1756230ae590661a1e5135e6d685367bfec2 425 | //console.log("v3 capture") 426 | getStore('layout.webview.ref')/*.getWebContents()*/.capturePage(rect).then(image => handleCapturedImage(image)) 427 | } else if (semver.gte(POI_VERSION, "10.5.0")) { 428 | //注意，在poi10.5beta（具体为commit:849dec96254bda0bbe1da2b88e7cad3a36f08e0a）中增加了“通过Canvas直接获得截图”选项 429 | //我从代码里看不出选不选中到底有什么区别，因为最后都是调用了同一个函数。 430 | //看起来以前的方法就是这里最后被调用的“通过Canvas直接获得截图”，所以这里就直接用和以前类似的那个解决方案了。 431 | //当然，为了便于新旧版本过渡，我这里判断一下版本，调用新旧两种截图函数。 432 | //console.log("v2 capture") 433 | getStore('layout.webview.ref').getWebContents().capturePage(rect).then(image => handleCapturedImage(image)) 434 | } else { 435 | //console.log("v1 capture") 436 | getStore('layout.webview.ref').getWebContents().capturePage(rect, image => handleCapturedImage(image)) 437 | } 438 | } 439 | 440 | //https://electronjs.org/docs/api/web-contents 441 | const responseMouse = (request, response) => { 442 | const params = url.parse(request.url, true).query 443 | let x = params.x 444 | let y = params.y 445 | x = toNumber(x) 446 | y = toNumber(y) 447 | if (0 <= x && x <= 1 && 0 <= y && y <= 1) { 448 | try { 449 | const { width, height, windowWidth, windowHeight } = getStore('layout.webview') 450 | const isolate = config.get('poi.isolateGameWindow', false) 451 | const scWidth = isolate ? windowWidth : width 452 | const scHeight = isolate ? windowHeight : height 453 | if (scWidth <= 0) { 454 | responseSeverError(response) 455 | } else { 456 | let zoom = config.get('poi.appearance.zoom', 1)//poi的缩放选项（不是分辨率缩放）。虽然缩放后画面看起来大小不变，但实际鼠标坐标要乘这个。 457 | x = toInteger(round(x * scWidth * zoom)) //这里不用乘devicePixelRatio 458 | y = toInteger(round(y * scHeight * zoom)) //这里不用乘devicePixelRatio 459 | let blinkWebMouseEvent 460 | switch (params.type) { 461 | case "down": 462 | blinkWebMouseEvent = {type: "mouseDown", x: x, y: y, globalX: x, globalY: y, button: 'left', clickCount: 1 } 463 | break 464 | case "up": 465 | blinkWebMouseEvent = {type: "mouseUp", x: x, y: y, globalX: x, globalY: y, button: 'left', clickCount: 1 } 466 | break 467 | case "move": 468 | blinkWebMouseEvent = {type: "mouseMove", x: x, y: y, globalX: x, globalY: y } 469 | break 470 | case "enter"://1.2.0.0新增，为了解决提督室按钮点击失效的问题 471 | blinkWebMouseEvent = {type: "mouseEnter", x: x, y: y, globalX: x, globalY: y } 472 | break 473 | case "leave"://1.2.0.0新增，为了解决提督室按钮点击失效的问题 474 | blinkWebMouseEvent = {type: "mouseLeave", x: x, y: y, globalX: x, globalY: y } 475 | break 476 | default: 477 | responseWrongParams(response) 478 | return 479 | } 480 | if (semver.gte(POI_VERSION, "10.7.0")) { 481 | //10.7里不再需要.getWebContents()了 482 | //console.log(blinkWebMouseEvent) 483 | getStore('layout.webview.ref').sendInputEvent(blinkWebMouseEvent)//10.7.0之后，input event无法被正确转发（site isolation） 484 | } else { 485 | getStore('layout.webview.ref').getWebContents().sendInputEvent(blinkWebMouseEvent) 486 | } 487 | } 488 | response.statusCode = 200 489 | } catch (ex) { 490 | console.log(ex) 491 | response.statusCode = 500 492 | } finally { 493 | response.end() 494 | } 495 | } else { 496 | responseWrongParams(response) 497 | } 498 | } 499 | 500 | const responseRefresh = (response) => { 501 | gameRefreshPage() 502 | responseDefault(response) 503 | } 504 | 505 | //返回状态数据。因为不同的response可能修改同一个数据，因此需要按照api的格式维护一个更新。仅有多个api会修改同一个数据时才会用到这个函数，否则一律使用responseResponse 506 | //这里把poi里所有的相关数据都搬过来了，具体哪些有用还不清楚。不是每一个都需要在插件中实现。 507 | //TODO: 把没用的(非必须的)标记出来 508 | const responseData = (request, response) => { 509 | try { 510 | response.statusCode = 200 511 | response.setHeader("Content-Type", "application/json; charset=utf-8") 512 | const params = url.parse(request.url, true).query 513 | const type = params.type 514 | let selector 515 | let value 516 | switch (type) { 517 | //poi自带的（最后需要全部被替换） 518 | case "const": //常量数据应该从Response获得，这个接口在插件中非必须 519 | selector = constSelector 520 | value = selector(store.getState()) 521 | break 522 | case "basic": //已在kcps kai 1.2.1中使用 523 | selector = basicSelector 524 | value = selector(store.getState()) 525 | break; 526 | case "fleets": //已在kcps kai 1.0.0中使用 527 | selector = fleetsSelector 528 | value = selector(store.getState()) 529 | break 530 | case "ships": //已在kcps kai 1.0.0中使用 //api里返回的是数组，这里咋返回的是字典呢？明明key就是index+1 //TODO: 改成返回api的array形式 531 | selector = shipsSelector 532 | value = selector(store.getState()) 533 | break 534 | case "equips": //已在kcps kai 1.2.0中使用 //api里返回的是数组，这里咋返回的是字典呢？明明key就是index+1 //TODO: 改成返回api的array形式 535 | selector = equipsSelector 536 | value = selector(store.getState()) 537 | break 538 | case "repairs": //已在kcps kai 1.0.0中使用//使用高速修复时游戏服务器不返回新的修复渠数据，而这里会把这个修复渠的数据自动设置为默认值 539 | selector = repairsSelector 540 | value = selector(store.getState()) 541 | break 542 | case "constructions": 543 | selector = (state) => state.info.constructions 544 | value = selector(store.getState()) 545 | break 546 | case "resources": 547 | selector = (state) => state.info.resources 548 | value = selector(store.getState()) 549 | break 550 | case "maps": 551 | selector = mapsSelector 552 | value = selector(store.getState()) 553 | break 554 | case "sortie": //已在kcps kai 1.1.0中使用//这里的数据是poi自己定义的，因为赶时间做出成品，这里先用着。之后有空自己定义自己维护 555 | selector = sortieSelector 556 | value = selector(store.getState()) 557 | break 558 | case "battle": //已在kcps kai 1.1.0中使用//这里的数据是poi自己定义的，因为赶时间做出成品，这里先用着。之后有空自己定义自己维护 559 | selector = battleSelector 560 | value = selector(store.getState()) 561 | break 562 | //自己实现的 563 | case "miscellaneous": 564 | value = miscellaneousState 565 | break 566 | case "landBasedAirCorps": 567 | value = landBasedAirCorpsState 568 | break 569 | case "preSets": 570 | value = preSetsState 571 | break 572 | } 573 | if (value === undefined) { 574 | //有些用户使用10.6以上的poi时会报错。response.write()里面传进去的竟然是undefined，但我遇不到，暂且在这里打一条log 575 | console.warn("Got \"undefined\" when querying data of type \"%s\"", type) 576 | } 577 | const jsonStr = JSON.stringify(value, (k, v) => v === undefined ? null : v) //json里不支持undefined，需要替换成null 578 | response.write(jsonStr) 579 | } catch (ex) { 580 | console.log(ex) 581 | response.statusCode = 500 582 | } finally { 583 | response.end() 584 | } 585 | } 586 | 587 | //将记录的游戏request返回。 588 | //目前仅调试用 589 | const responseRequest = (request, response) => { 590 | try { 591 | response.statusCode = 200 592 | response.setHeader("Content-Type", "application/json; charset=utf-8") 593 | const params = url.parse(request.url, true).query 594 | const type = params.type 595 | let data 596 | if (typeof(type) == "undefined" || type.trim() === "") { //仅供我自己调试用，这个接口在插件中非必须 597 | //按key字符串排序，方便查看，该过程非必须 598 | let keys = new Array() 599 | for (let key in gameRequestStorage) { 600 | keys.push(key) 601 | } 602 | keys.sort() 603 | //stringify不能处理array 604 | let array = new Array() 605 | for (let i = 0; i < keys.length; i++) { 606 | let key = keys[i] 607 | array[i] = "\"" + key + "\":" + JSON.stringify(gameRequestStorage[key]) 608 | } 609 | data = "{" + array.join(",") + "}" //包装成一个object 610 | } else { 611 | data = JSON.stringify(gameRequestStorage[type]) 612 | } 613 | if (typeof(data) == "undefined") { 614 | response.write("undefined") 615 | } else { 616 | response.write(data) 617 | } 618 | } catch (ex) { 619 | console.log(ex) 620 | response.statusCode = 500 621 | } finally { 622 | response.end() 623 | } 624 | } 625 | 626 | //将记录的游戏response返回。 627 | //因为不做任何处理，所以实现起来非常简单。 628 | //已在kcps kai中使用的API有： 629 | //1.0.0: 630 | //api_start2/getData 各种常量数据 631 | //api_get_member/mission 判断已开放的远征 632 | //api_get_member/require_info 判断临时补给是否可用 633 | //1.1.0: 634 | //api_get_member/mapinfo 判断海域是否开放 635 | //api_req_sortie/battleresult 636 | const responseResponse = (request, response) => { 637 | try { 638 | response.statusCode = 200 639 | response.setHeader("Content-Type", "application/json; charset=utf-8") 640 | const params = url.parse(request.url, true).query 641 | const type = params.type 642 | let data 643 | if (typeof(type) == "undefined" || type.trim() === "") { //仅供我自己调试用，这个接口在插件中非必须 644 | //按key字符串排序，方便查看，该过程非必须 645 | let keys = new Array() 646 | for (let key in gameResponseStorage) { 647 | keys.push(key) 648 | } 649 | keys.sort() 650 | //stringify不能处理array 651 | let array = new Array() 652 | for (let i = 0; i < keys.length; i++) { 653 | let key = keys[i] 654 | array[i] = "\"" + key + "\":" + JSON.stringify(gameResponseStorage[key]) 655 | } 656 | data = "{" + array.join(",") + "}" //包装成一个object 657 | } else { 658 | data = JSON.stringify(gameResponseStorage[type]) 659 | } 660 | if (typeof(data) == "undefined") { 661 | response.write("undefined") 662 | } else { 663 | response.write(data) 664 | } 665 | } catch (ex) { 666 | console.log(ex) 667 | response.statusCode = 500 668 | } finally { 669 | response.end() 670 | } 671 | } 672 | 673 | //////// 674 | // Mapping 675 | //////// 676 | 677 | const onRequest = (request, response) => { 678 | try { 679 | const pathname = url.parse(request.url).pathname 680 | if (pathname === "/" || pathname === "/hello") { 681 | responseHelloWorld(response) 682 | } else { 683 | let params = url.parse(request.url, true).query 684 | let token = config.get(CONFIG_PATH_TOKEN, DEFAULT_TOKEN) 685 | if (token != "" && token != params.token) { 686 | responseWrongToken(response) 687 | } else { 688 | switch (pathname) { 689 | case "/capture": 690 | responseCapture(request, response) 691 | break 692 | case "/mouse": 693 | responseMouse(request, response) 694 | break 695 | case "/refresh": 696 | responseRefresh(response) 697 | break 698 | case "/request": //只有功能涉及到读包时才需要实现，不实现可返回404 699 | responseRequest(request, response) 700 | break 701 | case "/response": //只有功能涉及到读包时才需要实现，不实现可返回404 702 | responseResponse(request, response) 703 | break 704 | case "/data": //只有功能涉及到读包时才需要实现，不实现可返回404 705 | responseData(request, response) 706 | break 707 | default: 708 | responseWrongPath(response) 709 | } 710 | } 711 | } 712 | } catch (ex) { 713 | console.log(ex) 714 | } 715 | } 716 | 717 | ///////////// 718 | // Server 719 | ///////////// 720 | 721 | import http from "http" 722 | import { observe, observer } from 'redux-observers' 723 | 724 | var isServerOn = false 725 | 726 | const server = http.createServer(onRequest) 727 | 728 | const startServer = () => { 729 | if (!isServerOn) { 730 | let port = config.get(CONFIG_PATH_PORT, DEFAULT_PORT) 731 | server.listen(port) 732 | console.log("KCPS server started at port " + port + ".") 733 | isServerOn = true 734 | } else { 735 | console.warn("KCPS server has already started.") 736 | } 737 | } 738 | 739 | const stopServer = () => { 740 | if (isServerOn) { 741 | server.close() 742 | console.log("KCPS server stopped.") 743 | isServerOn = false 744 | } else { 745 | console.warn("KCPS server has already stopped.") 746 | } 747 | } 748 | 749 | const restartServer = () => { 750 | if (isServerOn) { 751 | server.close() 752 | } 753 | let port = config.get(CONFIG_PATH_PORT, DEFAULT_PORT) 754 | server.listen(port) 755 | console.log("KCPS server restarted at port " + port + ".") 756 | isServerOn = true 757 | } 758 | 759 | 760 | const unsubscribeObserve = observe(store, [ 761 | observer( 762 | state => kcpsTerminalConfigSelector(state), 763 | (dispatch, current, previous) => { 764 | if (current.port != previous.port) { 765 | restartServer() 766 | } 767 | } 768 | )] 769 | ) 770 | 771 | ///////////////////////////////////////////////////////////////////////// 772 | /// /// 773 | /// Interface /// 774 | /// /// 775 | ///////////////////////////////////////////////////////////////////////// 776 | 777 | const printMouseEvent = e => { 778 | console.log(e) 779 | } 780 | 781 | //导入插件 782 | export const pluginDidLoad = () => { 783 | window.addEventListener('game.request', handleGameRequest) 784 | window.addEventListener('game.response', handleGameResponse) 785 | /*貌似两个里没有一个pid是渲染线程 786 | console.log(window.process.pid) 787 | console.log(getStore('layout.webview.ref').getWebContents().getOSProcessId()) 788 | */ 789 | startServer() 790 | } 791 | 792 | //移除插件 793 | export const pluginWillUnload = () => { 794 | stopServer() 795 | window.removeEventListener('game.response', handleGameResponse) 796 | window.removeEventListener('game.request', handleGameRequest) 797 | unsubscribeObserve() //按照要求必须在移除时释放 798 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | --------------------------------------------------------------------------------