├── .gitignore ├── PCRC-MCDR ├── 在这放入PCRC文件 └── Put files of PCRC here ├── readme_cn.md ├── readme.md ├── PCRC-MCDR.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea -------------------------------------------------------------------------------- /PCRC-MCDR/在这放入PCRC文件: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /PCRC-MCDR/Put files of PCRC here: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /readme_cn.md: -------------------------------------------------------------------------------- 1 | PCRC-MCDR 2 | ---------- 3 | 4 | [English](https://github.com/TISUnion/PCRC-MCDR/blob/master/readme.md) 5 | 6 | 将 [PCRC](https://github.com/Fallen-Breath/PCRC/blob/master/readme_cn.md) 作为一个插件导入至 [MCDReforged](https://github.com/Fallen-Breath/MCDReforged)! 7 | 8 | ## 使用方法 9 | 10 | 1. 将 `PCRC-MCDR.py` 放入 MCDR 的 `plugins/` 文件夹 11 | 2. 在 PCRC 的 [Release 页面](https://github.com/Fallen-Breath/PCRC/releases) 下载不低于 `0.9.0-alpha` 版本的 universal 版 PCRC，将压缩包解压至 `plugins/PCRC-xxx-universal/` 12 | 3. 将 `plugins/` 文件夹中 `PCRC-xxx-universal/` 文件夹重命名为 `PCRC-MCDR/` 文件夹 13 | 4. 安装 PCRC 的所有[依赖库](https://github.com/Fallen-Breath/PCRC/blob/master/readme_cn.md#python-模块) 14 | 5. 此时 MCDR 的文件结构大致如下 15 | 16 | ``` 17 | MCDReforged/ 18 | ├─ plugins/ 19 | │ ├─ PCRC-MCDR/ 20 | │ │ ├─ PCRC.py 21 | │ │ ├─ protocol.json 22 | │ │ ├─ config.json 23 | │ │ └─ ... 24 | │ ├─ PCRC-MCDR.py 25 | │ ├─ other_plugin.py 26 | │ └─ ... 27 | └─ ... 28 | ``` 29 | 30 | PCRC 的配置文件将为 `MCDReforged/plugins/PCRC/config.json`，记得去填写 31 | 32 | 录像文件将会存放至 `MCDReforged/PCRC_recordings/` 33 | 34 | ## 指令 35 | 36 | - `!!PCRC start`: 启动 PCRC 37 | - `!!PCRC stop`: 关闭 PCRC。仅在控制台可用 38 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | [PCRC](https://github.com/Fallen-Breath/PCRC) v1.0+ includes MCDR support already, so no need for this adaptor plugin if you are using MCDR >= 2.0 2 | 3 | ------------- 4 | 5 | PCRC-MCDR 6 | ---------- 7 | 8 | [中文](https://github.com/TISUnion/PCRC-MCDR/blob/master/readme_cn.md) 9 | 10 | Import [PCRC](https://github.com/Fallen-Breath/PCRC) as a [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) plugin! 11 | 12 | ## Usage 13 | 14 | 1. Put `PCRC-MCDR.py` into the `plugins/` folder of MCDR 15 | 2. Download universal release of PCRC with version not less than `0.9.0-alpha` in PCRC [release page](https://github.com/Fallen-Breath/PCRC/releases), extract it to `plugins/PCRC-xxx-universal/` 16 | 3. Rename `PCRC-xxx-universal/` folder in `plugins/` folder to `PCRC-MCDR/` 17 | 4. Install all [requirement modules](https://github.com/Fallen-Breath/PCRC#python-modules) of PCRC 18 | 5. At this time, the file structure of MCDR is roughly as follows 19 | 20 | ``` 21 | MCDReforged/ 22 | ├─ plugins/ 23 | │ ├─ PCRC-MCDR/ 24 | │ │ ├─ PCRC.py 25 | │ │ ├─ protocol.json 26 | │ │ ├─ config.json 27 | │ │ └─ ... 28 | │ ├─ PCRC-MCDR.py 29 | │ ├─ other_plugin.py 30 | │ └─ ... 31 | └─ ... 32 | ``` 33 | 34 | The PCRC configuration file will be `MCDReforged/plugins/PCRC/config.json`. Remember to fill it 35 | 36 | The replay recording file will be stored in `MCDReforged/PCRC_recordings/` 37 | 38 | ## Command 39 | 40 | - `!!PCRC start`: Start PCRC 41 | - `!!PCRC stop`: Stop PCRC. Only works with console command input 42 | -------------------------------------------------------------------------------- /PCRC-MCDR.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | import importlib 3 | import time 4 | 5 | from mcdreforged.api.all import * 6 | 7 | PLUGIN_METADATA = { 8 | 'id': 'pcrc_mcdr', 9 | 'version': '1.0.0', 10 | 'name': 'PCRC MCDR', 11 | 'description': 'a MCDR plugin wrapper for PCRC', 12 | 'author': 'Fallen_Breath', 13 | 'link': 'https://github.com/TISUnion/PCRC-MCDR' 14 | } 15 | 16 | PCRC = None 17 | PREFIX = '!!PCRC' 18 | 19 | # 0=guest 1=user 2=helper 3=admin 20 | Permission = 1 21 | 22 | 23 | def permission_check(server, info, perm): 24 | if info.is_user: 25 | if info.source == 1: 26 | return True 27 | elif server.get_permission_level(info) >= perm: 28 | return True 29 | return False 30 | 31 | 32 | def load_PCRC(): 33 | global PCRC 34 | PCRC = importlib.import_module('PCRC-MCDR.PCRC') 35 | 36 | 37 | @new_thread('PCRC-MCDR') 38 | def on_user_info(server, info): 39 | if PCRC is not None: 40 | if permission_check(server, info, Permission) and info.content == '!!PCRC start': 41 | server.reply(info, 'Starting PCRC') 42 | if PCRC.is_working(): 43 | server.reply(info, 'PCRC is already running!') 44 | else: 45 | PCRC.start() 46 | if info.source == 1 and info.content == '!!PCRC stop': 47 | if PCRC.is_working(): 48 | PCRC.stop() 49 | else: 50 | server.reply(info, 'PCRC is not running!') 51 | 52 | 53 | def on_load(server, old): 54 | global PCRC 55 | try: 56 | if old is not None and old.PCRC is not None and old.PCRC.is_working(): 57 | PCRC = old.PCRC 58 | else: 59 | load_PCRC() 60 | except: 61 | load_PCRC() 62 | 63 | 64 | def stopping(server): 65 | global PCRC 66 | if PCRC is None: 67 | return 68 | if PCRC.is_working(): 69 | PCRC.stop() 70 | else: 71 | for i in range(600): 72 | if not PCRC.is_stopped(): 73 | server.logger.info('Waiting for PCRC to stop') 74 | for i in range(10): 75 | if not PCRC.is_stopped(): 76 | time.sleep(0.1) 77 | if not PCRC.is_stopped(): 78 | server.logger.info('PCRC took too long to stop (more than 10min)! Exit anyway') 79 | 80 | 81 | def on_mcdr_stop(server): 82 | stopping(server) 83 | 84 | 85 | @new_thread('PCRC-MCDR') 86 | def on_remove(server): 87 | stopping(server) 88 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------