├── .editorconfig ├── .github ├── WhereIsTheGreenButton.png └── workflows │ └── Gradle CI.yml ├── .gitignore ├── .run └── RunMiraiKt.run.xml ├── LICENSE ├── README.md ├── build.gradle.kts ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle.kts └── src ├── main ├── kotlin │ └── top │ │ └── colter │ │ └── mirai │ │ └── plugin │ │ └── welcome │ │ ├── GroupCommand.kt │ │ ├── PluginMain.kt │ │ ├── WelcomeCommand.kt │ │ ├── WelcomePluginConfig.kt │ │ └── WelcomePluginData.kt └── resources │ └── META-INF │ └── services │ └── net.mamoe.mirai.console.plugin.jvm.JvmPlugin └── test └── kotlin └── RunMirai.kt /.editorconfig: -------------------------------------------------------------------------------- 1 | [*.{kt, kts}] 2 | max_line_length = 120 3 | tab_width = 4 4 | ij_continuation_indent_size = 4 5 | indent_size = 4 -------------------------------------------------------------------------------- /.github/WhereIsTheGreenButton.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Colter23/simple-welcome-plugin/7dc3dd478395d96fb7641e9855fc5a778d548cff/.github/WhereIsTheGreenButton.png -------------------------------------------------------------------------------- /.github/workflows/Gradle CI.yml: -------------------------------------------------------------------------------- 1 | name: Gradle CI 2 | 3 | # Controls when the action will run. 4 | on: 5 | # Triggers the workflow on push and pull request events but only for the master branch 6 | push: 7 | branches: 8 | - master 9 | pull_request: 10 | branches: 11 | - master 12 | 13 | # Allows to run this workflow manually from the Actions tab 14 | workflow_dispatch: 15 | 16 | jobs: 17 | 18 | build: 19 | 20 | name: Gradle-Build 21 | 22 | # The type of runner that the job will run on 23 | runs-on: ubuntu-20.04 24 | 25 | # Steps represent a sequence of tasks that will be executed as part of the job 26 | steps: 27 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 28 | - name: Checkout 29 | uses: actions/checkout@v2 30 | 31 | # Setup JDK 32 | - name: Setup Java JDK 33 | uses: actions/setup-java@v1.4.3 34 | with: 35 | java-version: 11 36 | 37 | # Validate Gradle Wrapper 38 | - name: Gradle Wrapper Validation 39 | uses: gradle/wrapper-validation-action@v1.0.3 40 | 41 | # Build 42 | - name: Make gradlew executable 43 | run: chmod +x ./gradlew 44 | - name: Build with Gradle 45 | run: ./gradlew build 46 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Project exclude paths 2 | /.gradle/ 3 | /gradle/ 4 | /build/ 5 | /.idea/ 6 | /test/ 7 | /out/ 8 | /run/ 9 | /.run/ 10 | /config/ 11 | /data/ 12 | /bots/ 13 | /plugins/ -------------------------------------------------------------------------------- /.run/RunMiraiKt.run.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SimpleWelcomePlugin 2 | 3 | > [Mirai 插件](https://github.com/mamoe/mirai) 4 | 5 | ## 简介 6 | 进群欢迎、管理Bot好友/群请求 7 | 分组管理权限 8 | 9 | 当Bot有好友请求或者邀请bot进群，就会给管理员发送消息，管理员进行处理 10 | 可以自动处理 11 | 12 | ## 下载 13 | 前往 [releases](https://github.com/Colter23/simple-welcome-plugin/releases) 下载并放到 `plugin` 文件夹中 14 | 15 | ## 配置 16 | ```yaml 17 | # 管理员QQ号(只能是QQ号) 18 | admin: 11111111 19 | 20 | # 好友申请 21 | # 0: 仅发送通知 22 | # 1: 自动拒绝 23 | # 2: 自动同意 24 | # 3: 管理员审核 25 | newFriendRequest: 3 26 | 27 | # 邀请Bot加群申请 28 | # 0: 仅发送通知 29 | # 1: 自动拒绝 30 | # 2: 自动同意 31 | # 3: 管理员审核 32 | botInvitedJoinGroupRequest: 3 33 | 34 | # 新好友欢迎语(目前仅bot自动同意才会发送) 35 | # 如不需要请填写 '' 两个单引号 36 | friendWelcomeMessage: '' 37 | 38 | # 新成员加群欢迎语(需要授权, 后文有说明) 39 | # 如不需要请填写 '' 两个单引号 40 | groupWelcomeMessage: '' 41 | 42 | ``` 43 | 44 | ## 使用 45 | 对于新成员加群欢迎功能，授权 = 开启 46 | 授权权限 `group:welcome.message` 47 | 例: 48 | 对所有群开启 `/perm add g* group:welcome.message` 49 | 对某个群开启 `/perm add g111111111 group:welcome.message` 50 | 51 | ### 指令 52 | 53 | | 指令 | 描述 | 54 | |------------------------------------------|---------------------------------| 55 | | `/wlc [页]` | 分页获取bot所加的群 | 56 | | `/wlc [页]` | 分页获取bot的好友 | 57 | | `/group <分组名>` | 创建一个分组 | 58 | | `/group <分组名>` | 删除一个分组 | 59 | | `/group <分组名> <群/Q号>` | 向分组中添加一个用户(支持批量导入, qq号之间通过逗号隔开) | 60 | | `/group <分组名> <群/Q号>` | 从分组中删除一个用户 | 61 | | `/group [分组名]` | 查询分组列表及分组权限 | 62 | | `/group <分组名> <权限字符串>` | 为分组授权 | 63 | | `/group <分组名> <权限字符串>` | 取消分组授权 | 64 | ``` 65 | 栗子: 66 | /wlc g # 获取bot第一页群(每页10个) 67 | /wlc group 2 # 获取bot第二页群(每页10个) 68 | 69 | /group create 分组1 70 | /group add 分组1 12345678,46545323,56465466 71 | /group list # 列出所有分组 72 | /group list 分组1 # 列出 分组1 的权限 73 | /group perm 分组1 group:welcome.message # 为分组添加权限 74 | ``` 75 | 以上指令需要 [在聊天环境执行指令](https://github.com/project-mirai/chat-command) 插件 76 | 77 | 对于开启了群欢迎功能的群，可以在群内使用 `#r` 获取一个随机骰子 78 | 79 | 80 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | val kotlinVersion = "1.6.10" 3 | kotlin("jvm") version kotlinVersion 4 | kotlin("plugin.serialization") version kotlinVersion 5 | 6 | id("net.mamoe.mirai-console") version "2.10.1" 7 | } 8 | 9 | group = "top.colter" 10 | version = "1.1.0" 11 | 12 | repositories { 13 | mavenLocal() 14 | maven("https://maven.aliyun.com/repository/public") // 阿里云国内代理仓库 15 | mavenCentral() 16 | } 17 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Colter23/simple-welcome-plugin/7dc3dd478395d96fb7641e9855fc5a778d548cff/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | mavenLocal() 4 | gradlePluginPortal() 5 | mavenCentral() 6 | maven("https://dl.bintray.com/kotlin/kotlin-eap") 7 | } 8 | } 9 | rootProject.name = "simple-welcome-plugin" -------------------------------------------------------------------------------- /src/main/kotlin/top/colter/mirai/plugin/welcome/GroupCommand.kt: -------------------------------------------------------------------------------- 1 | package top.colter.mirai.plugin.welcome 2 | 3 | import net.mamoe.mirai.Bot 4 | import net.mamoe.mirai.console.command.CommandSender 5 | import net.mamoe.mirai.console.command.CompositeCommand 6 | import net.mamoe.mirai.console.permission.AbstractPermitteeId 7 | import net.mamoe.mirai.console.permission.PermissionId 8 | import net.mamoe.mirai.console.permission.PermissionService 9 | import net.mamoe.mirai.console.permission.PermissionService.Companion.cancel 10 | import net.mamoe.mirai.console.permission.PermissionService.Companion.permit 11 | 12 | object GroupCommand : CompositeCommand( 13 | owner = PluginMain, 14 | "group" 15 | ) { 16 | 17 | @SubCommand("create", "创建") 18 | suspend fun CommandSender.create(name: String) { 19 | if (WelcomePluginData.group[name] != null){ 20 | sendMessage("$name 组已存在") 21 | }else{ 22 | WelcomePluginData.group[name] = mutableListOf() 23 | sendMessage("创建成功") 24 | } 25 | } 26 | 27 | @SubCommand("del", "删除") 28 | suspend fun CommandSender.del(name: String) { 29 | //TODO 删除组前确认 30 | if (WelcomePluginData.group[name] != null){ 31 | WelcomePluginData.group.remove(name) 32 | WelcomePluginData.groupPerm.remove(name) 33 | sendMessage("$name 组删除成功") 34 | }else{ 35 | sendMessage("没有这个组哦") 36 | } 37 | } 38 | 39 | @SubCommand("add", "添加") 40 | suspend fun CommandSender.add(groupName: String, contacts: String) { 41 | val group = WelcomePluginData.group[groupName] 42 | if (group != null){ 43 | var failMsg = "" 44 | group.addAll(contacts.split(",","，").map { 45 | val c = formatContact(it) 46 | if (c == "") failMsg += "$it, " 47 | return@map c 48 | }.filter { it.isNotEmpty() }) 49 | val perm = WelcomePluginData.groupPerm[groupName]?.map { PermissionId.parseFromString(it) } 50 | if (perm != null){ 51 | PermissionService.INSTANCE.getRegisteredPermissions().forEach {p -> 52 | if (perm.contains(p.id)){ 53 | WelcomePluginData.group.filterKeys { g -> g == groupName }.values.forEach { c -> 54 | c.forEach { v -> AbstractPermitteeId.parseFromString(v).permit(p) } 55 | } 56 | } 57 | } 58 | } 59 | 60 | if (failMsg.isEmpty()){ 61 | sendMessage("添加成功") 62 | }else{ 63 | sendMessage("$failMsg 未找到") 64 | } 65 | }else{ 66 | sendMessage("没有这个组哦") 67 | } 68 | } 69 | 70 | @SubCommand("ban") 71 | suspend fun CommandSender.ban(groupName: String, contacts: String) { 72 | val group = WelcomePluginData.group[groupName] 73 | if (group != null){ 74 | var failMsg = "" 75 | val conList = contacts.split(",","，").map { 76 | val c = formatContact(it) 77 | if (c == "") failMsg += "$it, " 78 | return@map c 79 | }.filter { it.isNotEmpty() } 80 | group.removeAll(conList) 81 | WelcomePluginData.groupPerm[groupName]?.forEach { perm -> 82 | PermissionService.INSTANCE.getRegisteredPermissions().forEach { 83 | if (it.id == PermissionId.parseFromString(perm)){ 84 | conList.forEach { c -> 85 | AbstractPermitteeId.parseFromString(c).cancel(it, false) 86 | } 87 | } 88 | } 89 | } 90 | if (failMsg.isEmpty()){ 91 | sendMessage("删除成功") 92 | }else{ 93 | sendMessage("$failMsg 未找到") 94 | } 95 | }else{ 96 | sendMessage("没有这个组哦") 97 | } 98 | } 99 | 100 | @SubCommand("list", "列表") 101 | suspend fun CommandSender.list(groupName: String = "") { 102 | if (groupName.isEmpty()) { 103 | sendMessage(buildString { 104 | WelcomePluginData.group.keys.forEach { appendLine(it) } 105 | appendLine("输入具体的组名查看组成员和权限") 106 | }) 107 | } else { 108 | val group = WelcomePluginData.group[groupName] 109 | if (group != null) { 110 | sendMessage(buildString { 111 | appendLine("组: $groupName") 112 | group.forEach { appendLine(it) } 113 | WelcomePluginData.groupPerm[groupName]?.forEach { 114 | appendLine(it) 115 | } 116 | }) 117 | }else{ 118 | sendMessage("没有这个组哦") 119 | } 120 | } 121 | } 122 | 123 | @SubCommand("perm", "授权") 124 | suspend fun CommandSender.perm(groupName: String, permStr: String) { 125 | val group = WelcomePluginData.group[groupName] 126 | if (group != null){ 127 | val perm: PermissionId 128 | try { 129 | perm = PermissionId.parseFromString(permStr) 130 | }catch (e: Exception){ 131 | sendMessage("权限错误, 请用 /perm lp 查看所有权限") 132 | return 133 | } 134 | PermissionService.INSTANCE.getRegisteredPermissions().forEach { 135 | if (it.id == perm){ 136 | WelcomePluginData.group.filterKeys { g -> g == groupName }.values.forEach { c -> 137 | c.forEach { v -> AbstractPermitteeId.parseFromString(v).permit(it) } 138 | } 139 | if (WelcomePluginData.groupPerm[groupName] == null){ 140 | WelcomePluginData.groupPerm[groupName] = mutableListOf(permStr) 141 | }else{ 142 | WelcomePluginData.groupPerm[groupName]?.add(permStr) 143 | } 144 | sendMessage("添加成功") 145 | return 146 | } 147 | } 148 | sendMessage("未找到此权限, 请用 /perm lp 查看所有权限") 149 | }else{ 150 | sendMessage("没有这个组哦") 151 | } 152 | } 153 | 154 | @SubCommand("denyPerm", "取消授权") 155 | suspend fun CommandSender.denyPerm(groupName: String, permStr: String) { 156 | val group = WelcomePluginData.group[groupName] 157 | if (group != null){ 158 | val perm: PermissionId 159 | try { 160 | perm = PermissionId.parseFromString(permStr) 161 | }catch (e: Exception){ 162 | sendMessage("权限错误, 请用 /perm lp 查看所有权限") 163 | return 164 | } 165 | if (WelcomePluginData.groupPerm[groupName]?.contains(permStr) == true){ 166 | PermissionService.INSTANCE.getRegisteredPermissions().forEach { 167 | if (it.id == perm){ 168 | WelcomePluginData.group.filterKeys { g -> g == groupName }.values.forEach { c -> 169 | c.forEach { v -> AbstractPermitteeId.parseFromString(v).cancel(it, false) } 170 | } 171 | WelcomePluginData.groupPerm[groupName]?.remove(permStr) 172 | sendMessage("取消授权成功") 173 | return 174 | } 175 | } 176 | } 177 | sendMessage("没有此权限哦") 178 | }else{ 179 | sendMessage("没有这个组哦") 180 | } 181 | } 182 | 183 | fun formatContact(del: String): String{ 184 | if (del.isBlank()) return "" 185 | val delegate = del.toLong() 186 | for (bot in Bot.instances) { 187 | for (group in bot.groups) { 188 | if (group.id == delegate) return "g$del" 189 | } 190 | for (friend in bot.friends) { 191 | if (friend.id == delegate) return "u$del" 192 | } 193 | for (group in bot.groups) { 194 | for (member in group.members) { 195 | if (member.id == delegate) return "m${group.id}.$del" 196 | } 197 | } 198 | } 199 | return "" 200 | } 201 | 202 | } -------------------------------------------------------------------------------- /src/main/kotlin/top/colter/mirai/plugin/welcome/PluginMain.kt: -------------------------------------------------------------------------------- 1 | package top.colter.mirai.plugin.welcome 2 | 3 | import kotlinx.coroutines.delay 4 | import net.mamoe.mirai.console.command.CommandManager.INSTANCE.register 5 | import net.mamoe.mirai.console.command.CommandManager.INSTANCE.unregister 6 | import net.mamoe.mirai.console.permission.PermissionId 7 | import net.mamoe.mirai.console.permission.PermissionService 8 | import net.mamoe.mirai.console.permission.PermissionService.Companion.getPermittedPermissions 9 | import net.mamoe.mirai.console.permission.PermitteeId.Companion.permitteeId 10 | import net.mamoe.mirai.console.plugin.jvm.JvmPluginDescription 11 | import net.mamoe.mirai.console.plugin.jvm.KotlinPlugin 12 | import net.mamoe.mirai.contact.Friend 13 | import net.mamoe.mirai.event.* 14 | import net.mamoe.mirai.event.events.* 15 | import net.mamoe.mirai.message.data.* 16 | import net.mamoe.mirai.utils.MiraiExperimentalApi 17 | import net.mamoe.mirai.utils.info 18 | import top.colter.mirai.plugin.welcome.WelcomePluginConfig.botInvitedJoinGroupRequest 19 | import top.colter.mirai.plugin.welcome.WelcomePluginConfig.friendWelcomeMessage 20 | import top.colter.mirai.plugin.welcome.WelcomePluginConfig.groupWelcomeMessage 21 | import top.colter.mirai.plugin.welcome.WelcomePluginConfig.newFriendRequest 22 | 23 | object PluginMain : KotlinPlugin( 24 | JvmPluginDescription( 25 | id = "top.colter.simple-welcome", 26 | name = "SimpleWelcome", 27 | version = "1.1.0" 28 | ) { 29 | author("Colter") 30 | } 31 | ) { 32 | 33 | var admin: Friend? = null 34 | 35 | @OptIn(MiraiExperimentalApi::class) 36 | override fun onEnable() { 37 | logger.info { "Plugin loaded" } 38 | 39 | WelcomeCommand.register() 40 | GroupCommand.register() 41 | 42 | WelcomePluginConfig.reload() 43 | WelcomePluginData.reload() 44 | 45 | val gwp = PermissionId("group","welcome.message") 46 | PermissionService.INSTANCE.register(gwp,"群欢迎语") 47 | 48 | val eventChannel = GlobalEventChannel.parentScope(this) 49 | val requestMap = mutableMapOf() 50 | 51 | eventChannel.subscribeAlways { 52 | val hasPerm = group.permitteeId.getPermittedPermissions().any { it.id == gwp } 53 | if (hasPerm && message.content == "#r"){ 54 | group.sendMessage(QuoteReply(source) + Dice((1..6).random())) 55 | } 56 | } 57 | 58 | eventChannel.subscribeAlways { 59 | val hasPerm = group.permitteeId.getPermittedPermissions().any { it.id == gwp } 60 | if (hasPerm && groupWelcomeMessage.isNotEmpty()) { 61 | group.sendMessage(At(user) + " " + groupWelcomeMessage) 62 | } 63 | } 64 | 65 | eventChannel.subscribeAlways { 66 | val msg = buildString { 67 | append("Bot好友请求: $fromId@$fromNick") 68 | if (fromGroupId != 0L) { 69 | append("\n来自群: ${fromGroup?.name}") 70 | } 71 | if (message.isNotEmpty()) { 72 | append("\n备注: $message") 73 | } 74 | } 75 | val admin = bot.getFriend(WelcomePluginConfig.admin) 76 | when (newFriendRequest) { 77 | 1 -> { 78 | reject() 79 | admin?.sendMessage("$msg\n处理结果: 已拒绝") 80 | } 81 | 2 -> { 82 | accept() 83 | admin?.sendMessage("$msg\n处理结果: 已同意") 84 | } 85 | 3 -> { 86 | requestMap[fromId] = this 87 | admin?.sendMessage("$msg\n请回复 同意 或 拒绝 或 忽略") 88 | } 89 | } 90 | if (friendWelcomeMessage.isNotEmpty()) { 91 | delay(2000) 92 | bot.getFriend(fromId)?.sendMessage(friendWelcomeMessage) 93 | } 94 | } 95 | 96 | eventChannel.subscribeAlways { 97 | val msg = "Bot群邀请请求: $groupId@$groupName\n邀请人: $invitorId@$invitorNick" 98 | val admin = bot.getFriend(WelcomePluginConfig.admin) 99 | when (botInvitedJoinGroupRequest) { 100 | 1 -> { 101 | ignore() 102 | admin?.sendMessage("$msg\n处理结果: 已忽略") 103 | } 104 | 2 -> { 105 | accept() 106 | admin?.sendMessage("$msg\n处理结果: 已同意") 107 | } 108 | 3 -> { 109 | requestMap[groupId * -1] = this 110 | admin?.sendMessage("$msg\n请回复 同意 或 拒绝 或 忽略") 111 | } 112 | } 113 | } 114 | 115 | eventChannel.subscribeAlways { 116 | val admin = bot.getFriend(WelcomePluginConfig.admin) 117 | admin?.sendMessage("Bot加入群: ${group.name}@${groupId}") 118 | } 119 | 120 | eventChannel.subscribeAlways{ 121 | if (sender.id == WelcomePluginConfig.admin){ 122 | if (listOf("同意","拒绝","忽略","全部同意","全部拒绝","全部忽略","逐个处理").contains(message.content)){ 123 | if (requestMap.isNotEmpty()){ 124 | if (requestMap.size == 1 || listOf("全部同意","全部拒绝","全部忽略").contains(message.content)){ 125 | when(message.content){ 126 | "同意","全部同意" -> { 127 | requestMap.forEach { (k, v) -> 128 | if (k < 0) (v as BotInvitedJoinGroupRequestEvent).accept() else (v as NewFriendRequestEvent).accept() 129 | } 130 | requestMap.clear() 131 | } 132 | "拒绝","全部拒绝" -> { 133 | requestMap.forEach { (k, v) -> 134 | if (k < 0) (v as BotInvitedJoinGroupRequestEvent).ignore() else (v as NewFriendRequestEvent).reject() 135 | } 136 | requestMap.clear() 137 | } 138 | "忽略","全部忽略" -> { 139 | requestMap.clear() 140 | } 141 | } 142 | sender.sendMessage("处理完成") 143 | }else if (message.content == "逐个处理"){ 144 | sender.sendMessage("请回复 同意 or 拒绝 or 忽略") 145 | val reqMap = requestMap.toMap() 146 | reqMap.forEach { (k, v) -> 147 | if (k<0){ 148 | val g = v as BotInvitedJoinGroupRequestEvent 149 | sender.sendMessage("群请求: ${g.groupId}@${g.groupName}") 150 | }else{ 151 | val f = v as NewFriendRequestEvent 152 | sender.sendMessage("好友请求: ${f.fromId}@${f.fromNick}") 153 | } 154 | selectMessagesUnit { 155 | "同意" { 156 | if (k < 0) (v as BotInvitedJoinGroupRequestEvent).accept() else (v as NewFriendRequestEvent).accept() 157 | requestMap.remove(k) 158 | } 159 | "拒绝" { 160 | if (k < 0) (v as BotInvitedJoinGroupRequestEvent).ignore() else (v as NewFriendRequestEvent).reject() 161 | requestMap.remove(k) 162 | } 163 | "忽略" { 164 | requestMap.remove(k) 165 | } 166 | default { sender.sendMessage("匹配失败") } 167 | timeout(600_000) { 168 | sender.sendMessage("超时") 169 | return@timeout 170 | } 171 | } 172 | } 173 | sender.sendMessage("处理完成") 174 | } else{ 175 | sender.sendMessage(buildString { 176 | appendLine("多个请求待处理") 177 | val friendReq = requestMap.filter { it.key > 0 }.mapValues { it.value as NewFriendRequestEvent } 178 | val groupReq = requestMap.filter { it.key < 0 }.mapValues { it.value as BotInvitedJoinGroupRequestEvent } 179 | if (friendReq.isNotEmpty()) appendLine("好友请求:") 180 | friendReq.forEach { (_, f) -> appendLine("${f.fromId}@${f.fromNick}") } 181 | if (groupReq.isNotEmpty()) appendLine("群请求:") 182 | groupReq.forEach { (_, f) -> appendLine("${f.groupId}@${f.groupName}") } 183 | appendLine("共 ${requestMap.size} 个请求") 184 | appendLine("请再次发送 全部同意 or 全部拒绝 or 全部忽略 or 逐个处理") 185 | }) 186 | } 187 | }else{ 188 | sender.sendMessage("最近没有请求哦") 189 | } 190 | } 191 | } 192 | } 193 | } 194 | 195 | override fun onDisable() { 196 | WelcomeCommand.unregister() 197 | GroupCommand.unregister() 198 | } 199 | } 200 | -------------------------------------------------------------------------------- /src/main/kotlin/top/colter/mirai/plugin/welcome/WelcomeCommand.kt: -------------------------------------------------------------------------------- 1 | package top.colter.mirai.plugin.welcome 2 | 3 | import net.mamoe.mirai.console.command.CommandSender 4 | import net.mamoe.mirai.console.command.CompositeCommand 5 | import net.mamoe.mirai.contact.Contact 6 | import net.mamoe.mirai.contact.ContactList 7 | import net.mamoe.mirai.contact.Friend 8 | import net.mamoe.mirai.contact.Group 9 | import kotlin.math.ceil 10 | 11 | object WelcomeCommand : CompositeCommand( 12 | owner = PluginMain, 13 | "wlc" 14 | ) { 15 | 16 | @SubCommand("group", "g","群") 17 | suspend fun CommandSender.group(page: Int = 1) = sendMessage( 18 | bot?.groups.pageQuery(page, 10) 19 | ) 20 | 21 | @SubCommand("friend", "f","好友") 22 | suspend fun CommandSender.friend(page: Int = 1) = sendMessage( 23 | bot?.friends.pageQuery(page, 10) 24 | ) 25 | 26 | @SubCommand("msg") 27 | suspend fun CommandSender.msg(group: String, msg: String){ 28 | if (WelcomePluginData.group.keys.contains(group)){ 29 | WelcomePluginData.groupWelcomeMessage[group] = msg 30 | }else{ 31 | try { 32 | if (bot?.groups?.contains(group.toLong()) == true){ 33 | WelcomePluginData.groupWelcomeMessage[group] = msg 34 | sendMessage("设置成功") 35 | }else{ 36 | sendMessage("设置失败") 37 | } 38 | }catch (e: Exception){ 39 | sendMessage("设置失败") 40 | } 41 | 42 | } 43 | } 44 | 45 | // @SubCommand("test") 46 | // suspend fun CommandSenderOnMessage.test(user:String, perm:String) { 47 | // try { 48 | // PermissionService.INSTANCE.getRegisteredPermissions().forEach { 49 | // if (it.id == PermissionId.parseFromString(perm)){ 50 | // AbstractPermitteeId.parseFromString(user).permit(it) 51 | // sendMessage("成功") 52 | // return 53 | // } 54 | // } 55 | // sendMessage("未找到") 56 | // }catch (e:Exception){ 57 | // println(e.message) 58 | // } 59 | // } 60 | 61 | private fun ContactList?.pageQuery(page: Int, pageCount:Int): String { 62 | return if (this != null && this.isNotEmpty()){ 63 | val pageSize = ceil(this.size.toDouble() / pageCount).toInt() 64 | if(page < 1 || page > pageSize){ 65 | "页码超出范围（1 到 $pageSize）" 66 | }else{ 67 | val isGroup = this.first() is Group 68 | val gl = this.filterIndexed { index, _ -> index >= (page-1)*pageCount && index < (page-1)*pageCount+pageCount } 69 | buildString { 70 | gl.forEach { appendLine("${it.id}@${if(isGroup) (it as Group).name else (it as Friend).nick}") } 71 | appendLine("第 $page 页, 共 $pageSize 页") 72 | appendLine("共 $size 个${if(isGroup) "群" else "好友"}") 73 | } 74 | } 75 | }else{ 76 | "空" 77 | } 78 | } 79 | 80 | } 81 | -------------------------------------------------------------------------------- /src/main/kotlin/top/colter/mirai/plugin/welcome/WelcomePluginConfig.kt: -------------------------------------------------------------------------------- 1 | package top.colter.mirai.plugin.welcome 2 | 3 | import net.mamoe.mirai.console.data.ReadOnlyPluginConfig 4 | import net.mamoe.mirai.console.data.ValueDescription 5 | import net.mamoe.mirai.console.data.value 6 | 7 | object WelcomePluginConfig: ReadOnlyPluginConfig("WelcomePluginConfig"){ 8 | 9 | @ValueDescription("管理员") 10 | val admin: Long by value(3375582524) 11 | 12 | @ValueDescription("好友申请\n0: 仅发送通知\n1: 自动拒绝\n2: 自动同意\n3: 管理员审核") 13 | val newFriendRequest: Int by value(3) 14 | 15 | @ValueDescription("邀请Bot加群申请\n0: 仅发送通知\n1: 自动拒绝\n2: 自动同意\n3: 管理员审核") 16 | val botInvitedJoinGroupRequest: Int by value(3) 17 | 18 | @ValueDescription("好友请求欢迎语\n如不需要请填写 '' 两个单引号") 19 | val friendWelcomeMessage: String by value("( •̀ ω •́ )✧") 20 | 21 | @ValueDescription("新成员加群欢迎语(需要授权)\n如不需要请填写 '' 两个单引号") 22 | val groupWelcomeMessage: String by value("欢迎( •̀ ω •́ )✧") 23 | 24 | 25 | } -------------------------------------------------------------------------------- /src/main/kotlin/top/colter/mirai/plugin/welcome/WelcomePluginData.kt: -------------------------------------------------------------------------------- 1 | package top.colter.mirai.plugin.welcome 2 | 3 | import net.mamoe.mirai.console.data.AutoSavePluginData 4 | import net.mamoe.mirai.console.data.ValueDescription 5 | import net.mamoe.mirai.console.data.value 6 | 7 | object WelcomePluginData : AutoSavePluginData("WelcomePluginData"){ 8 | 9 | @ValueDescription("组") 10 | val group: MutableMap> by value(mutableMapOf()) 11 | 12 | @ValueDescription("组权限") 13 | val groupPerm: MutableMap> by value(mutableMapOf()) 14 | 15 | @ValueDescription("群欢迎信息") 16 | val groupWelcomeMessage: MutableMap by value(mutableMapOf()) 17 | 18 | } -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/net.mamoe.mirai.console.plugin.jvm.JvmPlugin: -------------------------------------------------------------------------------- 1 | top.colter.mirai.plugin.welcome.PluginMain -------------------------------------------------------------------------------- /src/test/kotlin/RunMirai.kt: -------------------------------------------------------------------------------- 1 | package top.colter.mirai.plugin 2 | 3 | import net.mamoe.mirai.console.MiraiConsole 4 | import net.mamoe.mirai.console.plugin.PluginManager.INSTANCE.enable 5 | import net.mamoe.mirai.console.plugin.PluginManager.INSTANCE.load 6 | import net.mamoe.mirai.console.terminal.MiraiConsoleTerminalLoader 7 | import net.mamoe.mirai.console.util.ConsoleExperimentalApi 8 | import top.colter.mirai.plugin.welcome.PluginMain 9 | 10 | @OptIn(ConsoleExperimentalApi::class) 11 | suspend fun main() { 12 | MiraiConsoleTerminalLoader.startAsDaemon() 13 | 14 | PluginMain.load() 15 | PluginMain.enable() 16 | 17 | MiraiConsole.job.join() 18 | } --------------------------------------------------------------------------------