├── .gitignore
├── LICENSE.txt
├── README.md
├── circle.yml
├── pom.xml
└── src
└── main
└── java
└── com
└── ogarproject
└── ogar
└── api
├── CellOwner.java
├── Ogar.java
├── Player.java
├── Server.java
├── entity
├── Cell.java
├── Entity.java
├── EntityType.java
└── Food.java
├── event
├── Cancellable.java
├── Event.java
├── EventHandler.java
├── EventPriority.java
├── Listener.java
├── player
│ ├── PlayerConnectedEvent.java
│ ├── PlayerConnectingEvent.java
│ ├── PlayerDisconnectEvent.java
│ └── PlayerNameChangeEvent.java
└── plugin
│ └── PluginMessageEvent.java
├── plugin
├── Messenger.java
├── Plugin.java
├── PluginInfo.java
├── PluginManager.java
└── Scheduler.java
└── world
├── Position.java
└── World.java
/.gitignore:
--------------------------------------------------------------------------------
1 | target/
2 | *.DS_Store
3 | server.log
4 | dependency-reduced-pom.xml
5 | config.json
6 | gameserver.ini*
7 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Ogar 2 API
2 | The plugin API for Ogar 2, the open-source Agar.io server implementation written in Java. Ogar 2 is the successor to [Ogar 1.0, the old Node.js implementation](https://github.com/OgarProject/Ogar).
3 |
4 | ## Contributing
5 | Please see [CONTRIBUTING.md in the Ogar Server repository](https://github.com/OgarProject/Ogar2-Server/blob/master/CONTRIBUTING.md) for contribution guidelines.
6 |
7 | ## License
8 | Please see [LICENSE.txt](https://github.com/OgarProject/Ogar2-API/blob/master/LICENSE.txt).
9 |
--------------------------------------------------------------------------------
/circle.yml:
--------------------------------------------------------------------------------
1 | machine:
2 | java:
3 | version: oraclejdk8
4 | general:
5 | artifacts:
6 | - "target/ogar-api-*.jar"
7 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 4.0.0
4 | com.ogarproject
5 | ogar-api
6 | 2.0-SNAPSHOT
7 | jar
8 |
9 | Ogar API
10 | Plugin API for Ogar, the open-source Agar.io server implementation.
11 | 2015
12 |
13 |
14 | UTF-8
15 | 1.8
16 | 1.8
17 |
18 |
19 |
20 |
21 | com.google.guava
22 | guava
23 | 18.0
24 |
25 |
26 | com.google.code.gson
27 | gson
28 | 2.3.1
29 |
30 |
31 |
32 |
33 | install
34 |
35 |
36 | org.apache.maven.plugins
37 | maven-shade-plugin
38 | 2.3
39 |
40 |
41 | package
42 |
43 | shade
44 |
45 |
46 |
47 |
48 |
49 | com.mycila
50 | license-maven-plugin
51 | 2.11
52 |
53 | com/mycila/maven/plugin/license/templates/GPL-3.txt
54 |
55 | Ogar
56 |
57 |
58 | target/**
59 | **/.gitignore
60 | **/README.md
61 | **/LICENSE.md
62 | src/test/resources/**
63 | src/main/resources/**
64 |
65 |
66 | **/*.java
67 |
68 |
69 | JAVADOC_STYLE
70 |
71 |
72 |
73 |
74 | compile
75 |
76 | format
77 |
78 |
79 |
80 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/CellOwner.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api;
18 |
19 | import com.ogarproject.ogar.api.entity.Cell;
20 | import java.util.Collection;
21 |
22 | /**
23 | * CellOwner is an interface implemented by all cell owners. In the default Ogar
24 | * implementation, this interface is only implemented by Player. However, it can
25 | * be extended by plugins to allow for bots, among other uses.
26 | */
27 | public interface CellOwner {
28 |
29 | /**
30 | * Gets the name of this cell owner. This name is independent of the name of
31 | * the owner's cells; although all new cells formed by this owner will use
32 | * this name as a default, the name of each cell can be controlled
33 | * individually.
34 | *
35 | * @return the owner's name
36 | */
37 | public String getName();
38 |
39 | /**
40 | * Sets this owner's name. This name is independent of the name of the
41 | * owner's cells; as such, using this method will not rename current cells,
42 | * but only set the default name of future cells.
43 | *
44 | * @param name
45 | */
46 | public void setName(String name);
47 |
48 | /**
49 | * Gets all cells that belong to this owner. The collection returned may be
50 | * immutable.
51 | *
52 | * @return a collection of cells belonging to this owner
53 | */
54 | public Collection getCells();
55 |
56 | /**
57 | * Adds a cell to this owner.
58 | *
59 | * @param cell the cell to add
60 | */
61 | public void addCell(Cell cell);
62 |
63 | /**
64 | * Removes a cell from this owner.
65 | *
66 | * @param cell the cell to remove
67 | */
68 | public void removeCell(Cell cell);
69 |
70 | /**
71 | * Removes a cell with the specified entity ID from this owner.
72 | *
73 | * @param id the entity ID of the cell to remove
74 | */
75 | public void removeCell(int id);
76 | }
77 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/Ogar.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api;
18 |
19 | import com.ogarproject.ogar.api.plugin.Messenger;
20 | import com.ogarproject.ogar.api.plugin.PluginManager;
21 | import com.ogarproject.ogar.api.world.World;
22 | import java.util.logging.Logger;
23 |
24 | /**
25 | * Singleton class for convenient access to the currently running Ogar server.
26 | */
27 | public class Ogar {
28 |
29 | private static Server INSTANCE;
30 |
31 | /**
32 | * Static-use class.
33 | */
34 | private Ogar() {
35 | }
36 |
37 | public static void setServer(Server server) {
38 | if (INSTANCE != null) {
39 | throw new UnsupportedOperationException("Cannot redefine singleton server instance!");
40 | }
41 |
42 | INSTANCE = server;
43 | }
44 |
45 | public static Server getServer() {
46 | return INSTANCE;
47 | }
48 |
49 | public static Logger getLogger() {
50 | return INSTANCE.getLogger();
51 | }
52 |
53 | public static PluginManager getPluginManager() {
54 | return INSTANCE.getPluginManager();
55 | }
56 |
57 | public static Messenger getMessenger() {
58 | return INSTANCE.getMessenger();
59 | }
60 |
61 | public static World getWorld() {
62 | return INSTANCE.getWorld();
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/Player.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api;
18 |
19 | import java.net.SocketAddress;
20 |
21 | public interface Player extends CellOwner {
22 |
23 | public SocketAddress getAddress();
24 |
25 | /**
26 | * Checks if this client is compatible with the Ogar Mod Protocol (OMP).
27 | * OMP-capable clients must send an OMP message with channel name
28 | * "OMP|Capable" for this value to be properly set.
29 | *
30 | * @return true if the client is using the Ogar Mod Protocol
31 | */
32 | public boolean isPluginMessageCapable();
33 |
34 | /**
35 | * @see #sendPluginMessage(java.lang.String, byte[])
36 | */
37 | public default boolean sendPluginMessage(String channel) {
38 | return sendPluginMessage(channel, new byte[0]);
39 | }
40 |
41 | /**
42 | * Sends a plugin message to this client if the client is Ogar Mod Protocol
43 | * (OMP) capable. The channel must already be registered with
44 | * {@link com.ogarproject.ogar.api.plugin.Messenger}; if it is not, an
45 | * exception will be thrown.
46 | *
47 | * @param channel the channel name to use; must be registered with Messenger
48 | * @param data additional data, up to 32767 bytes
49 | * @return true if the message was sent, false if the client is not OMP
50 | * capable
51 | */
52 | public boolean sendPluginMessage(String channel, byte[] data);
53 | }
54 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/Server.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api;
18 |
19 | import com.ogarproject.ogar.api.plugin.Messenger;
20 | import com.ogarproject.ogar.api.plugin.PluginManager;
21 | import com.ogarproject.ogar.api.plugin.Scheduler;
22 | import com.ogarproject.ogar.api.world.World;
23 | import java.util.logging.Logger;
24 |
25 | /**
26 | * A Server is the main interface to the rest of the API.
27 | */
28 | public interface Server {
29 |
30 | /**
31 | * Gets the global logger instance used by the server.
32 | *
33 | * @return a Logger instance
34 | */
35 | public Logger getLogger();
36 |
37 | /**
38 | * Gets the server's plugin manager.
39 | *
40 | * @return plugin manager associated with the server
41 | */
42 | public PluginManager getPluginManager();
43 |
44 | /**
45 | * Gets the server's messenger.
46 | *
47 | * @return messenger associated with the server
48 | */
49 | public Messenger getMessenger();
50 |
51 | /**
52 | * Gets the server's world.
53 | *
54 | * @return world associated with the server
55 | */
56 | public World getWorld();
57 |
58 | /**
59 | * Gets the server's scheduler.
60 | *
61 | * @return scheduler associated with the server
62 | */
63 | public Scheduler getScheduler();
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/entity/Cell.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.entity;
18 |
19 | import com.ogarproject.ogar.api.CellOwner;
20 |
21 | public interface Cell extends Entity {
22 |
23 | public String getName();
24 |
25 | public void setName(String name);
26 |
27 | public CellOwner getOwner();
28 | }
29 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/entity/Entity.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.entity;
18 |
19 | import com.ogarproject.ogar.api.world.Position;
20 | import com.ogarproject.ogar.api.world.World;
21 | import java.awt.Color;
22 |
23 | /**
24 | * An abstract class that describes an entity. An entity is any object in an
25 | * Agar.io world.
26 | */
27 | public interface Entity {
28 |
29 | public World getWorld();
30 |
31 | public int getID();
32 |
33 | public EntityType getType();
34 |
35 | public Position getPosition();
36 |
37 | public void setPosition(Position position);
38 |
39 | public Color getColor();
40 |
41 | public void setColor(Color color);
42 |
43 | public int getPhysicalSize();
44 |
45 | public int getMass();
46 |
47 | public void setMass(int mass);
48 |
49 | public void addMass(int mass);
50 |
51 | public boolean isSpiked();
52 |
53 | public void setSpiked(boolean spiked);
54 |
55 | }
56 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/entity/EntityType.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.entity;
18 |
19 | /**
20 | * An enumeration of all recognized entity types.
21 | */
22 | public enum EntityType {
23 |
24 | CELL, FOOD, VIRUS, MASS;
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/entity/Food.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.entity;
18 |
19 | public interface Food extends Entity {
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/Cancellable.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event;
18 |
19 | /**
20 | * Represents a type of event that can be cancelled.
21 | */
22 | public interface Cancellable {
23 |
24 | public boolean isCancelled();
25 |
26 | public void setCancelled(boolean cancelled);
27 | }
28 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/Event.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event;
18 |
19 | /**
20 | * An Event represents something that happens on an Ogar server. Although Ogar
21 | * provides its own standard events, plugins can also create their own events
22 | * for use by other plugins.
23 | */
24 | public abstract class Event {
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/EventHandler.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event;
18 |
19 | import java.lang.annotation.Retention;
20 | import java.lang.annotation.RetentionPolicy;
21 |
22 | /**
23 | * Denotes a method that handles an event.
24 | */
25 | @Retention(RetentionPolicy.RUNTIME)
26 | public @interface EventHandler {
27 |
28 | /**
29 | * Specifies the priority of this event handler. For more information,
30 | * please see {@link com.ogarproject.ogar.api.event.EventPriority}.
31 | *
32 | * @return the event handler's priority
33 | */
34 | public EventPriority priority() default EventPriority.NORMAL;
35 |
36 | /**
37 | * If this value is set to true, this event handler will not be called if
38 | * the event has been previously cancelled by another event handler.
39 | *
40 | * @return boolean indicating whether or not cancelled events should be
41 | * ignored
42 | */
43 | public boolean ignoreCancelled() default false;
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/EventPriority.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event;
18 |
19 | /**
20 | * Used to set the priority of an {@link EventHandler}. Events are executed in
21 | * the following order:
22 | *
23 | * - LOWEST
24 | * - LOW
25 | * - NORMAL
26 | * - HIGH
27 | * - HIGHEST
28 | * - MONITOR
29 | *
30 | *
31 | * By default, EventHandler priorities are set to {@code NORMAL}. Events that
32 | * are being handled on priority {@code MONITOR} should not, in any way,
33 | * modify the outcome of the event. This priority is used for handlers that wish
34 | * to listen for the final outcome of the event.
35 | */
36 | public enum EventPriority {
37 |
38 | LOWEST, LOW, NORMAL, HIGH, HIGHEST, MONITOR;
39 | }
40 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/Listener.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event;
18 |
19 | /**
20 | * Marker interface. All event listeners must implement this interface.
21 | */
22 | public interface Listener {
23 |
24 | }
25 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/player/PlayerConnectedEvent.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event.player;
18 |
19 | import com.ogarproject.ogar.api.Player;
20 | import com.ogarproject.ogar.api.event.Event;
21 |
22 | public class PlayerConnectedEvent extends Event {
23 |
24 | private final Player player;
25 |
26 | public PlayerConnectedEvent(Player player) {
27 | this.player = player;
28 | }
29 |
30 | public Player getPlayer() {
31 | return player;
32 | }
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/player/PlayerConnectingEvent.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event.player;
18 |
19 | import com.ogarproject.ogar.api.event.Cancellable;
20 | import com.ogarproject.ogar.api.event.Event;
21 | import java.net.SocketAddress;
22 |
23 | public class PlayerConnectingEvent extends Event implements Cancellable {
24 |
25 | private final SocketAddress address;
26 | private final int protocolVersion;
27 | private final String token;
28 | private boolean cancelled;
29 |
30 | public PlayerConnectingEvent(SocketAddress address, int protocolVersion, String token) {
31 | this.address = address;
32 | this.protocolVersion = protocolVersion;
33 | this.token = token;
34 | }
35 |
36 | @Override
37 | public boolean isCancelled() {
38 | return cancelled;
39 | }
40 |
41 | @Override
42 | public void setCancelled(boolean cancelled) {
43 | this.cancelled = cancelled;
44 | }
45 |
46 | public SocketAddress getAddress() {
47 | return address;
48 | }
49 |
50 | public int getProtocolVersion() {
51 | return protocolVersion;
52 | }
53 |
54 | public String getToken() {
55 | return token;
56 | }
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/player/PlayerDisconnectEvent.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event.player;
18 |
19 | import com.ogarproject.ogar.api.Player;
20 | import com.ogarproject.ogar.api.event.Event;
21 |
22 | public class PlayerDisconnectEvent extends Event {
23 |
24 | private final Player player;
25 |
26 | public PlayerDisconnectEvent(Player player) {
27 | this.player = player;
28 | }
29 |
30 | public Player getPlayer() {
31 | return player;
32 | }
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/player/PlayerNameChangeEvent.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event.player;
18 |
19 | import com.ogarproject.ogar.api.Player;
20 | import com.ogarproject.ogar.api.event.Event;
21 |
22 | public class PlayerNameChangeEvent extends Event {
23 |
24 | private final Player player;
25 | private String name;
26 |
27 | public PlayerNameChangeEvent(Player player, String name) {
28 | this.player = player;
29 | this.name = name;
30 | }
31 |
32 | public Player getPlayer() {
33 | return player;
34 | }
35 |
36 | public String getName() {
37 | return name;
38 | }
39 |
40 | public void setName(String name) {
41 | this.name = name;
42 | }
43 |
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/event/plugin/PluginMessageEvent.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.event.plugin;
18 |
19 | import com.ogarproject.ogar.api.event.Event;
20 |
21 | public class PluginMessageEvent extends Event {
22 |
23 | private final String channel;
24 | private final byte[] data;
25 |
26 | public PluginMessageEvent(String channel, byte[] data) {
27 | this.channel = channel;
28 | this.data = data;
29 | }
30 |
31 | public String getChannel() {
32 | return channel;
33 | }
34 |
35 | public byte[] getData() {
36 | return data;
37 | }
38 |
39 | }
40 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/plugin/Messenger.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | /**
18 | * This file is part of Ogar.
19 | *
20 | * Ogar is free software: you can redistribute it and/or modify it under the
21 | * terms of the GNU General Public License as published by the Free Software
22 | * Foundation, either version 3 of the License, or (at your option) any later
23 | * version.
24 | *
25 | * Ogar is distributed in the hope that it will be useful, but WITHOUT ANY
26 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
27 | * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
28 | *
29 | * You should have received a copy of the GNU General Public License along with
30 | * Ogar. If not, see .
31 | */
32 | package com.ogarproject.ogar.api.plugin;
33 |
34 | import com.google.common.base.Preconditions;
35 | import com.google.common.collect.ArrayListMultimap;
36 | import com.google.common.collect.Multimap;
37 | import java.util.HashSet;
38 | import java.util.Set;
39 |
40 | /**
41 | * Messenger handles sending and receiving OMP messages to and from OMP-capable
42 | * clients.
43 | */
44 | public class Messenger {
45 |
46 | private final Multimap channelRegistrations = ArrayListMultimap.create();
47 | private final Set allChannelRegistrations = new HashSet<>();
48 |
49 | public void registerChannel(Plugin plugin, String channelName) {
50 | Preconditions.checkNotNull(plugin, "plugin");
51 | Preconditions.checkNotNull(channelName, "channelName");
52 | Preconditions.checkArgument(plugin.isEnabled(), "Attempted to register an OMP channel for a disabled plugin");
53 | Preconditions.checkArgument(!channelName.toUpperCase().startsWith("OMP|") && !channelName.toUpperCase().startsWith("O2|"), "Attempted to register a reserved channel name");
54 |
55 | if (channelRegistrations.containsEntry(plugin, channelName)) {
56 | return;
57 | }
58 |
59 | channelRegistrations.put(plugin, channelName);
60 | allChannelRegistrations.add(channelName);
61 | }
62 |
63 | public void unregisterChannel(Plugin plugin, String channelName) {
64 | Preconditions.checkNotNull(plugin, "plugin");
65 | Preconditions.checkNotNull(channelName, "channelName");
66 | Preconditions.checkArgument(!channelName.toUpperCase().startsWith("OMP|") && !channelName.toUpperCase().startsWith("O2|"),
67 | "Attempted to unregister a reserved channel name");
68 |
69 | channelRegistrations.remove(plugin, channelName);
70 | if (!channelRegistrations.containsValue(channelName)) {
71 | allChannelRegistrations.remove(channelName);
72 | }
73 | }
74 |
75 | public void unregisterAll(Plugin plugin) {
76 | Preconditions.checkNotNull(plugin, "plugin");
77 | for (String channelName : channelRegistrations.get(plugin)) {
78 | unregisterChannel(plugin, channelName);
79 | }
80 | }
81 |
82 | public boolean isChannelRegistered(String channel) {
83 | return allChannelRegistrations.contains(channel);
84 | }
85 |
86 | public String[] getAllChannelRegistrations() {
87 | return allChannelRegistrations.toArray(new String[0]);
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/plugin/Plugin.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.plugin;
18 |
19 | import com.ogarproject.ogar.api.Server;
20 | import java.util.logging.Logger;
21 |
22 | public abstract class Plugin {
23 |
24 | private Server server;
25 | private PluginManager pluginManager;
26 | private boolean enabled = false;
27 |
28 | public void onEnable() {
29 | // To be overridden by implementations
30 | }
31 |
32 | public void onDisable() {
33 | // To be overridden by implementations
34 | }
35 |
36 | final void init(Server server, PluginManager pluginManager) {
37 | this.server = server;
38 | this.pluginManager = pluginManager;
39 | }
40 |
41 | final void setEnabled(boolean value) {
42 | if (enabled == value) {
43 | return;
44 | }
45 |
46 | boolean oldEnabled = enabled;
47 | enabled = value;
48 | if (oldEnabled && !value) {
49 | onDisable();
50 | } else if (!oldEnabled && value) {
51 | onEnable();
52 | }
53 | }
54 |
55 | public final Logger getLogger() {
56 | return server.getLogger();
57 | }
58 |
59 | public final PluginInfo getPluginInfo() {
60 | return getClass().getAnnotation(PluginInfo.class);
61 | }
62 |
63 | public final Server getServer() {
64 | return server;
65 | }
66 |
67 | public final PluginManager getPluginManager() {
68 | return pluginManager;
69 | }
70 |
71 | public final boolean isEnabled() {
72 | return enabled;
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/plugin/PluginInfo.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.plugin;
18 |
19 | import java.lang.annotation.Retention;
20 | import java.lang.annotation.RetentionPolicy;
21 |
22 | @Retention(RetentionPolicy.RUNTIME)
23 | public @interface PluginInfo {
24 |
25 | public String name();
26 |
27 | public String version();
28 |
29 | public String author();
30 |
31 | public String description() default "";
32 |
33 | public String website() default "";
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/plugin/PluginManager.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.plugin;
18 |
19 | import com.google.common.base.Preconditions;
20 | import com.google.common.collect.ArrayListMultimap;
21 | import com.google.common.collect.Multimap;
22 | import com.ogarproject.ogar.api.Server;
23 | import com.ogarproject.ogar.api.event.Cancellable;
24 | import com.ogarproject.ogar.api.event.Event;
25 | import com.ogarproject.ogar.api.event.EventHandler;
26 | import com.ogarproject.ogar.api.event.EventPriority;
27 | import com.ogarproject.ogar.api.event.Listener;
28 | import java.io.File;
29 | import java.io.FileInputStream;
30 | import java.lang.reflect.Method;
31 | import java.net.URL;
32 | import java.net.URLClassLoader;
33 | import java.util.ArrayList;
34 | import java.util.HashMap;
35 | import java.util.List;
36 | import java.util.Map;
37 | import java.util.logging.Level;
38 | import java.util.zip.ZipEntry;
39 | import java.util.zip.ZipInputStream;
40 |
41 | public class PluginManager {
42 |
43 | private final Server server;
44 | private final Map plugins = new HashMap<>();
45 | private final Multimap listeners = ArrayListMultimap.create();
46 | private URLClassLoader classLoader;
47 | private boolean loadedPlugins = false;
48 |
49 | public PluginManager(Server server) {
50 | Preconditions.checkNotNull(server, "server");
51 | this.server = server;
52 | }
53 |
54 | public void loadPlugins(File directory) throws Throwable {
55 | Preconditions.checkState(!loadedPlugins, "Plugins can not currently be reloaded");
56 | Preconditions.checkArgument(directory.isDirectory(), "Directory is not a directory");
57 | File[] jarFiles = directory.listFiles((dir, name) -> name.endsWith(".jar"));
58 | URL[] urls = new URL[jarFiles.length];
59 |
60 | for (int i = 0; i < urls.length; i++) {
61 | urls[i] = jarFiles[i].toURI().toURL();
62 | }
63 |
64 | loadedPlugins = true;
65 | classLoader = new URLClassLoader(urls, this.getClass().getClassLoader());
66 |
67 | // Scan through the classes to find Plugin extensions with @PluginInfo
68 | List> pluginClasses = new ArrayList<>();
69 | for (File jarFile : jarFiles) {
70 | try (ZipInputStream zip = new ZipInputStream(new FileInputStream(jarFile))) {
71 | ZipEntry entry;
72 |
73 | while ((entry = zip.getNextEntry()) != null) {
74 | if (!entry.getName().endsWith(".class")) {
75 | continue;
76 | }
77 |
78 | String[] splitName = entry.getName().split("/");
79 | if (splitName[splitName.length - 1].contains("$")) {
80 | // Inner class, skip
81 | continue;
82 | }
83 |
84 | String className = entry.getName().substring(0, entry.getName().length() - 6).replace('/', '.');
85 | Class> clazz = Class.forName(className, true, classLoader);
86 |
87 | if (Plugin.class.isAssignableFrom(clazz) && clazz.isAnnotationPresent(PluginInfo.class)) {
88 | // We have a plugin!
89 | pluginClasses.add(clazz.asSubclass(Plugin.class));
90 | }
91 | }
92 | }
93 | }
94 |
95 | // Next, initialize the plugins
96 | for (Class extends Plugin> clazz : pluginClasses) {
97 | PluginInfo info = clazz.getAnnotation(PluginInfo.class);
98 | Plugin plugin = clazz.newInstance();
99 | plugins.put(info.name().toLowerCase(), plugin);
100 | plugin.init(server, this);
101 | server.getLogger().info("Loaded plugin " + info.name() + " (version " + info.version() + ").");
102 | }
103 | }
104 |
105 | public void enablePlugins() {
106 | plugins.values().forEach(this::enablePlugin);
107 | }
108 |
109 | public void disablePlugins() {
110 | plugins.values().forEach(this::disablePlugin);
111 | }
112 |
113 | public void enablePlugin(Plugin plugin) {
114 | Preconditions.checkNotNull(plugin, "plugin");
115 | Preconditions.checkArgument(!plugin.isEnabled(), "Plugin is already enabled!");
116 |
117 | PluginInfo info = plugin.getPluginInfo();
118 | plugin.setEnabled(true);
119 | server.getLogger().info("Enabled plugin " + info.name() + " (version " + info.version() + ").");
120 | }
121 |
122 | public void disablePlugin(Plugin plugin) {
123 | Preconditions.checkNotNull(plugin, "plugin");
124 | Preconditions.checkArgument(plugin.isEnabled(), "Plugin is not enabled!");
125 |
126 | PluginInfo info = plugin.getPluginInfo();
127 | plugin.setEnabled(false);
128 | listeners.removeAll(plugin);
129 | server.getLogger().info("Disabled plugin " + info.name() + " (version " + info.version() + ").");
130 | }
131 |
132 | public void registerEvents(Plugin plugin, Listener listener) {
133 | Preconditions.checkNotNull(plugin, "plugin");
134 | Preconditions.checkNotNull(listener, "listener");
135 | Preconditions.checkState(plugin.isEnabled(), "Can not register a Listener for a disabled Plugin!");
136 | Preconditions.checkArgument(!listeners.containsValue(listener), "Attempted to register a Listener that is already registered!");
137 |
138 | listeners.put(plugin, listener);
139 | }
140 |
141 | public void callEvent(Event event) {
142 | Preconditions.checkNotNull(event, "event");
143 |
144 | // Discover event handlers
145 | // TODO - This should probably be moved and cached to execute on registration of the listener
146 | Multimap methods = ArrayListMultimap.create();
147 | Map reverseMap = new HashMap<>();
148 | for (Listener l : listeners.values()) {
149 | for (Method m : l.getClass().getDeclaredMethods()) {
150 | if (!m.isAnnotationPresent(EventHandler.class)) {
151 | continue;
152 | }
153 |
154 | if (m.getParameterCount() == 1 && m.getParameterTypes()[0].equals(event.getClass())) {
155 | // Bingo!
156 | EventHandler annotation = m.getAnnotation(EventHandler.class);
157 | EventPriority priority = annotation.priority();
158 | if (priority != null) {
159 | // priority must be non-null, no funny business here
160 | methods.put(priority, m);
161 | reverseMap.put(m, l);
162 | }
163 | }
164 | }
165 | }
166 |
167 | // Execute the handlers in order of priority
168 | for (EventPriority priority : EventPriority.values()) {
169 | for (Method m : methods.get(priority)) {
170 | if (event instanceof Cancellable) {
171 | EventHandler annotation = m.getAnnotation(EventHandler.class);
172 | if (annotation.ignoreCancelled() && ((Cancellable) event).isCancelled()) {
173 | continue;
174 | }
175 | }
176 |
177 | try {
178 | m.invoke(reverseMap.get(m), event);
179 | } catch (Throwable t) {
180 | server.getLogger().log(Level.SEVERE, "Error while handling event " + event.getClass().getCanonicalName(), t);
181 | }
182 | }
183 | }
184 | }
185 |
186 | /**
187 | * Gets the instance of the plugin by the specified name, if it exists.
188 | *
189 | * @param name the name of the plugin
190 | * @return the instance of the plugin, or null if the plugin does not exist
191 | */
192 | public Plugin getPlugin(String name) {
193 | return plugins.get(name.toLowerCase());
194 | }
195 | }
196 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/plugin/Scheduler.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.plugin;
18 |
19 | /**
20 | * A Scheduler can be used to schedule tasks to run in the future. The
21 | * asynchronous methods in this interface are preferred over their synchronous
22 | * counterparts; however, asynchronous tasks should generally not use any of the
23 | * Ogar API, as it isn't guaranteed to be thread-safe.
24 | */
25 | public interface Scheduler {
26 |
27 | /**
28 | * Runs a task synchronously (during the server tick) after a delay.
29 | *
30 | * @param plugin the owning plugin of this task
31 | * @param task the task to run
32 | * @param delay the delay in ticks (20 ticks = 1 second) before the task
33 | * executes
34 | * @return A task ID that can be used with {@link #cancelTask(int)}.
35 | */
36 | public int runTaskLater(Plugin plugin, Runnable task, long delay);
37 |
38 | /**
39 | * Runs a task asynchronously (outside of the server tick) after a delay.
40 | *
41 | * @param plugin the owning plugin of this task
42 | * @param task the task to run
43 | * @param delay the delay in ticks (20 ticks = 1 second) before the task
44 | * executes
45 | * @return A task ID that can be used with {@link #cancelTask(int)}.
46 | */
47 | public int runAsyncTaskLater(Plugin plugin, Runnable task, long delay);
48 |
49 | /**
50 | * Runs a task synchronously (during the server tick) on a timer.
51 | *
52 | * @param plugin the owning plugin of this task
53 | * @param task the task to run
54 | * @param delay the initial delay, in ticks (20 ticks = 1 second), before
55 | * the task executes for the first time
56 | * @param interval the interval in ticks (20 ticks = 1 second) at which the
57 | * task will repeat
58 | * @return A task ID that can be used with {@link #cancelTask(int)}.
59 | */
60 | public int runTaskTimer(Plugin plugin, Runnable task, long delay, long interval);
61 |
62 | /**
63 | * Runs a task asynchronously (outside of the server tick) on a timer.
64 | *
65 | * @param plugin the owning plugin of this task
66 | * @param task the task to run
67 | * @param delay the initial delay, in ticks (20 ticks = 1 second), before
68 | * the task executes for the first time
69 | * @param interval the interval in ticks (20 ticks = 1 second) at which the
70 | * task will repeat
71 | * @return A task ID that can be used with {@link #cancelTask(int)}.
72 | */
73 | public int runAsyncTaskTimer(Plugin plugin, Runnable task, long delay, long interval);
74 |
75 | /**
76 | * Cancels a scheduled task.
77 | *
78 | * @param id the task ID to cancel
79 | * @return true if the task was successfully canceled, false if the task ID
80 | * did not exist or the task was already canceled
81 | */
82 | public boolean cancelTask(int id);
83 | }
84 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/world/Position.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.world;
18 |
19 | public class Position {
20 |
21 | private double x;
22 | private double y;
23 |
24 | public Position(Position position) {
25 | this.x = position.x;
26 | this.y = position.y;
27 | }
28 |
29 | public Position(double x, double y) {
30 | this.x = x;
31 | this.y = y;
32 | }
33 |
34 | public double getX() {
35 | return x;
36 | }
37 |
38 | public double getY() {
39 | return y;
40 | }
41 |
42 | public void setX(double x) {
43 | this.x = x;
44 | }
45 |
46 | public void setY(double y) {
47 | this.y = y;
48 | }
49 |
50 | public Position multiply(double mx, double my) {
51 | return new Position(x * mx, y * my);
52 | }
53 |
54 | public Position divide(double dx, double dy) {
55 | return new Position(x / dx, y / dy);
56 | }
57 |
58 | public Position add(double ax, double ay) {
59 | return new Position(x + ax, y + ay);
60 | }
61 |
62 | public Position subtract(double sx, double sy) {
63 | return new Position(x - sx, y - sy);
64 | }
65 |
66 | public double distanceSquared(Position position) {
67 | return Math.pow(position.getX() - getX(), 2) + Math.pow(position.getY() - getY(), 2);
68 | }
69 |
70 | public double distance(Position position) {
71 | return Math.sqrt(distanceSquared(position));
72 | }
73 |
74 | public double distanceSquared(double ox, double oy) {
75 | return Math.pow(ox - getX(), 2) + Math.pow(oy - getY(), 2);
76 | }
77 |
78 | public double distance(double ox, double oy) {
79 | return Math.sqrt(distanceSquared(ox, oy));
80 | }
81 |
82 | @Override
83 | public int hashCode() {
84 | int hash = 7;
85 | hash = 89 * hash + (int) (Double.doubleToLongBits(this.x) ^ (Double.doubleToLongBits(this.x) >>> 32));
86 | hash = 89 * hash + (int) (Double.doubleToLongBits(this.y) ^ (Double.doubleToLongBits(this.y) >>> 32));
87 | return hash;
88 | }
89 |
90 | @Override
91 | public boolean equals(Object obj) {
92 | if (obj == null) {
93 | return false;
94 | }
95 | if (getClass() != obj.getClass()) {
96 | return false;
97 | }
98 | final Position other = (Position) obj;
99 | if (Double.doubleToLongBits(this.x) != Double.doubleToLongBits(other.x)) {
100 | return false;
101 | }
102 | if (Double.doubleToLongBits(this.y) != Double.doubleToLongBits(other.y)) {
103 | return false;
104 | }
105 | return true;
106 | }
107 |
108 | @Override
109 | public String toString() {
110 | return "Position{" + "x=" + x + ", y=" + y + '}';
111 | }
112 | }
113 |
--------------------------------------------------------------------------------
/src/main/java/com/ogarproject/ogar/api/world/World.java:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is part of Ogar.
3 | *
4 | * Ogar is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * Ogar is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with Ogar. If not, see .
16 | */
17 | package com.ogarproject.ogar.api.world;
18 |
19 | import com.ogarproject.ogar.api.Server;
20 | import com.ogarproject.ogar.api.entity.Entity;
21 | import com.ogarproject.ogar.api.entity.EntityType;
22 | import java.util.Collection;
23 |
24 | public interface World {
25 |
26 | public Server getServer();
27 |
28 | public Entity spawnEntity(EntityType type);
29 |
30 | public Entity spawnEntity(EntityType type, Position position);
31 |
32 | public void removeEntity(Entity entity);
33 |
34 | public void removeEntity(int id);
35 |
36 | public Entity getEntity(int id);
37 |
38 | public Collection getEntities();
39 | }
40 |
--------------------------------------------------------------------------------
|