Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0ae5bd5818 | ||
|
|
24cb16f32a | ||
|
|
5eeab209f5 | ||
|
|
3461f996dc | ||
|
|
b3187e30d4 | ||
|
|
18e13a861b | ||
|
|
1fdf17a47c | ||
|
|
89fdf3619d | ||
|
|
0d6c911126 | ||
|
|
c9dd8a83b9 | ||
|
|
e1ab8ec1fe | ||
|
|
8c52e5f1bd | ||
|
|
8881af586b | ||
|
|
367962d45b | ||
|
|
41638e8037 | ||
|
|
38a21684a1 | ||
|
|
c89837c01a | ||
|
|
b8c865d198 | ||
|
|
1365083586 | ||
|
|
96769efdbb | ||
|
|
09c2392b99 |
No files matched your search
+103
-32
@@ -1,59 +1,130 @@
|
|||||||
# Changelog
|
# Changelog / 更新日志
|
||||||
|
|
||||||
本文件记录 Iridium 的重要变更。
|
本文件记录 Iridium 的重要变更。
|
||||||
|
This file records notable changes to Iridium.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [26.9.14] - 2026-09-14
|
||||||
|
|
||||||
|
### 修复 / Fixed
|
||||||
|
- 删除配置后重载可正确重新生成;配置写入 MCDR 数据目录
|
||||||
|
- Deleting config then reloading correctly recreates it; config stored under the MCDR data folder
|
||||||
|
|
||||||
|
### 变更 / Changed
|
||||||
|
- 许可证改为 **GPL-3.0**(原先为保留所有权益)
|
||||||
|
- License changed to **GPL-3.0** (was All Rights Reserved)
|
||||||
|
- 配置格式为 **YAML**:`config/iridium/iridium.yml`(`#` 原生注释)
|
||||||
|
- Config format is **YAML**: `config/iridium/iridium.yml` (native `#` comments)
|
||||||
|
- 自动从旧 JSON(`config/iridium.json` 或 `config/iridium/iridium.json`)迁移
|
||||||
|
- Auto-migrates from legacy JSON configs
|
||||||
|
- `motd_start_day` 默认为配置生成当天(YYYY-MM-DD)
|
||||||
|
- `motd_start_day` defaults to the config creation date
|
||||||
|
- 去掉 MOTD 标题「服务器信息」/「Server Info」
|
||||||
|
- Removed the MOTD header title
|
||||||
|
- 默认 QQ 群可点击链接 `https://skymirror.top/qq`
|
||||||
|
- Default QQ group is a clickable link to `https://skymirror.top/qq`
|
||||||
|
- 进服命令提示文案去掉「已启用 Iridium」
|
||||||
|
- Join tip header no longer says “Iridium is enabled”
|
||||||
|
|
||||||
|
### 新增 / Added
|
||||||
|
- 英文文档 `README_en.md`
|
||||||
|
- English documentation `README_en.md`
|
||||||
|
|
||||||
|
### 清理 / Cleanup
|
||||||
|
- 移除未使用的常量、翻译键与导入
|
||||||
|
- Removed unused constants, translation keys, and imports
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [26.9.13] - 2026-09-13
|
||||||
|
|
||||||
|
### 新增 / Added
|
||||||
|
- 首次启动自动生成带中文注释的 `config/iridium.json`
|
||||||
|
- On first load, generate a commented `config/iridium.json`
|
||||||
|
- 配置文件支持 `//` 行注释
|
||||||
|
- Config file supports `//` line comments
|
||||||
|
|
||||||
|
### 变更 / Changed
|
||||||
|
- 提交信息改为中文
|
||||||
|
- Commit messages rewritten in Chinese
|
||||||
|
- 清理历史 Release,仅保留当前版本
|
||||||
|
- Cleaned old Releases; keep only the current version
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.8] - 2026-09-13
|
## [26.9.8] - 2026-09-13
|
||||||
|
|
||||||
### Changed
|
### 变更 / Changed
|
||||||
- `!!share`:去掉「点击复制完整数据」,仅保留物品名 + 悬停预览(与 ShowIt 风格一致)
|
- `!!share`:去掉「点击复制完整数据」,仅保留物品名 + 悬停预览
|
||||||
|
- `!!share`: removed the copy-to-clipboard button; name + hover only
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.7] - 2026-09-13
|
## [26.9.7] - 2026-09-13
|
||||||
|
|
||||||
### Fixed
|
### 修复 / Fixed
|
||||||
- `!!share`:无 NBT 改名时,正文 fallback 改为 ID 美化名(如 `Time Twister Wireless`),不再直接显示 `kubejs:...`;语言键命中则显示正式本地化名
|
- `!!share`:无 NBT 改名时 fallback 为 ID 美化名(如 `Time Twister Wireless`)
|
||||||
|
- `!!share`: humanized ID fallback when the item has no NBT custom name
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.6] - 2026-09-13
|
## [26.9.6] - 2026-09-13
|
||||||
|
|
||||||
### Fixed
|
### 修复 / Fixed
|
||||||
- `!!share`:默认物品名改为客户端 `translate` 组件(如 `block.ae2.fluix_covered_cable`),本地化显示正式名;仅有 NBT 自定义名时仍显示改名
|
- `!!share`:使用客户端 `translate` 组件显示本地化名
|
||||||
- `!!share`:提示音在玩家位置播放,避免 "sound is too far away"
|
- `!!share`: use client `translate` component for localized names
|
||||||
|
- `!!share`:提示音在玩家位置播放
|
||||||
|
- `!!share`: play sound at the player to avoid “too far away”
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.5] - 2026-09-13
|
## [26.9.5] - 2026-09-13
|
||||||
|
|
||||||
### Fixed
|
### 修复 / Fixed
|
||||||
- `!!hat`(1.17+):改用副手缓冲做真正交换,避免复杂 NBT 重建失败导致原头盔消失;副手非空时拒绝并提示
|
- `!!hat`(1.17+):副手缓冲交换,避免复杂 NBT 重建失败导致物品消失
|
||||||
- `!!share`:展示名优先取 `custom_name` / `display.Name` / translate,不再只显示物品 ID
|
- `!!hat` (1.17+): offhand-buffer swap so complex NBT cannot wipe items
|
||||||
|
- `!!share`:优先显示自定义名 / translate
|
||||||
|
- `!!share`: prefer custom name / translate over raw item id
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.4] - 2026-09-13
|
## [26.9.4] - 2026-09-13
|
||||||
|
|
||||||
### Added
|
### 新增 / Added
|
||||||
- 操作日志:`!!share` / `!!hat` / `!!head` / `!!c` 成功时写入 MCDR 控制台(`[Iridium] ...`)
|
- 操作日志写入 MCDR 控制台
|
||||||
|
- Command operations logged to the MCDR console
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.3] - 2026-09-13
|
## [26.9.3] - 2026-09-13
|
||||||
|
|
||||||
### Fixed
|
### 修复 / Fixed
|
||||||
- `!!share` / `!!hat` / `!!head`:`info.version` 若为字符串时比较崩溃(`Cannot compare Version and str`)
|
- 版本比较在 `str` / `Version` 之间崩溃
|
||||||
- `!!c`:命令回调少绑定 `server` 导致 `do_calc() missing ... context`
|
- Version comparison crash between `str` and `Version`
|
||||||
|
- `!!c` 回调缺少 `server` 绑定
|
||||||
|
- `!!c` callback missing `server` binding
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.2] - 2026-09-13
|
## [26.9.2] - 2026-09-13
|
||||||
|
|
||||||
### Fixed
|
### 修复 / Fixed
|
||||||
- 语言文件 YAML 解析失败(值中含 `:` 未加引号导致 `mapping values are not allowed`)
|
- 语言文件 YAML 因值中冒号未加引号而解析失败
|
||||||
- 进服事件名错误:`PLAYER_JOIN` → `PLAYER_JOINED`(否则插件 on_load 失败)
|
- Language YAML failed when values contained unquoted colons
|
||||||
|
- 进服事件名:`PLAYER_JOIN` → `PLAYER_JOINED`
|
||||||
|
- Join event name: `PLAYER_JOIN` → `PLAYER_JOINED`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [26.9.1] - 2026-09-13
|
## [26.9.1] - 2026-09-13
|
||||||
|
|
||||||
### Added
|
### 新增 / Added
|
||||||
- `!!share`:展示主手物品(悬停完整数据,1.16+ 点击复制,可选提示音)
|
- `!!share` / `!!hat` / `!!head` / `!!c`、进服 MOTD 与命令提示
|
||||||
- `!!hat`:主手物品与头部装备互换(需 RCON)
|
- `!!share` / `!!hat` / `!!head` / `!!c`, join MOTD and command tips
|
||||||
- `!!head [player]`:获取一个玩家头颅,支持冷却与权限
|
- 按 Minecraft 版本分支;不支持的功能会提示
|
||||||
- `!!c <expression>`:游戏内四则运算计算器(AST 白名单,零依赖)
|
- Minecraft-version branching with clear prompts when unsupported
|
||||||
- 进服 MOTD:开服天数、自定义文案、可点击链接、`§` 颜色
|
|
||||||
- 进服命令提示(可点击填入聊天框)
|
|
||||||
- 按 Minecraft 版本分支;不支持的功能会明确提示
|
|
||||||
|
|
||||||
### Security
|
### 安全 / Security
|
||||||
- 玩家名统一清洗为 `[A-Za-z0-9_]` 并限长后再拼进 `/give`、`data get`、`item replace`
|
- 玩家名清洗、命令去换行、tellraw 转义、链接仅 http(s)
|
||||||
- 控制台命令去除换行,防止拆成多行二次执行
|
- Name sanitization, newline stripping, tellraw escaping, http(s)-only links
|
||||||
- tellraw 对物品 SNBT 做 JSON 转义与长度截断
|
|
||||||
- MOTD 链接仅允许 `http://` / `https://`
|
|
||||||
@@ -1,14 +1,674 @@
|
|||||||
Copyright (c) 2026 云镜之端/SKYMirror. All Rights Reserved.
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
本软件及相关文档文件(以下统称“本软件”)之著作权归 云镜之端/SKYMirror 所有。
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
保留所有权益。未经著作权人书面许可,不得对本软件进行复制、修改、合并、发布、
|
Preamble
|
||||||
分发、再许可、出售或以其他方式使用(包括但不限于商业用途)。
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
The GNU General Public License is a free, copyleft license for
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
software and other kinds of works.
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
The licenses for most software and other practical works are designed
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
SOFTWARE.
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -4,9 +4,9 @@ MCDReforged 插件:物品展示 / 戴头 / 获取头颅 / 游戏内计算器 /
|
|||||||
|
|
||||||
| | |
|
| | |
|
||||||
|---|---|
|
|---|---|
|
||||||
| 版本 | **26.9.8** |
|
| 版本 | **26.9.14** |
|
||||||
| 作者 | 云镜之端/SKYMirror |
|
| 作者 | 云镜之端/SKYMirror |
|
||||||
| 许可 | 保留所有权益(All Rights Reserved) |
|
| 许可 | **GPL-3.0** |
|
||||||
| 前置 | MCDReforged `>= 2.6.0` |
|
| 前置 | MCDReforged `>= 2.6.0` |
|
||||||
| MC | **1.7.10+**(按版本分支;不支持的功能会提示) |
|
| MC | **1.7.10+**(按版本分支;不支持的功能会提示) |
|
||||||
| 依赖 | 无第三方 Python 包 |
|
| 依赖 | 无第三方 Python 包 |
|
||||||
@@ -15,7 +15,7 @@ MCDReforged 插件:物品展示 / 戴头 / 获取头颅 / 游戏内计算器 /
|
|||||||
|
|
||||||
| 功能 | 说明 |
|
| 功能 | 说明 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| `!!share` | 展示主手物品:悬停看完整 NBT/组件,1.16+ 可点击复制,可选提示音 |
|
| `!!share` | 展示主手物品:聊天栏显示物品名,悬停查看完整数据 |
|
||||||
| `!!hat` | 主手与头部装备互换 |
|
| `!!hat` | 主手与头部装备互换 |
|
||||||
| `!!head [player]` | 给自己或指定玩家 **1 个** 头颅;有冷却 |
|
| `!!head [player]` | 给自己或指定玩家 **1 个** 头颅;有冷却 |
|
||||||
| `!!c <表达式>` | 四则运算 + 括号:`+ - * / // % ** ^` |
|
| `!!c <表达式>` | 四则运算 + 括号:`+ - * / // % ** ^` |
|
||||||
@@ -79,26 +79,23 @@ rcon.password=your_password
|
|||||||
|
|
||||||
## 配置
|
## 配置
|
||||||
|
|
||||||
路径:`config/iridium.json`(首次加载自动生成)
|
路径:`config/iridium/iridium.yml`(YAML,`#` 注释;首次加载自动生成;旧的 `config/iridium.json` / `config/iridium/iridium.json` 会自动迁移)
|
||||||
|
|
||||||
```json
|
```yaml
|
||||||
{
|
permission: 1
|
||||||
"permission": 1,
|
head_cooldown_seconds: 60
|
||||||
"head_cooldown_seconds": 60,
|
hat_cooldown_seconds: 3
|
||||||
"hat_cooldown_seconds": 3,
|
share_sound: true
|
||||||
"share_sound": true,
|
force_version: ""
|
||||||
"force_version": "",
|
join_tip: true
|
||||||
"join_tip": true,
|
join_tip_delay_seconds: 1.5
|
||||||
"join_tip_delay_seconds": 1.5,
|
motd_enabled: true
|
||||||
"motd_enabled": true,
|
motd_start_day: "2026-09-14"
|
||||||
"motd_start_day": "",
|
motd_lines:
|
||||||
"motd_lines": [
|
- "§6欢迎 §e{player}§6 加入服务器!"
|
||||||
"§6欢迎 §e{player}§6 加入服务器!",
|
- "§7服务器已开服 §b{days}§7 天"
|
||||||
"§7服务器已开服 §b{days}§7 天",
|
- "§7官网: {link:§b点击打开官网|https://www.skymirror.top}"
|
||||||
"§7官网: {link:§b点击打开官网|https://www.skymirror.top}",
|
- "§7QQ群: {link:§f985402607|https://skymirror.top/qq}"
|
||||||
"§7QQ群: §f985402607"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
| 字段 | 默认 | 说明 |
|
| 字段 | 默认 | 说明 |
|
||||||
@@ -111,7 +108,7 @@ rcon.password=your_password
|
|||||||
| `join_tip` | `true` | 进服是否提示可用命令 |
|
| `join_tip` | `true` | 进服是否提示可用命令 |
|
||||||
| `join_tip_delay_seconds` | `1.5` | 进服消息延迟;`0` 立即 |
|
| `join_tip_delay_seconds` | `1.5` | 进服消息延迟;`0` 立即 |
|
||||||
| `motd_enabled` | `true` | 是否发送 MOTD |
|
| `motd_enabled` | `true` | 是否发送 MOTD |
|
||||||
| `motd_start_day` | `""` | 开服日期 `YYYY-MM-DD`(当天算第 1 天);留空不显示天数 |
|
| `motd_start_day` | 生成配置当天 | 开服日期 `YYYY-MM-DD`(当天算第 1 天);可改成真实开服日 |
|
||||||
| `motd_lines` | 见上 | MOTD 文本行 |
|
| `motd_lines` | 见上 | MOTD 文本行 |
|
||||||
|
|
||||||
修改配置后执行 `!!MCDR reload plugin` 生效。
|
修改配置后执行 `!!MCDR reload plugin` 生效。
|
||||||
@@ -164,6 +161,7 @@ python3 tests/test_pure.py
|
|||||||
|
|
||||||
## 版权
|
## 版权
|
||||||
|
|
||||||
Copyright (c) 2026 云镜之端/SKYMirror. All Rights Reserved.
|
Copyright (c) 2026 云镜之端/SKYMirror.
|
||||||
|
|
||||||
未经书面许可,不得复制、修改、分发或用于商业用途。详见 [LICENSE](LICENSE)。
|
本项目采用 **GNU GPL v3.0** 许可,详见 [LICENSE](LICENSE)。
|
||||||
|
This project is licensed under the **GNU GPL v3.0**. See [LICENSE](LICENSE).
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
# Iridium
|
||||||
|
|
||||||
|
MCDReforged plugin: item share / wear on head / player head / calculator / join MOTD.
|
||||||
|
|
||||||
|
| | |
|
||||||
|
|---|---|
|
||||||
|
| Version | **26.9.14** |
|
||||||
|
| Author | 云镜之端/SKYMirror |
|
||||||
|
| License | **GPL-3.0** |
|
||||||
|
| Requires | MCDReforged `>= 2.6.0` |
|
||||||
|
| Minecraft | **1.7.10+** (feature-gated by version) |
|
||||||
|
| Python deps | None |
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|---------|-------------|
|
||||||
|
| `!!share` | Share held item: name in chat, hover for full data |
|
||||||
|
| `!!hat` | Swap main-hand item with head slot |
|
||||||
|
| `!!head [player]` | Get **one** player head (default: yourself); cooldown |
|
||||||
|
| `!!c <expression>` | In-game calculator: `+ - * / // % ** ^` |
|
||||||
|
| Join MOTD | Uptime days, custom lines, clickable links, `§` colors |
|
||||||
|
| Join tips | Command list; click fills chat |
|
||||||
|
|
||||||
|
### Version support
|
||||||
|
|
||||||
|
| Feature | 1.7.10 | 1.8–1.12 | 1.13–1.16 | 1.17–1.20.4 | 1.20.5+ |
|
||||||
|
|---------|:------:|:--------:|:---------:|:-----------:|:-------:|
|
||||||
|
| `!!c` | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| `!!head` | ✅ | ✅ | ✅ | ✅ | ✅ profile |
|
||||||
|
| `!!share` | ❌ | ✅ entitydata | ✅ data get | ✅ | ✅ |
|
||||||
|
| `!!hat` | ❌ | ✅ RCON | ✅ RCON | ✅ RCON | ✅ RCON |
|
||||||
|
| MOTD / tips | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
1. Download `Iridium.mcdr`
|
||||||
|
2. Put it in MCDR `plugins/`
|
||||||
|
3. `!!MCDR reload plugin` or restart MCDR
|
||||||
|
|
||||||
|
### RCON (required for `!!hat`)
|
||||||
|
|
||||||
|
```properties
|
||||||
|
enable-rcon=true
|
||||||
|
rcon.port=25575
|
||||||
|
rcon.password=your_password
|
||||||
|
```
|
||||||
|
|
||||||
|
## Config
|
||||||
|
|
||||||
|
Path: `config/iridium/iridium.yml` (YAML with `#` comments; auto-created on first load; migrates legacy JSON configs)
|
||||||
|
|
||||||
|
| Field | Default | Description |
|
||||||
|
|------|---------|-------------|
|
||||||
|
| `permission` | `1` | Min permission for commands |
|
||||||
|
| `head_cooldown_seconds` | `60` | `!!head` cooldown; `0` = none |
|
||||||
|
| `hat_cooldown_seconds` | `3` | `!!hat` cooldown; `0` = none |
|
||||||
|
| `share_sound` | `true` | Sound on `!!share` |
|
||||||
|
| `force_version` | `""` | Force MC version; empty = auto |
|
||||||
|
| `join_tip` | `true` | Command tips on join |
|
||||||
|
| `join_tip_delay_seconds` | `1.5` | Join message delay |
|
||||||
|
| `motd_enabled` | `true` | Send join MOTD |
|
||||||
|
| `motd_start_day` | today | Server start date `YYYY-MM-DD` (day 1 = that date) |
|
||||||
|
| `motd_lines` | see file | MOTD lines with placeholders |
|
||||||
|
|
||||||
|
Default `motd_lines` (QQ group is clickable):
|
||||||
|
|
||||||
|
```text
|
||||||
|
§6Welcome §e{player}§6 !
|
||||||
|
§7Server has been open for §b{days}§7 days
|
||||||
|
§7Website: {link:§bOpen website|https://www.skymirror.top}
|
||||||
|
§7QQ: {link:§f985402607|https://skymirror.top/qq}
|
||||||
|
```
|
||||||
|
|
||||||
|
### MOTD placeholders
|
||||||
|
|
||||||
|
| Token | Meaning |
|
||||||
|
|-------|---------|
|
||||||
|
| `{player}` | Joining player |
|
||||||
|
| `{days}` / `{day}` | Days since `motd_start_day` |
|
||||||
|
| `{online}` | Online count or `?` |
|
||||||
|
| `{link:text\|https://url}` | Clickable link |
|
||||||
|
| `{link:https://url}` | Clickable URL |
|
||||||
|
| `§` | Vanilla color/style codes |
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
- Calculator: AST whitelist, no arbitrary Python
|
||||||
|
- Player names sanitized to `[A-Za-z0-9_]` before game commands
|
||||||
|
- Newlines stripped from console commands
|
||||||
|
- MOTD links limited to `http(s)` only
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
|
||||||
|
Copyright (c) 2026 云镜之端/SKYMirror.
|
||||||
|
|
||||||
|
This project is licensed under the **GNU GPL v3.0**. See `LICENSE`.
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
## Plugin
|
||||||
|
|
||||||
|
- ID: `iridium`
|
||||||
|
- Name: Iridium
|
||||||
|
- Repository: https://github.com/HzSKYMirror/Iridium
|
||||||
|
- Release: https://github.com/HzSKYMirror/Iridium/releases/tag/v26.9.14
|
||||||
|
- Labels: `tool`
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
- `!!share`:展示主手物品(悬停完整数据)
|
||||||
|
- `!!hat`:主手与头部装备互换(需 RCON)
|
||||||
|
- `!!head [player]`:获取一个玩家头颅
|
||||||
|
- `!!c <expression>`:游戏内四则运算
|
||||||
|
- 进服 MOTD 与命令提示
|
||||||
|
|
||||||
|
面向 Minecraft 1.7.10+,按版本分支;需要 MCDR >= 2.6.0。
|
||||||
|
打包插件为 `.mcdr`,GitHub Release 已附带成品。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- [x] 我已阅读并检查,此 PR 符合 [贡献指南](https://github.com/MCDReforged/PluginCatalogue/blob/master/CONTRIBUTING_zh_cn.md) 中的要求
|
||||||
|
I have read and checked that my PR meets the requirements in the [Contributing Guidelines](https://github.com/MCDReforged/PluginCatalogue/blob/master/CONTRIBUTING.md)
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
【✔】我已阅读并检查,此 PR 符合 贡献指南 中的要求
|
||||||
|
I have read and checked that my PR meets the requirements in the Contributing Guidelines
|
||||||
@@ -12,6 +12,6 @@
|
|||||||
"labels": ["tool"],
|
"labels": ["tool"],
|
||||||
"introduction": {
|
"introduction": {
|
||||||
"zh_cn": "README.md",
|
"zh_cn": "README.md",
|
||||||
"en_us": "README.md"
|
"en_us": "README_en.md"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+4
-7
@@ -1,6 +1,7 @@
|
|||||||
"""Iridium — item share / hat / head / calculator for MCDReforged.
|
"""Iridium — item share / hat / head / calculator for MCDReforged.
|
||||||
|
|
||||||
Copyright (c) 2026 云镜之端/SKYMirror. All Rights Reserved.
|
Copyright (c) 2026 云镜之端/SKYMirror.
|
||||||
|
SPDX-License-Identifier: GPL-3.0-only
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from mcdreforged.api.all import *
|
from mcdreforged.api.all import *
|
||||||
@@ -10,16 +11,12 @@ import iridium.hat as hat
|
|||||||
import iridium.head as head
|
import iridium.head as head
|
||||||
import iridium.join_tip as join_tip
|
import iridium.join_tip as join_tip
|
||||||
import iridium.share as share
|
import iridium.share as share
|
||||||
from iridium.config import CONFIG_FILE, Config, apply_config
|
from iridium.config import apply_config, load_config
|
||||||
from iridium.version_util import tr
|
from iridium.version_util import tr
|
||||||
|
|
||||||
|
|
||||||
def on_load(server: PluginServerInterface, prev_module) -> None:
|
def on_load(server: PluginServerInterface, prev_module) -> None:
|
||||||
loaded = server.load_config_simple(
|
loaded = load_config(server)
|
||||||
CONFIG_FILE,
|
|
||||||
target_class=Config,
|
|
||||||
in_data_folder=False,
|
|
||||||
)
|
|
||||||
apply_config(loaded)
|
apply_config(loaded)
|
||||||
server.logger.info(tr("loaded"))
|
server.logger.info(tr("loaded"))
|
||||||
|
|
||||||
|
|||||||
+231
-12
@@ -1,7 +1,21 @@
|
|||||||
from typing import List
|
import json
|
||||||
|
import shutil
|
||||||
|
from datetime import date
|
||||||
|
from io import StringIO
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, List, Optional
|
||||||
|
|
||||||
from mcdreforged.api.all import *
|
from mcdreforged.api.all import *
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ruamel.yaml import YAML
|
||||||
|
except ImportError: # pragma: no cover
|
||||||
|
YAML = None # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
def _today() -> str:
|
||||||
|
return date.today().strftime("%Y-%m-%d")
|
||||||
|
|
||||||
|
|
||||||
class Config(Serializable):
|
class Config(Serializable):
|
||||||
# 使用 !!share / !!hat / !!head / !!c 所需的最低权限等级
|
# 使用 !!share / !!hat / !!head / !!c 所需的最低权限等级
|
||||||
@@ -20,24 +34,69 @@ class Config(Serializable):
|
|||||||
join_tip_delay_seconds: float = 1.5
|
join_tip_delay_seconds: float = 1.5
|
||||||
# 是否发送进服 MOTD(开服天数 + 自定义行)
|
# 是否发送进服 MOTD(开服天数 + 自定义行)
|
||||||
motd_enabled: bool = True
|
motd_enabled: bool = True
|
||||||
# 开服日期,格式 YYYY-MM-DD,用于计算开服天数;留空则不显示天数
|
# 开服日期,格式 YYYY-MM-DD;默认为配置生成当天(当天算第 1 天)
|
||||||
motd_start_day: str = ""
|
motd_start_day: str = _today()
|
||||||
# MOTD 文本行。支持:
|
# MOTD 文本行
|
||||||
# {player} 玩家名
|
|
||||||
# {days} 开服天数
|
|
||||||
# {online} 在线人数(拿不到时显示 ?)
|
|
||||||
# {link:显示文字|https://url} 可点击链接
|
|
||||||
# {link:https://url} 链接,显示为完整 URL
|
|
||||||
# § 颜色代码
|
|
||||||
motd_lines: List[str] = [
|
motd_lines: List[str] = [
|
||||||
"§6欢迎 §e{player}§6 加入服务器!",
|
"§6欢迎 §e{player}§6 加入服务器!",
|
||||||
"§7服务器已开服 §b{days}§7 天",
|
"§7服务器已开服 §b{days}§7 天",
|
||||||
"§7官网: {link:§b点击打开官网|https://www.skymirror.top}",
|
"§7官网: {link:§b点击打开官网|https://www.skymirror.top}",
|
||||||
"§7QQ群: §f985402607",
|
"§7QQ群: {link:§f985402607|https://skymirror.top/qq}",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
CONFIG_FILE = "config/iridium.json"
|
# 当前配置:MCDR 数据目录 → config/iridium/iridium.yml
|
||||||
|
CONFIG_FILE_NAME = "iridium.yml"
|
||||||
|
|
||||||
|
|
||||||
|
def build_default_config_text() -> str:
|
||||||
|
"""带注释的默认 YAML 配置;开服日期为生成当天。"""
|
||||||
|
today = _today()
|
||||||
|
return f"""# Iridium 配置文件 (YAML)
|
||||||
|
# 修改后执行: !!MCDR reload plugin
|
||||||
|
# This file uses standard YAML. '#' starts a comment.
|
||||||
|
|
||||||
|
# 使用 !!share / !!hat / !!head / !!c 所需的最低权限等级
|
||||||
|
# 0=控制台 1=普通玩家 2=OP/管理员
|
||||||
|
permission: 1
|
||||||
|
|
||||||
|
# !!head 冷却时间(秒),0 表示不限制
|
||||||
|
head_cooldown_seconds: 60
|
||||||
|
|
||||||
|
# !!hat 冷却时间(秒),0 表示不限制
|
||||||
|
hat_cooldown_seconds: 3
|
||||||
|
|
||||||
|
# !!share 是否播放提示音
|
||||||
|
share_sound: true
|
||||||
|
|
||||||
|
# 强制指定 Minecraft 版本(如 "1.12.2"、"1.20.1")
|
||||||
|
# 留空则自动检测;检测失败时可手动填写
|
||||||
|
force_version: ""
|
||||||
|
|
||||||
|
# 玩家进服时是否提示可用命令
|
||||||
|
join_tip: true
|
||||||
|
|
||||||
|
# 进服消息延迟(秒),0 为立即发送
|
||||||
|
join_tip_delay_seconds: 1.5
|
||||||
|
|
||||||
|
# 是否发送进服 MOTD(开服天数 + 自定义文案)
|
||||||
|
motd_enabled: true
|
||||||
|
|
||||||
|
# 开服日期,格式 YYYY-MM-DD(当天算第 1 天)
|
||||||
|
# 默认为本配置文件生成当天,可自行修改为真实开服日
|
||||||
|
motd_start_day: "{today}"
|
||||||
|
|
||||||
|
# MOTD 文本行
|
||||||
|
# 占位符: {{player}} 玩家名 {{days}} 开服天数 {{online}} 在线人数
|
||||||
|
# 链接: {{link:显示文字|https://url}} 或 {{link:https://url}}
|
||||||
|
# 颜色: 支持原版 § 颜色代码
|
||||||
|
motd_lines:
|
||||||
|
- "§6欢迎 §e{{player}}§6 加入服务器!"
|
||||||
|
- "§7服务器已开服 §b{{days}}§7 天"
|
||||||
|
- "§7官网: {{link:§b点击打开官网|https://www.skymirror.top}}"
|
||||||
|
- "§7QQ群: {{link:§f985402607|https://skymirror.top/qq}}"
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
# 模块级单例;on_load 时原地更新字段,避免各模块持有过期引用
|
# 模块级单例;on_load 时原地更新字段,避免各模块持有过期引用
|
||||||
config = Config()
|
config = Config()
|
||||||
@@ -54,3 +113,163 @@ def apply_config(new_cfg: Config) -> None:
|
|||||||
config.motd_enabled = new_cfg.motd_enabled
|
config.motd_enabled = new_cfg.motd_enabled
|
||||||
config.motd_start_day = new_cfg.motd_start_day
|
config.motd_start_day = new_cfg.motd_start_day
|
||||||
config.motd_lines = list(new_cfg.motd_lines)
|
config.motd_lines = list(new_cfg.motd_lines)
|
||||||
|
|
||||||
|
|
||||||
|
def _yaml():
|
||||||
|
if YAML is None:
|
||||||
|
raise RuntimeError("ruamel.yaml is required")
|
||||||
|
return YAML(typ="safe")
|
||||||
|
|
||||||
|
|
||||||
|
def _load_yaml_text(text: str) -> Any:
|
||||||
|
return _yaml().load(StringIO(text))
|
||||||
|
|
||||||
|
|
||||||
|
def _dump_yaml(data: dict) -> str:
|
||||||
|
buf = StringIO()
|
||||||
|
y = _yaml()
|
||||||
|
y.default_flow_style = False
|
||||||
|
y.dump(data, buf)
|
||||||
|
return buf.getvalue()
|
||||||
|
|
||||||
|
|
||||||
|
def _strip_json_comments(text: str) -> str:
|
||||||
|
"""Remove // line comments outside of strings (legacy JSON only)."""
|
||||||
|
out = []
|
||||||
|
i = 0
|
||||||
|
n = len(text)
|
||||||
|
in_string = False
|
||||||
|
while i < n:
|
||||||
|
c = text[i]
|
||||||
|
if in_string:
|
||||||
|
out.append(c)
|
||||||
|
if c == "\\" and i + 1 < n:
|
||||||
|
out.append(text[i + 1])
|
||||||
|
i += 2
|
||||||
|
continue
|
||||||
|
if c == '"':
|
||||||
|
in_string = False
|
||||||
|
i += 1
|
||||||
|
continue
|
||||||
|
if c == '"':
|
||||||
|
in_string = True
|
||||||
|
out.append(c)
|
||||||
|
i += 1
|
||||||
|
continue
|
||||||
|
if c == "/" and i + 1 < n and text[i + 1] == "/":
|
||||||
|
while i < n and text[i] != "\n":
|
||||||
|
i += 1
|
||||||
|
continue
|
||||||
|
out.append(c)
|
||||||
|
i += 1
|
||||||
|
return "".join(out)
|
||||||
|
|
||||||
|
|
||||||
|
def config_file_path(server: PluginServerInterface) -> Path:
|
||||||
|
"""Canonical path: MCDR data folder → config/iridium/iridium.yml"""
|
||||||
|
return Path(server.get_data_folder()) / CONFIG_FILE_NAME
|
||||||
|
|
||||||
|
|
||||||
|
def _working_dir(server: PluginServerInterface) -> Path:
|
||||||
|
try:
|
||||||
|
wd = server.get_mcdr_config().get("working_directory") or "."
|
||||||
|
return Path(wd).expanduser()
|
||||||
|
except Exception:
|
||||||
|
return Path.cwd()
|
||||||
|
|
||||||
|
|
||||||
|
def _legacy_json_paths(server: PluginServerInterface) -> List[Path]:
|
||||||
|
data_dir = Path(server.get_data_folder())
|
||||||
|
wd = _working_dir(server)
|
||||||
|
return [
|
||||||
|
data_dir / "iridium.json",
|
||||||
|
wd / "config" / "iridium.json",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _write_default(path: Path, server: PluginServerInterface) -> bool:
|
||||||
|
try:
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
path.write_text(build_default_config_text(), encoding="utf-8")
|
||||||
|
server.logger.info(f"已生成配置文件: {path}")
|
||||||
|
return True
|
||||||
|
except Exception as e:
|
||||||
|
server.logger.error(f"写入配置文件失败 {path}: {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _try_load_dict_from_text(text: str) -> Optional[dict]:
|
||||||
|
text = text.strip()
|
||||||
|
if not text:
|
||||||
|
return None
|
||||||
|
if text.startswith("{"):
|
||||||
|
return json.loads(_strip_json_comments(text))
|
||||||
|
data = _load_yaml_text(text)
|
||||||
|
return data if isinstance(data, dict) else None
|
||||||
|
|
||||||
|
|
||||||
|
def _migrate_legacy_json(server: PluginServerInterface, dest: Path) -> None:
|
||||||
|
"""Convert old JSON config (with optional // comments) to YAML if dest is missing."""
|
||||||
|
if dest.is_file():
|
||||||
|
return
|
||||||
|
for src in _legacy_json_paths(server):
|
||||||
|
try:
|
||||||
|
if not src.is_file():
|
||||||
|
continue
|
||||||
|
raw = src.read_text(encoding="utf-8")
|
||||||
|
data = _try_load_dict_from_text(raw)
|
||||||
|
if not data:
|
||||||
|
continue
|
||||||
|
dest.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
# keep comments in default template + overlay known keys via dump
|
||||||
|
cfg = Config.deserialize(data)
|
||||||
|
overlay = {
|
||||||
|
"permission": cfg.permission,
|
||||||
|
"head_cooldown_seconds": cfg.head_cooldown_seconds,
|
||||||
|
"hat_cooldown_seconds": cfg.hat_cooldown_seconds,
|
||||||
|
"share_sound": cfg.share_sound,
|
||||||
|
"force_version": cfg.force_version,
|
||||||
|
"join_tip": cfg.join_tip,
|
||||||
|
"join_tip_delay_seconds": cfg.join_tip_delay_seconds,
|
||||||
|
"motd_enabled": cfg.motd_enabled,
|
||||||
|
"motd_start_day": cfg.motd_start_day,
|
||||||
|
"motd_lines": list(cfg.motd_lines),
|
||||||
|
}
|
||||||
|
# Prefer commented default template when values match defaults is complex;
|
||||||
|
# dump parsed values with a short header for clarity.
|
||||||
|
header = (
|
||||||
|
"# Iridium 配置 (从旧 JSON 迁移)\n"
|
||||||
|
"# Migrated from legacy JSON config\n\n"
|
||||||
|
)
|
||||||
|
dest.write_text(header + _dump_yaml(overlay), encoding="utf-8")
|
||||||
|
server.logger.info(f"已从旧 JSON 迁移配置: {src} -> {dest}")
|
||||||
|
return
|
||||||
|
except Exception as e:
|
||||||
|
server.logger.warning(f"迁移旧配置失败 {src}: {e}")
|
||||||
|
|
||||||
|
|
||||||
|
def load_config(server: PluginServerInterface) -> Config:
|
||||||
|
"""
|
||||||
|
Load config/iridium/iridium.yml (MCDR data folder).
|
||||||
|
Create commented default if missing; migrate legacy JSON if needed.
|
||||||
|
"""
|
||||||
|
path = config_file_path(server)
|
||||||
|
_migrate_legacy_json(server, path)
|
||||||
|
|
||||||
|
if not path.is_file():
|
||||||
|
_write_default(path, server)
|
||||||
|
|
||||||
|
if not path.is_file():
|
||||||
|
server.logger.warning(f"配置文件不存在且无法创建,使用内存默认值: {path}")
|
||||||
|
return Config()
|
||||||
|
|
||||||
|
try:
|
||||||
|
raw = path.read_text(encoding="utf-8")
|
||||||
|
data = _load_yaml_text(raw)
|
||||||
|
if not isinstance(data, dict):
|
||||||
|
raise ValueError("YAML root must be a mapping")
|
||||||
|
server.logger.info(f"配置已加载: {path}")
|
||||||
|
return Config.deserialize(data)
|
||||||
|
except Exception as e:
|
||||||
|
server.logger.error(f"读取/解析 YAML 配置失败 {path}: {e},使用默认值")
|
||||||
|
return Config()
|
||||||
@@ -260,7 +260,6 @@ def _extract_item_payload(payload: str, version: Version) -> Optional[str]:
|
|||||||
def _do_swap(server: PluginServerInterface, src: CommandSource, player: str, version: Version) -> bool:
|
def _do_swap(server: PluginServerInterface, src: CommandSource, player: str, version: Version) -> bool:
|
||||||
name = sanitize_name(player)
|
name = sanitize_name(player)
|
||||||
head_slot = _head_slot(version)
|
head_slot = _head_slot(version)
|
||||||
hand_slot = _hand_slot(version, 0)
|
|
||||||
|
|
||||||
# 1.17+: true swap via offhand buffer — no need to rebuild item NBT
|
# 1.17+: true swap via offhand buffer — no need to rebuild item NBT
|
||||||
if is_at_least(version, "1.17"):
|
if is_at_least(version, "1.17"):
|
||||||
|
|||||||
+3
-4
@@ -175,10 +175,9 @@ def build_motd(player: str, server: ServerInterface) -> Optional[RTextList]:
|
|||||||
lines = list(config.motd_lines or [])
|
lines = list(config.motd_lines or [])
|
||||||
if not lines:
|
if not lines:
|
||||||
return None
|
return None
|
||||||
parts: List[RText] = [
|
parts: List[RText] = []
|
||||||
RText(tr("motd_header"), RColor.gold, styles=[RStyle.bold])
|
for i, line in enumerate(lines):
|
||||||
]
|
if i:
|
||||||
for line in lines:
|
|
||||||
parts.append(RText("\n"))
|
parts.append(RText("\n"))
|
||||||
parts.extend(render_motd_line(line, player, server))
|
parts.extend(render_motd_line(line, player, server))
|
||||||
# Only auto-append the day footer when no line already uses {days}/{day}
|
# Only auto-append the day footer when no line already uses {days}/{day}
|
||||||
|
|||||||
@@ -6,8 +6,6 @@ from iridium.config import config
|
|||||||
|
|
||||||
# Fallback strings when ServerInterface is unavailable (unit tests / early import)
|
# Fallback strings when ServerInterface is unavailable (unit tests / early import)
|
||||||
_FALLBACK = {
|
_FALLBACK = {
|
||||||
"click_copy": "click to copy data",
|
|
||||||
"click_suggest": "click for data command",
|
|
||||||
"calc_usage": "Usage: !!c <expression>",
|
"calc_usage": "Usage: !!c <expression>",
|
||||||
"share_showing": "is showing",
|
"share_showing": "is showing",
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-4
@@ -11,8 +11,6 @@ iridium.share_help: 'Show the item in your main hand (hover to view)'
|
|||||||
iridium.share_done: 'Item shared to chat'
|
iridium.share_done: 'Item shared to chat'
|
||||||
iridium.share_unsupported_version: 'Version {0} cannot read held item (needs Minecraft 1.8+)'
|
iridium.share_unsupported_version: 'Version {0} cannot read held item (needs Minecraft 1.8+)'
|
||||||
iridium.share_timeout: 'Timed out reading held item, try again later'
|
iridium.share_timeout: 'Timed out reading held item, try again later'
|
||||||
iridium.click_copy: 'click to copy data'
|
|
||||||
iridium.click_suggest: 'click for data command'
|
|
||||||
iridium.share_showing: 'is showing'
|
iridium.share_showing: 'is showing'
|
||||||
iridium.hat_help: 'Swap the item in your hand with your head slot'
|
iridium.hat_help: 'Swap the item in your hand with your head slot'
|
||||||
iridium.hat_success: 'Swapped hand item with head equipment'
|
iridium.hat_success: 'Swapped hand item with head equipment'
|
||||||
@@ -27,7 +25,6 @@ iridium.calc_help: 'Evaluate an expression, e.g. !!c 1+2*(3-1)'
|
|||||||
iridium.calc_usage: 'Usage: !!c <expression>, e.g. !!c 1+2*(3-1)'
|
iridium.calc_usage: 'Usage: !!c <expression>, e.g. !!c 1+2*(3-1)'
|
||||||
iridium.calc_error: 'Cannot calculate {0}: {1}'
|
iridium.calc_error: 'Cannot calculate {0}: {1}'
|
||||||
iridium.calc_div_zero: 'Division by zero'
|
iridium.calc_div_zero: 'Division by zero'
|
||||||
iridium.join_tip_header: 'Iridium is enabled. Available commands: (click to fill chat)'
|
iridium.join_tip_header: 'Available commands: (click to fill chat)'
|
||||||
iridium.join_tip_click: 'click to fill chat'
|
iridium.join_tip_click: 'click to fill chat'
|
||||||
iridium.motd_header: 'Server Info'
|
|
||||||
iridium.motd_days: 'Day {0} since server start'
|
iridium.motd_days: 'Day {0} since server start'
|
||||||
+1
-4
@@ -11,8 +11,6 @@ iridium.share_help: '展示手上物品的完整信息(悬停查看)'
|
|||||||
iridium.share_done: '已在聊天栏展示物品'
|
iridium.share_done: '已在聊天栏展示物品'
|
||||||
iridium.share_unsupported_version: '当前版本 {0} 无法读取手持物品(需要 Minecraft 1.8+)'
|
iridium.share_unsupported_version: '当前版本 {0} 无法读取手持物品(需要 Minecraft 1.8+)'
|
||||||
iridium.share_timeout: '读取手持物品超时,请稍后再试'
|
iridium.share_timeout: '读取手持物品超时,请稍后再试'
|
||||||
iridium.click_copy: '点击复制完整数据'
|
|
||||||
iridium.click_suggest: '点击获取完整数据命令'
|
|
||||||
iridium.share_showing: '正在展示'
|
iridium.share_showing: '正在展示'
|
||||||
iridium.hat_help: '将手上物品与头部装备互换'
|
iridium.hat_help: '将手上物品与头部装备互换'
|
||||||
iridium.hat_success: '已交换手上物品与头部装备'
|
iridium.hat_success: '已交换手上物品与头部装备'
|
||||||
@@ -27,7 +25,6 @@ iridium.calc_help: '计算表达式,例如 !!c 1+2*(3-1)'
|
|||||||
iridium.calc_usage: '用法: !!c <表达式>,例如 !!c 1+2*(3-1)'
|
iridium.calc_usage: '用法: !!c <表达式>,例如 !!c 1+2*(3-1)'
|
||||||
iridium.calc_error: '无法计算 {0}: {1}'
|
iridium.calc_error: '无法计算 {0}: {1}'
|
||||||
iridium.calc_div_zero: '除数不能为 0'
|
iridium.calc_div_zero: '除数不能为 0'
|
||||||
iridium.join_tip_header: '本服已启用 Iridium,可用命令:(点击命令可填入聊天框)'
|
iridium.join_tip_header: '可用命令:(点击命令可填入聊天框)'
|
||||||
iridium.join_tip_click: '点击填入聊天栏'
|
iridium.join_tip_click: '点击填入聊天栏'
|
||||||
iridium.motd_header: '服务器信息'
|
|
||||||
iridium.motd_days: '开服第 {0} 天'
|
iridium.motd_days: '开服第 {0} 天'
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"id": "iridium",
|
"id": "iridium",
|
||||||
"version": "26.9.8",
|
"version": "26.9.14",
|
||||||
"name": "Iridium",
|
"name": "Iridium",
|
||||||
"description": {
|
"description": {
|
||||||
"zh_cn": "物品展示 / 戴头 / 获取头颅 / 游戏内计算器 / 进服 MOTD",
|
"zh_cn": "物品展示 / 戴头 / 获取头颅 / 游戏内计算器 / 进服 MOTD",
|
||||||
|
|||||||
+32
-1
@@ -1,6 +1,7 @@
|
|||||||
"""Pure-function unit tests (no live MCDR server required)."""
|
"""Pure-function unit tests (no live MCDR server required)."""
|
||||||
import sys
|
import json
|
||||||
import os
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||||
|
|
||||||
@@ -267,6 +268,36 @@ def test_extract_display_name():
|
|||||||
assert "kubejs:time_twister_wireless" not in disp
|
assert "kubejs:time_twister_wireless" not in disp
|
||||||
|
|
||||||
|
|
||||||
|
def test_strip_json_comments():
|
||||||
|
from datetime import date
|
||||||
|
|
||||||
|
from iridium.config import _strip_json_comments, build_default_config_text
|
||||||
|
|
||||||
|
# legacy JSON comment stripper still works
|
||||||
|
assert json.loads(_strip_json_comments('{"a": 1 // x\n}'))["a"] == 1
|
||||||
|
assert json.loads(_strip_json_comments('{"a": "http://x"}'))["a"] == "http://x"
|
||||||
|
|
||||||
|
|
||||||
|
def test_default_yaml_config():
|
||||||
|
from datetime import date
|
||||||
|
|
||||||
|
from iridium.config import _load_yaml_text, build_default_config_text
|
||||||
|
|
||||||
|
data = _load_yaml_text(build_default_config_text())
|
||||||
|
assert data["permission"] == 1
|
||||||
|
assert data["motd_start_day"] == date.today().strftime("%Y-%m-%d")
|
||||||
|
assert any("skymirror.top" in line for line in data["motd_lines"])
|
||||||
|
assert any("skymirror.top/qq" in line for line in data["motd_lines"])
|
||||||
|
|
||||||
|
|
||||||
|
def test_legacy_json_to_yaml_parse():
|
||||||
|
from iridium.config import _try_load_dict_from_text
|
||||||
|
|
||||||
|
assert _try_load_dict_from_text('{"permission": 2}')["permission"] == 2
|
||||||
|
assert _try_load_dict_from_text('{\n // c\n "permission": 3\n} ')["permission"] == 3
|
||||||
|
assert _try_load_dict_from_text("permission: 4\nmotd_start_day: '2020-01-01'\n")["permission"] == 4
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
fns = [v for k, v in sorted(globals().items()) if k.startswith("test_") and callable(v)]
|
fns = [v for k, v in sorted(globals().items()) if k.startswith("test_") and callable(v)]
|
||||||
failed = 0
|
failed = 0
|
||||||
|
|||||||
Reference in new issue
Block a user