├── .editorconfig ├── .git_commit_template.txt ├── .gitattributes ├── .github └── workflows │ └── core-build.yml ├── .gitignore ├── LICENSE ├── LICENSE.md ├── README.md ├── conf └── mod_customserver.conf.dist ├── include.sh ├── setup_git_commit_template.sh └── src ├── FOL_loader.cpp └── mod_customserver.cpp /.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | charset = utf-8 3 | indent_style = space 4 | indent_size = 4 5 | tab_width = 4 6 | insert_final_newline = true 7 | trim_trailing_whitespace = true 8 | max_line_length = 80 9 | -------------------------------------------------------------------------------- /.git_commit_template.txt: -------------------------------------------------------------------------------- 1 | ### TITLE 2 | ## Type(Scope/Subscope): Commit ultra short explanation 3 | ## |---- Write below the examples with a maximum of 50 characters ----| 4 | ## Example 1: fix(DB/SAI): Missing spell to NPC Hogger 5 | ## Example 2: fix(CORE/Raid): Phase 2 of Ragnaros 6 | ## Example 3: feat(CORE/Commands): New GM command to do something 7 | 8 | 9 | ### DESCRIPTION 10 | ## Explain why this change is being made, what does it fix etc... 11 | ## |---- Write below the examples with a maximum of 72 characters per lines ----| 12 | ## Example: Hogger (id: 492) was not charging player when being engaged. 13 | 14 | 15 | ## Provide links to any issue, commit, pull request or other resource 16 | ## Example 1: Closes issue #23 17 | ## Example 2: Ported from other project's commit (link) 18 | ## Example 3: References taken from wowpedia / wowhead / wowwiki / https://wowgaming.altervista.org/aowow/ 19 | 20 | 21 | 22 | ## ======================================================= 23 | ## EXTRA INFOS 24 | ## ======================================================= 25 | ## "Type" can be: 26 | ## feat (new feature) 27 | ## fix (bug fix) 28 | ## refactor (refactoring production code) 29 | ## style (formatting, missing semi colons, etc; no code change) 30 | ## docs (changes to documentation) 31 | ## test (adding or refactoring tests; no production code change) 32 | ## chore (updating bash scripts, git files etc; no production code change) 33 | ## -------------------- 34 | ## Remember to 35 | ## Capitalize the subject line 36 | ## Use the imperative mood in the subject line 37 | ## Do not end the subject line with a period 38 | ## Separate subject from body with a blank line 39 | ## Use the body to explain what and why rather than how 40 | ## Can use multiple lines with "-" for bullet points in body 41 | ## -------------------- 42 | ## More info here https://www.conventionalcommits.org/en/v1.0.0-beta.2/ 43 | ## ======================================================= 44 | ## "Scope" can be: 45 | ## CORE (core related, c++) 46 | ## DB (database related, sql) 47 | ## ======================================================= 48 | ## "Subscope" is optional and depends on the nature of the commit. 49 | ## ======================================================= 50 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | ## AUTO-DETECT 2 | ## Handle line endings automatically for files detected as 3 | ## text and leave all files detected as binary untouched. 4 | ## This will handle all files NOT defined below. 5 | * text=auto eol=lf 6 | 7 | # Text 8 | *.conf 9 | *.conf.dist 10 | *.txt 11 | *.md 12 | *.cmake 13 | 14 | # Bash 15 | *.sh text 16 | 17 | # Lua if lua module? 18 | *.lua 19 | 20 | # SQL 21 | *.sql 22 | 23 | # C++ 24 | *.c text 25 | *.cc text 26 | *.cxx text 27 | *.cpp text 28 | *.c++ text 29 | *.hpp text 30 | *.h text 31 | *.h++ text 32 | *.hh text 33 | 34 | 35 | ## For documentation 36 | 37 | # Documents 38 | *.doc diff=astextplain 39 | *.DOC diff=astextplain 40 | *.docx diff=astextplain 41 | *.DOCX diff=astextplain 42 | *.dot diff=astextplain 43 | *.DOT diff=astextplain 44 | *.pdf diff=astextplain 45 | *.PDF diff=astextplain 46 | *.rtf diff=astextplain 47 | *.RTF diff=astextplain 48 | 49 | 50 | # Graphics 51 | *.png binary 52 | *.jpg binary 53 | *.jpeg binary 54 | *.gif binary 55 | *.tif binary 56 | *.tiff binary 57 | *.ico binary 58 | # SVG treated as an asset (binary) by default. If you want to treat it as text, 59 | # comment-out the following line and uncomment the line after. 60 | *.svg binary 61 | #*.svg text 62 | *.eps binary 63 | -------------------------------------------------------------------------------- /.github/workflows/core-build.yml: -------------------------------------------------------------------------------- 1 | name: core-build 2 | on: 3 | push: 4 | branches: 5 | - 'master' 6 | pull_request: 7 | 8 | jobs: 9 | build: 10 | uses: azerothcore/reusable-workflows/.github/workflows/core_build_modules.yml@main 11 | with: 12 | module_repo: ${{ github.event.repository.name }} 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | !.gitignore 2 | 3 | # 4 | #Generic 5 | # 6 | 7 | .directory 8 | .mailmap 9 | *.orig 10 | *.rej 11 | *~ 12 | .hg/ 13 | *.kdev* 14 | .DS_Store 15 | CMakeLists.txt.user 16 | *.bak 17 | *.patch 18 | *.diff 19 | *.REMOTE.* 20 | *.BACKUP.* 21 | *.BASE.* 22 | *.LOCAL.* 23 | 24 | # 25 | # IDE & other softwares 26 | # 27 | /.settings/ 28 | /.externalToolBuilders/* 29 | # exclude in all levels 30 | nbproject/ 31 | .sync.ffs_db 32 | *.kate-swp 33 | 34 | # 35 | # Eclipse 36 | # 37 | *.pydevproject 38 | .metadata 39 | .gradle 40 | tmp/ 41 | *.tmp 42 | *.swp 43 | *~.nib 44 | local.properties 45 | .settings/ 46 | .loadpath 47 | .project 48 | .cproject 49 | 50 | \.vscode/ 51 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # GNU Affero General Public License 2 | 3 | _Version 3, 19 November 2007_ 4 | _Copyright © 2007 Free Software Foundation, Inc. [http://fsf.org](http://fsf.org)_ 5 | 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | ## Preamble 10 | 11 | The GNU Affero General Public License is a free, copyleft license for 12 | software and other kinds of works, specifically designed to ensure 13 | cooperation with the community in the case of network server software. 14 | 15 | The licenses for most software and other practical works are designed 16 | to take away your freedom to share and change the works. By contrast, 17 | our General Public Licenses are intended to guarantee your freedom to 18 | share and change all versions of a program--to make sure it remains free 19 | software for all its users. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | them if you wish), that you receive source code or can get it if you 25 | want it, that you can change the software or use pieces of it in new 26 | free programs, and that you know you can do these things. 27 | 28 | Developers that use our General Public Licenses protect your rights 29 | with two steps: **(1)** assert copyright on the software, and **(2)** offer 30 | you this License which gives you legal permission to copy, distribute 31 | and/or modify the software. 32 | 33 | A secondary benefit of defending all users' freedom is that 34 | improvements made in alternate versions of the program, if they 35 | receive widespread use, become available for other developers to 36 | incorporate. Many developers of free software are heartened and 37 | encouraged by the resulting cooperation. However, in the case of 38 | software used on network servers, this result may fail to come about. 39 | The GNU General Public License permits making a modified version and 40 | letting the public access it on a server without ever releasing its 41 | source code to the public. 42 | 43 | The GNU Affero General Public License is designed specifically to 44 | ensure that, in such cases, the modified source code becomes available 45 | to the community. It requires the operator of a network server to 46 | provide the source code of the modified version running there to the 47 | users of that server. Therefore, public use of a modified version, on 48 | a publicly accessible server, gives the public access to the source 49 | code of the modified version. 50 | 51 | An older license, called the Affero General Public License and 52 | published by Affero, was designed to accomplish similar goals. This is 53 | a different license, not a version of the Affero GPL, but Affero has 54 | released a new version of the Affero GPL which permits relicensing under 55 | this license. 56 | 57 | The precise terms and conditions for copying, distribution and 58 | modification follow. 59 | 60 | ## TERMS AND CONDITIONS 61 | 62 | ### 0. Definitions 63 | 64 | “This License” refers to version 3 of the GNU Affero General Public License. 65 | 66 | “Copyright” also means copyright-like laws that apply to other kinds of 67 | works, such as semiconductor masks. 68 | 69 | “The Program” refers to any copyrightable work licensed under this 70 | License. Each licensee is addressed as “you”. “Licensees” and 71 | “recipients” may be individuals or organizations. 72 | 73 | To “modify” a work means to copy from or adapt all or part of the work 74 | in a fashion requiring copyright permission, other than the making of an 75 | exact copy. The resulting work is called a “modified version” of the 76 | earlier work or a work “based on” the earlier work. 77 | 78 | A “covered work” means either the unmodified Program or a work based 79 | on the Program. 80 | 81 | To “propagate” a work means to do anything with it that, without 82 | permission, would make you directly or secondarily liable for 83 | infringement under applicable copyright law, except executing it on a 84 | computer or modifying a private copy. Propagation includes copying, 85 | distribution (with or without modification), making available to the 86 | public, and in some countries other activities as well. 87 | 88 | To “convey” a work means any kind of propagation that enables other 89 | parties to make or receive copies. Mere interaction with a user through 90 | a computer network, with no transfer of a copy, is not conveying. 91 | 92 | An interactive user interface displays “Appropriate Legal Notices” 93 | to the extent that it includes a convenient and prominently visible 94 | feature that **(1)** displays an appropriate copyright notice, and **(2)** 95 | tells the user that there is no warranty for the work (except to the 96 | extent that warranties are provided), that licensees may convey the 97 | work under this License, and how to view a copy of this License. If 98 | the interface presents a list of user commands or options, such as a 99 | menu, a prominent item in the list meets this criterion. 100 | 101 | ### 1. Source Code 102 | 103 | The “source code” for a work means the preferred form of the work 104 | for making modifications to it. “Object code” means any non-source 105 | form of a work. 106 | 107 | A “Standard Interface” means an interface that either is an official 108 | standard defined by a recognized standards body, or, in the case of 109 | interfaces specified for a particular programming language, one that 110 | is widely used among developers working in that language. 111 | 112 | The “System Libraries” of an executable work include anything, other 113 | than the work as a whole, that **(a)** is included in the normal form of 114 | packaging a Major Component, but which is not part of that Major 115 | Component, and **(b)** serves only to enable use of the work with that 116 | Major Component, or to implement a Standard Interface for which an 117 | implementation is available to the public in source code form. A 118 | “Major Component”, in this context, means a major essential component 119 | (kernel, window system, and so on) of the specific operating system 120 | (if any) on which the executable work runs, or a compiler used to 121 | produce the work, or an object code interpreter used to run it. 122 | 123 | The “Corresponding Source” for a work in object code form means all 124 | the source code needed to generate, install, and (for an executable 125 | work) run the object code and to modify the work, including scripts to 126 | control those activities. However, it does not include the work's 127 | System Libraries, or general-purpose tools or generally available free 128 | programs which are used unmodified in performing those activities but 129 | which are not part of the work. For example, Corresponding Source 130 | includes interface definition files associated with source files for 131 | the work, and the source code for shared libraries and dynamically 132 | linked subprograms that the work is specifically designed to require, 133 | such as by intimate data communication or control flow between those 134 | subprograms and other parts of the work. 135 | 136 | The Corresponding Source need not include anything that users 137 | can regenerate automatically from other parts of the Corresponding 138 | Source. 139 | 140 | The Corresponding Source for a work in source code form is that 141 | same work. 142 | 143 | ### 2. Basic Permissions 144 | 145 | All rights granted under this License are granted for the term of 146 | copyright on the Program, and are irrevocable provided the stated 147 | conditions are met. This License explicitly affirms your unlimited 148 | permission to run the unmodified Program. The output from running a 149 | covered work is covered by this License only if the output, given its 150 | content, constitutes a covered work. This License acknowledges your 151 | rights of fair use or other equivalent, as provided by copyright law. 152 | 153 | You may make, run and propagate covered works that you do not 154 | convey, without conditions so long as your license otherwise remains 155 | in force. You may convey covered works to others for the sole purpose 156 | of having them make modifications exclusively for you, or provide you 157 | with facilities for running those works, provided that you comply with 158 | the terms of this License in conveying all material for which you do 159 | not control copyright. Those thus making or running the covered works 160 | for you must do so exclusively on your behalf, under your direction 161 | and control, on terms that prohibit them from making any copies of 162 | your copyrighted material outside their relationship with you. 163 | 164 | Conveying under any other circumstances is permitted solely under 165 | the conditions stated below. Sublicensing is not allowed; section 10 166 | makes it unnecessary. 167 | 168 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law 169 | 170 | No covered work shall be deemed part of an effective technological 171 | measure under any applicable law fulfilling obligations under article 172 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 173 | similar laws prohibiting or restricting circumvention of such 174 | measures. 175 | 176 | When you convey a covered work, you waive any legal power to forbid 177 | circumvention of technological measures to the extent such circumvention 178 | is effected by exercising rights under this License with respect to 179 | the covered work, and you disclaim any intention to limit operation or 180 | modification of the work as a means of enforcing, against the work's 181 | users, your or third parties' legal rights to forbid circumvention of 182 | technological measures. 183 | 184 | ### 4. Conveying Verbatim Copies 185 | 186 | You may convey verbatim copies of the Program's source code as you 187 | receive it, in any medium, provided that you conspicuously and 188 | appropriately publish on each copy an appropriate copyright notice; 189 | keep intact all notices stating that this License and any 190 | non-permissive terms added in accord with section 7 apply to the code; 191 | keep intact all notices of the absence of any warranty; and give all 192 | recipients a copy of this License along with the Program. 193 | 194 | You may charge any price or no price for each copy that you convey, 195 | and you may offer support or warranty protection for a fee. 196 | 197 | ### 5. Conveying Modified Source Versions 198 | 199 | You may convey a work based on the Program, or the modifications to 200 | produce it from the Program, in the form of source code under the 201 | terms of section 4, provided that you also meet all of these conditions: 202 | 203 | * **a)** The work must carry prominent notices stating that you modified 204 | it, and giving a relevant date. 205 | * **b)** The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 7. 207 | This requirement modifies the requirement in section 4 to 208 | “keep intact all notices”. 209 | * **c)** You must license the entire work, as a whole, under this 210 | License to anyone who comes into possession of a copy. This 211 | License will therefore apply, along with any applicable section 7 212 | additional terms, to the whole of the work, and all its parts, 213 | regardless of how they are packaged. This License gives no 214 | permission to license the work in any other way, but it does not 215 | invalidate such permission if you have separately received it. 216 | * **d)** If the work has interactive user interfaces, each must display 217 | Appropriate Legal Notices; however, if the Program has interactive 218 | interfaces that do not display Appropriate Legal Notices, your 219 | work need not make them do so. 220 | 221 | A compilation of a covered work with other separate and independent 222 | works, which are not by their nature extensions of the covered work, 223 | and which are not combined with it such as to form a larger program, 224 | in or on a volume of a storage or distribution medium, is called an 225 | “aggregate” if the compilation and its resulting copyright are not 226 | used to limit the access or legal rights of the compilation's users 227 | beyond what the individual works permit. Inclusion of a covered work 228 | in an aggregate does not cause this License to apply to the other 229 | parts of the aggregate. 230 | 231 | ### 6. Conveying Non-Source Forms 232 | 233 | You may convey a covered work in object code form under the terms 234 | of sections 4 and 5, provided that you also convey the 235 | machine-readable Corresponding Source under the terms of this License, 236 | in one of these ways: 237 | 238 | * **a)** Convey the object code in, or embodied in, a physical product 239 | (including a physical distribution medium), accompanied by the 240 | Corresponding Source fixed on a durable physical medium 241 | customarily used for software interchange. 242 | * **b)** Convey the object code in, or embodied in, a physical product 243 | (including a physical distribution medium), accompanied by a 244 | written offer, valid for at least three years and valid for as 245 | long as you offer spare parts or customer support for that product 246 | model, to give anyone who possesses the object code either **(1)** a 247 | copy of the Corresponding Source for all the software in the 248 | product that is covered by this License, on a durable physical 249 | medium customarily used for software interchange, for a price no 250 | more than your reasonable cost of physically performing this 251 | conveying of source, or **(2)** access to copy the 252 | Corresponding Source from a network server at no charge. 253 | * **c)** Convey individual copies of the object code with a copy of the 254 | written offer to provide the Corresponding Source. This 255 | alternative is allowed only occasionally and noncommercially, and 256 | only if you received the object code with such an offer, in accord 257 | with subsection 6b. 258 | * **d)** Convey the object code by offering access from a designated 259 | place (gratis or for a charge), and offer equivalent access to the 260 | Corresponding Source in the same way through the same place at no 261 | further charge. You need not require recipients to copy the 262 | Corresponding Source along with the object code. If the place to 263 | copy the object code is a network server, the Corresponding Source 264 | may be on a different server (operated by you or a third party) 265 | that supports equivalent copying facilities, provided you maintain 266 | clear directions next to the object code saying where to find the 267 | Corresponding Source. Regardless of what server hosts the 268 | Corresponding Source, you remain obligated to ensure that it is 269 | available for as long as needed to satisfy these requirements. 270 | * **e)** Convey the object code using peer-to-peer transmission, provided 271 | you inform other peers where the object code and Corresponding 272 | Source of the work are being offered to the general public at no 273 | charge under subsection 6d. 274 | 275 | A separable portion of the object code, whose source code is excluded 276 | from the Corresponding Source as a System Library, need not be 277 | included in conveying the object code work. 278 | 279 | A “User Product” is either **(1)** a “consumer product”, which means any 280 | tangible personal property which is normally used for personal, family, 281 | or household purposes, or **(2)** anything designed or sold for incorporation 282 | into a dwelling. In determining whether a product is a consumer product, 283 | doubtful cases shall be resolved in favor of coverage. For a particular 284 | product received by a particular user, “normally used” refers to a 285 | typical or common use of that class of product, regardless of the status 286 | of the particular user or of the way in which the particular user 287 | actually uses, or expects or is expected to use, the product. A product 288 | is a consumer product regardless of whether the product has substantial 289 | commercial, industrial or non-consumer uses, unless such uses represent 290 | the only significant mode of use of the product. 291 | 292 | “Installation Information” for a User Product means any methods, 293 | procedures, authorization keys, or other information required to install 294 | and execute modified versions of a covered work in that User Product from 295 | a modified version of its Corresponding Source. The information must 296 | suffice to ensure that the continued functioning of the modified object 297 | code is in no case prevented or interfered with solely because 298 | modification has been made. 299 | 300 | If you convey an object code work under this section in, or with, or 301 | specifically for use in, a User Product, and the conveying occurs as 302 | part of a transaction in which the right of possession and use of the 303 | User Product is transferred to the recipient in perpetuity or for a 304 | fixed term (regardless of how the transaction is characterized), the 305 | Corresponding Source conveyed under this section must be accompanied 306 | by the Installation Information. But this requirement does not apply 307 | if neither you nor any third party retains the ability to install 308 | modified object code on the User Product (for example, the work has 309 | been installed in ROM). 310 | 311 | The requirement to provide Installation Information does not include a 312 | requirement to continue to provide support service, warranty, or updates 313 | for a work that has been modified or installed by the recipient, or for 314 | the User Product in which it has been modified or installed. Access to a 315 | network may be denied when the modification itself materially and 316 | adversely affects the operation of the network or violates the rules and 317 | protocols for communication across the network. 318 | 319 | Corresponding Source conveyed, and Installation Information provided, 320 | in accord with this section must be in a format that is publicly 321 | documented (and with an implementation available to the public in 322 | source code form), and must require no special password or key for 323 | unpacking, reading or copying. 324 | 325 | ### 7. Additional Terms 326 | 327 | “Additional permissions” are terms that supplement the terms of this 328 | License by making exceptions from one or more of its conditions. 329 | Additional permissions that are applicable to the entire Program shall 330 | be treated as though they were included in this License, to the extent 331 | that they are valid under applicable law. If additional permissions 332 | apply only to part of the Program, that part may be used separately 333 | under those permissions, but the entire Program remains governed by 334 | this License without regard to the additional permissions. 335 | 336 | When you convey a copy of a covered work, you may at your option 337 | remove any additional permissions from that copy, or from any part of 338 | it. (Additional permissions may be written to require their own 339 | removal in certain cases when you modify the work.) You may place 340 | additional permissions on material, added by you to a covered work, 341 | for which you have or can give appropriate copyright permission. 342 | 343 | Notwithstanding any other provision of this License, for material you 344 | add to a covered work, you may (if authorized by the copyright holders of 345 | that material) supplement the terms of this License with terms: 346 | 347 | * **a)** Disclaiming warranty or limiting liability differently from the 348 | terms of sections 15 and 16 of this License; or 349 | * **b)** Requiring preservation of specified reasonable legal notices or 350 | author attributions in that material or in the Appropriate Legal 351 | Notices displayed by works containing it; or 352 | * **c)** Prohibiting misrepresentation of the origin of that material, or 353 | requiring that modified versions of such material be marked in 354 | reasonable ways as different from the original version; or 355 | * **d)** Limiting the use for publicity purposes of names of licensors or 356 | authors of the material; or 357 | * **e)** Declining to grant rights under trademark law for use of some 358 | trade names, trademarks, or service marks; or 359 | * **f)** Requiring indemnification of licensors and authors of that 360 | material by anyone who conveys the material (or modified versions of 361 | it) with contractual assumptions of liability to the recipient, for 362 | any liability that these contractual assumptions directly impose on 363 | those licensors and authors. 364 | 365 | All other non-permissive additional terms are considered “further 366 | restrictions” within the meaning of section 10. If the Program as you 367 | received it, or any part of it, contains a notice stating that it is 368 | governed by this License along with a term that is a further 369 | restriction, you may remove that term. If a license document contains 370 | a further restriction but permits relicensing or conveying under this 371 | License, you may add to a covered work material governed by the terms 372 | of that license document, provided that the further restriction does 373 | not survive such relicensing or conveying. 374 | 375 | If you add terms to a covered work in accord with this section, you 376 | must place, in the relevant source files, a statement of the 377 | additional terms that apply to those files, or a notice indicating 378 | where to find the applicable terms. 379 | 380 | Additional terms, permissive or non-permissive, may be stated in the 381 | form of a separately written license, or stated as exceptions; 382 | the above requirements apply either way. 383 | 384 | ### 8. Termination 385 | 386 | You may not propagate or modify a covered work except as expressly 387 | provided under this License. Any attempt otherwise to propagate or 388 | modify it is void, and will automatically terminate your rights under 389 | this License (including any patent licenses granted under the third 390 | paragraph of section 11). 391 | 392 | However, if you cease all violation of this License, then your 393 | license from a particular copyright holder is reinstated **(a)** 394 | provisionally, unless and until the copyright holder explicitly and 395 | finally terminates your license, and **(b)** permanently, if the copyright 396 | holder fails to notify you of the violation by some reasonable means 397 | prior to 60 days after the cessation. 398 | 399 | Moreover, your license from a particular copyright holder is 400 | reinstated permanently if the copyright holder notifies you of the 401 | violation by some reasonable means, this is the first time you have 402 | received notice of violation of this License (for any work) from that 403 | copyright holder, and you cure the violation prior to 30 days after 404 | your receipt of the notice. 405 | 406 | Termination of your rights under this section does not terminate the 407 | licenses of parties who have received copies or rights from you under 408 | this License. If your rights have been terminated and not permanently 409 | reinstated, you do not qualify to receive new licenses for the same 410 | material under section 10. 411 | 412 | ### 9. Acceptance Not Required for Having Copies 413 | 414 | You are not required to accept this License in order to receive or 415 | run a copy of the Program. Ancillary propagation of a covered work 416 | occurring solely as a consequence of using peer-to-peer transmission 417 | to receive a copy likewise does not require acceptance. However, 418 | nothing other than this License grants you permission to propagate or 419 | modify any covered work. These actions infringe copyright if you do 420 | not accept this License. Therefore, by modifying or propagating a 421 | covered work, you indicate your acceptance of this License to do so. 422 | 423 | ### 10. Automatic Licensing of Downstream Recipients 424 | 425 | Each time you convey a covered work, the recipient automatically 426 | receives a license from the original licensors, to run, modify and 427 | propagate that work, subject to this License. You are not responsible 428 | for enforcing compliance by third parties with this License. 429 | 430 | An “entity transaction” is a transaction transferring control of an 431 | organization, or substantially all assets of one, or subdividing an 432 | organization, or merging organizations. If propagation of a covered 433 | work results from an entity transaction, each party to that 434 | transaction who receives a copy of the work also receives whatever 435 | licenses to the work the party's predecessor in interest had or could 436 | give under the previous paragraph, plus a right to possession of the 437 | Corresponding Source of the work from the predecessor in interest, if 438 | the predecessor has it or can get it with reasonable efforts. 439 | 440 | You may not impose any further restrictions on the exercise of the 441 | rights granted or affirmed under this License. For example, you may 442 | not impose a license fee, royalty, or other charge for exercise of 443 | rights granted under this License, and you may not initiate litigation 444 | (including a cross-claim or counterclaim in a lawsuit) alleging that 445 | any patent claim is infringed by making, using, selling, offering for 446 | sale, or importing the Program or any portion of it. 447 | 448 | ### 11. Patents 449 | 450 | A “contributor” is a copyright holder who authorizes use under this 451 | License of the Program or a work on which the Program is based. The 452 | work thus licensed is called the contributor's “contributor version”. 453 | 454 | A contributor's “essential patent claims” are all patent claims 455 | owned or controlled by the contributor, whether already acquired or 456 | hereafter acquired, that would be infringed by some manner, permitted 457 | by this License, of making, using, or selling its contributor version, 458 | but do not include claims that would be infringed only as a 459 | consequence of further modification of the contributor version. For 460 | purposes of this definition, “control” includes the right to grant 461 | patent sublicenses in a manner consistent with the requirements of 462 | this License. 463 | 464 | Each contributor grants you a non-exclusive, worldwide, royalty-free 465 | patent license under the contributor's essential patent claims, to 466 | make, use, sell, offer for sale, import and otherwise run, modify and 467 | propagate the contents of its contributor version. 468 | 469 | In the following three paragraphs, a “patent license” is any express 470 | agreement or commitment, however denominated, not to enforce a patent 471 | (such as an express permission to practice a patent or covenant not to 472 | sue for patent infringement). To “grant” such a patent license to a 473 | party means to make such an agreement or commitment not to enforce a 474 | patent against the party. 475 | 476 | If you convey a covered work, knowingly relying on a patent license, 477 | and the Corresponding Source of the work is not available for anyone 478 | to copy, free of charge and under the terms of this License, through a 479 | publicly available network server or other readily accessible means, 480 | then you must either **(1)** cause the Corresponding Source to be so 481 | available, or **(2)** arrange to deprive yourself of the benefit of the 482 | patent license for this particular work, or **(3)** arrange, in a manner 483 | consistent with the requirements of this License, to extend the patent 484 | license to downstream recipients. “Knowingly relying” means you have 485 | actual knowledge that, but for the patent license, your conveying the 486 | covered work in a country, or your recipient's use of the covered work 487 | in a country, would infringe one or more identifiable patents in that 488 | country that you have reason to believe are valid. 489 | 490 | If, pursuant to or in connection with a single transaction or 491 | arrangement, you convey, or propagate by procuring conveyance of, a 492 | covered work, and grant a patent license to some of the parties 493 | receiving the covered work authorizing them to use, propagate, modify 494 | or convey a specific copy of the covered work, then the patent license 495 | you grant is automatically extended to all recipients of the covered 496 | work and works based on it. 497 | 498 | A patent license is “discriminatory” if it does not include within 499 | the scope of its coverage, prohibits the exercise of, or is 500 | conditioned on the non-exercise of one or more of the rights that are 501 | specifically granted under this License. You may not convey a covered 502 | work if you are a party to an arrangement with a third party that is 503 | in the business of distributing software, under which you make payment 504 | to the third party based on the extent of your activity of conveying 505 | the work, and under which the third party grants, to any of the 506 | parties who would receive the covered work from you, a discriminatory 507 | patent license **(a)** in connection with copies of the covered work 508 | conveyed by you (or copies made from those copies), or **(b)** primarily 509 | for and in connection with specific products or compilations that 510 | contain the covered work, unless you entered into that arrangement, 511 | or that patent license was granted, prior to 28 March 2007. 512 | 513 | Nothing in this License shall be construed as excluding or limiting 514 | any implied license or other defenses to infringement that may 515 | otherwise be available to you under applicable patent law. 516 | 517 | ### 12. No Surrender of Others' Freedom 518 | 519 | If conditions are imposed on you (whether by court order, agreement or 520 | otherwise) that contradict the conditions of this License, they do not 521 | excuse you from the conditions of this License. If you cannot convey a 522 | covered work so as to satisfy simultaneously your obligations under this 523 | License and any other pertinent obligations, then as a consequence you may 524 | not convey it at all. For example, if you agree to terms that obligate you 525 | to collect a royalty for further conveying from those to whom you convey 526 | the Program, the only way you could satisfy both those terms and this 527 | License would be to refrain entirely from conveying the Program. 528 | 529 | ### 13. Remote Network Interaction; Use with the GNU General Public License 530 | 531 | Notwithstanding any other provision of this License, if you modify the 532 | Program, your modified version must prominently offer all users 533 | interacting with it remotely through a computer network (if your version 534 | supports such interaction) an opportunity to receive the Corresponding 535 | Source of your version by providing access to the Corresponding Source 536 | from a network server at no charge, through some standard or customary 537 | means of facilitating copying of software. This Corresponding Source 538 | shall include the Corresponding Source for any work covered by version 3 539 | of the GNU General Public License that is incorporated pursuant to the 540 | following paragraph. 541 | 542 | Notwithstanding any other provision of this License, you have 543 | permission to link or combine any covered work with a work licensed 544 | under version 3 of the GNU General Public License into a single 545 | combined work, and to convey the resulting work. The terms of this 546 | License will continue to apply to the part which is the covered work, 547 | but the work with which it is combined will remain governed by version 548 | 3 of the GNU General Public License. 549 | 550 | ### 14. Revised Versions of this License 551 | 552 | The Free Software Foundation may publish revised and/or new versions of 553 | the GNU Affero General Public License from time to time. Such new versions 554 | will be similar in spirit to the present version, but may differ in detail to 555 | address new problems or concerns. 556 | 557 | Each version is given a distinguishing version number. If the 558 | Program specifies that a certain numbered version of the GNU Affero General 559 | Public License “or any later version” applies to it, you have the 560 | option of following the terms and conditions either of that numbered 561 | version or of any later version published by the Free Software 562 | Foundation. If the Program does not specify a version number of the 563 | GNU Affero General Public License, you may choose any version ever published 564 | by the Free Software Foundation. 565 | 566 | If the Program specifies that a proxy can decide which future 567 | versions of the GNU Affero General Public License can be used, that proxy's 568 | public statement of acceptance of a version permanently authorizes you 569 | to choose that version for the Program. 570 | 571 | Later license versions may give you additional or different 572 | permissions. However, no additional obligations are imposed on any 573 | author or copyright holder as a result of your choosing to follow a 574 | later version. 575 | 576 | ### 15. Disclaimer of Warranty 577 | 578 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 579 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 580 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY 581 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 582 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 583 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 584 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 585 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 586 | 587 | ### 16. Limitation of Liability 588 | 589 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 590 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 591 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 592 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 593 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 594 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 595 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 596 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 597 | SUCH DAMAGES. 598 | 599 | ### 17. Interpretation of Sections 15 and 16 600 | 601 | If the disclaimer of warranty and limitation of liability provided 602 | above cannot be given local legal effect according to their terms, 603 | reviewing courts shall apply local law that most closely approximates 604 | an absolute waiver of all civil liability in connection with the 605 | Program, unless a warranty or assumption of liability accompanies a 606 | copy of the Program in return for a fee. 607 | 608 | _END OF TERMS AND CONDITIONS_ 609 | 610 | ## How to Apply These Terms to Your New Programs 611 | 612 | If you develop a new program, and you want it to be of the greatest 613 | possible use to the public, the best way to achieve this is to make it 614 | free software which everyone can redistribute and change under these terms. 615 | 616 | To do so, attach the following notices to the program. It is safest 617 | to attach them to the start of each source file to most effectively 618 | state the exclusion of warranty; and each file should have at least 619 | the “copyright” line and a pointer to where the full notice is found. 620 | 621 | 622 | Copyright (C) 623 | 624 | This program is free software: you can redistribute it and/or modify 625 | it under the terms of the GNU Affero General Public License as published by 626 | the Free Software Foundation, either version 3 of the License, or 627 | (at your option) any later version. 628 | 629 | This program is distributed in the hope that it will be useful, 630 | but WITHOUT ANY WARRANTY; without even the implied warranty of 631 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 632 | GNU Affero General Public License for more details. 633 | 634 | You should have received a copy of the GNU Affero General Public License 635 | along with this program. If not, see . 636 | 637 | Also add information on how to contact you by electronic and paper mail. 638 | 639 | If your software can interact with users remotely through a computer 640 | network, you should also make sure that it provides a way for users to 641 | get its source. For example, if your program is a web application, its 642 | interface could display a “Source” link that leads users to an archive 643 | of the code. There are many ways you could offer source, and different 644 | solutions will be better for different programs; see section 13 for the 645 | specific requirements. 646 | 647 | You should also get your employer (if you work as a programmer) or school, 648 | if any, to sign a “copyright disclaimer” for the program, if necessary. 649 | For more information on this, and how to apply and follow the GNU AGPL, see 650 | <>. 651 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ![logo](https://raw.githubusercontent.com/azerothcore/azerothcore.github.io/master/images/logo-github.png) AzerothCore 2 | ## mod-fireworks-on-level 3 | ### This is a module for [AzerothCore](http://www.azerothcore.org) 4 | - Latest build status with azerothcore: [![Build Status](https://github.com/azerothcore/mod-fireworks-on-level/workflows/core-build/badge.svg?branch=master&event=push)](https://github.com/azerothcore/mod-fireworks-on-level) 5 | 6 | #### Features: 7 | - FireWorks on level up for Azerothcore 8 | 9 | ### This module currently requires: 10 | - AzerothCore v1.0.1+ 11 | 12 | ### How to install 13 | 1. Simply place the module under the `modules` folder of your AzerothCore source folder. 14 | 2. Re-run cmake and launch a clean build of AzerothCore 15 | 3. Copy mod_customserver.conf.dist to mod_customserver.conf 16 | 4. Log in game, level up and enjoy. 17 | 18 | 19 | ## Credits 20 | * [stygiancore]( http://stygianthebest.github.io ): (Author of the module): 21 | 22 | * AzerothCore: [repository](https://github.com/azerothcore) - [website](http://azerothcore.org/) - [discord chat community](https://discord.gg/PaqQRkd) 23 | -------------------------------------------------------------------------------- /conf/mod_customserver.conf.dist: -------------------------------------------------------------------------------- 1 | [worldserver] 2 | 3 | ################################################################################################### 4 | # CUSTOM SERVER 5 | ################################################################################################### 6 | # Announce the module when the player logs in? 7 | 8 | CustomServer.Announce = 1 9 | 10 | # Fireworks go off when the player levels up at specific intervals 11 | # Intervals: 5, 10, 20, 30, 40, 50, 60, 70, 80 12 | # Enable the module? (1: true | 0: false) 13 | 14 | CustomServer.FireworkLevels = 1 15 | -------------------------------------------------------------------------------- /include.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/azerothcore/mod-fireworks-on-level/e5c58542996e0f1ad3410ebdb7cff9ed9d52e3d6/include.sh -------------------------------------------------------------------------------- /setup_git_commit_template.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ## Set a local git commit template 4 | git config --local commit.template ".git_commit_template.txt" ; 5 | -------------------------------------------------------------------------------- /src/FOL_loader.cpp: -------------------------------------------------------------------------------- 1 | void AddCustomServerScripts(); 2 | 3 | void Addmod_fireworks_on_levelScripts() { 4 | AddCustomServerScripts(); 5 | } 6 | -------------------------------------------------------------------------------- /src/mod_customserver.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | # Custom Server Modifications # 4 | 5 | #### A module for AzerothCore by [StygianTheBest](https://github.com/StygianTheBest/AzerothCore-Content/tree/master/Modules) 6 | ------------------------------------------------------------------------------------------------------------------ 7 | 8 | 9 | ### Description ### 10 | ------------------------------------------------------------------------------------------------------------------ 11 | This module serves as a container for smaller scripts that don't need their own module. I also use it to test 12 | ideas which is quicker and easier than writing a new module. 13 | 14 | 15 | ### Features ### 16 | ------------------------------------------------------------------------------------------------------------------ 17 | - Firework Level: Shoots fireworks in the air when a player reaches specified levels. 18 | 19 | 20 | ### Data ### 21 | ------------------------------------------------------------------------------------------------------------------ 22 | - Type: Server/Player 23 | - Script: CustomServer 24 | - Config: Yes 25 | - Enable Module 26 | - Enable Module Announce 27 | - Enable Firework Levels 28 | - SQL: No 29 | 30 | 31 | ### Version ### 32 | ------------------------------------------------------------------------------------------------------------------ 33 | - v2017.07.14 - Release 34 | - v2017.07.21 - Added Firework Levels 35 | 36 | 37 | ### Credits ### 38 | ------------------------------------------------------------------------------------------------------------------ 39 | - [Blizzard Entertainment](http://blizzard.com) 40 | - [TrinityCore](https://github.com/TrinityCore/TrinityCore/blob/3.3.5/THANKS) 41 | - [SunwellCore](http://www.azerothcore.org/pages/sunwell.pl/) 42 | - [AzerothCore](https://github.com/AzerothCore/azerothcore-wotlk/graphs/contributors) 43 | - [AzerothCore Discord](https://discord.gg/gkt4y2x) 44 | - [EMUDevs](https://youtube.com/user/EmuDevs) 45 | - [AC-Web](http://ac-web.org/) 46 | - [ModCraft.io](http://modcraft.io/) 47 | - [OwnedCore](http://ownedcore.com/) 48 | - [OregonCore](https://wiki.oregon-core.net/) 49 | - [Wowhead.com](http://wowhead.com) 50 | - [AoWoW](https://wotlk.evowow.com/) 51 | 52 | 53 | ### License ### 54 | ------------------------------------------------------------------------------------------------------------------ 55 | - This code and content is released under the [GNU AGPL v3](https://github.com/azerothcore/azerothcore-wotlk/blob/master/LICENSE-AGPL3). 56 | 57 | */ 58 | 59 | #include "Chat.h" 60 | #include "Configuration/Config.h" 61 | #include "Player.h" 62 | #include "ScriptMgr.h" 63 | 64 | class CustomServer : public PlayerScript 65 | { 66 | 67 | public: 68 | 69 | CustomServer() : PlayerScript("CustomServer", { 70 | PLAYERHOOK_ON_LOGIN, 71 | PLAYERHOOK_ON_LEVEL_CHANGED 72 | }) { } 73 | 74 | void OnPlayerLogin(Player* player) override 75 | { 76 | // Announce Module 77 | if (sConfigMgr->GetOption("CustomServer.Announce", true)) 78 | ChatHandler(player->GetSession()).SendSysMessage("This server is running the |cff4CFF00Custom Server |rmodule."); 79 | } 80 | 81 | void OnPlayerLevelChanged(Player * player, uint8 oldLevel) override 82 | { 83 | // Shoot fireworks into the air when hits a specific level 84 | if (sConfigMgr->GetOption("CustomServer.FireworkLevels", true)) 85 | { 86 | switch (oldLevel) { 87 | case 4: 88 | case 9: 89 | case 14: 90 | case 19: 91 | case 29: 92 | case 39: 93 | case 49: 94 | case 59: 95 | case 69: 96 | case 79: 97 | player->CastSpell(player, 11541, true); 98 | break; 99 | } 100 | } 101 | } 102 | }; 103 | 104 | void AddCustomServerScripts() 105 | { 106 | new CustomServer(); 107 | } 108 | --------------------------------------------------------------------------------