By continuing to use this site, you agree to the Terms of Service of this website, including usage of cookies.

OK, Don't show this again

Plugin to host a discord bot using DiscordPHP with an extensive API !
version 2.1.5
Approved
Direct Download How to install?
Switch version
377 Downloads / 3035 Total
6 Reviews
Plugin Description §

About

DiscordBot is a pocketmine plugin that provides an extensive API for plugin developers to interact with discord creating endless possibilities.

Please note that this plugin offers no standalone features, It is a central API plugin for external plugins to use/depend on.

such as https://poggit.pmmp.io/p/ChatBridge

API Documentation

Unfortunately its formatting is very weird on poggit please visit https://github.com/DiscordBot-PMMP/DiscordBot/blob/2.1.5/API.md for API documentation

Plugin Structure

This is a very complicated plugin when looked at but its essentially broken down into 4 parts.

Part 1, The plugin

The plugin interacts directly with the pocketmine server and sets up a child thread to start the connection to discord, its also the section responsible for handling API requests from other plugins and emitting events, providing data etc to other plugins.

Part 2, The thread

This 'discord thread' is responsible for keeping a live connection to discords gateway so we can receive and pass on events back to the plugin base. We also execute API requests sent from the plugin base here and return a result in the near future when discord sends a response to our API request.

Technical note, The thread is completely independent of the Main thread and pocketmine so collisions between my composer dependencies and anything else is impossible.

Part 3, The composer libs

This part is the biggest part of the plugin that works in the background inside the discord thread, It's a collection of third part libraries including DiscordPHP, React libraries, Monolog and much more.

Note you should NEVER be using or even looking at these libraries, they are not registered in the BaseClassLoader.

Part 4, Promise API

The 'face' of the plugin, using a shaded library (https://github.com/reactphp/promise/tree/v2.9.0) the plugin provides a 'promise' API which means plugins can make requests to do certain things like sendMessage or createRole and the plugin will send back a promise.

A promise is sent back because we can't return instantly whether it was a success or not because we have to send it to the Discord Thread which then sends it to discords gateway(/api for some api methods) and then we have to wait for a response then return the response to the plugin/main thread and THEN we can tell you if it was a success or not.

So you can essentially attach functions to the promise to run when we come back quite a few ticks later with a response.

Hard to explain, go read the API tab if your still interested...

What's new §
  • Fixed #75 - New PMMP PHP binaries not working.
    • Allowed xdebug to be enabled, strong warning is still shown and still not advised though.
  • Adjusted discord snowflake check.
    • Length can be 19 now.
  • /debugdata is now async.
  • Fixed #55 where Message attachment content_type can be null.
  • Addressed #59 where Admins(TBC)/Owner can join a full voice channel.
  • Storage::setTimestamp throws Invalid Argument Exception instead of crashing when timestamp is negative.
  • Fixed #52 (Invites with no inviter would crash the plugin)
  • reactphp/promise finally updated (v2.9.0 includes the PHP8 deprecation Fix)
    • DiscordBot-PMMP/promise is now archived as no longer used in future versions.
  • Fixed #49 (Blank voice channel ID assertion firing)
  • Fixed #50 (Removed assertion for reply messages not having a reference message ID)
  • Fixed #51 (Changed Activity models URL check, discord does not actually check this...)
  • Updated team-reflex/discord-php to v6.0.3
  • PocketMine 4.0 Support
  • getServers() + getUsers() added.
  • getServerBans() deprecated in favour of getBansByServer() (matching other server mapped getters)
  • Removed logging.debug field in config.

PPEyt
Outdated
using v2.1.4
27 Aug 22
BeeAZ-pm-pl
Outdated
using v2.1.2
07 Apr 22
ErikPDev
Outdated
using v2.1.2
07 Apr 22
I. Love. This.
DrGuileDish1
Outdated
using v2.1.1
28 Dec 21
how do i connect my plugin and this api. pls give a detailed description
JaxkDev
Staff
02 Jan 22
There is already a detailed API description on github as linked in the description, if you don’t understand the basics of PHP or PocketMine-MP’s API then you should learn that before even looking. I can’t cover every single basic thing otherwise It would take me months to write up documentation.
keenanyafiqy
Outdated
using v2.1.0
09 Dec 21
How do I use this plugin?
SOF3
Staff
09 Dec 21
> Please note that this plugin offers no standalone features, It is a central API plugin for external plugins to use/depend on.
NhanAZ
Outdated
using v2.1.0
08 Dec 21
GGLVXD
Outdated
using v2.0.4
10 Oct 21
add that u can change bot status or idk maybe there is already or im just blind
JaxkDev
Staff
10 Oct 21
API::updateBotPresence Would be what your looking for :)
DidntPot
Outdated
using v2.0.4
03 Oct 21
Very complication for an average person. /shrug
JaxkDev
Staff
03 Oct 21
Good thing it’s not for the average person, it’s for developers to use. While it doesn’t follow a plugins generic sync API, it’s not that different.
HorlandoSR
Outdated
using v2.0.3
06 Sep 21
Nice Work

Reply to review by :

/ 5
Supported API versions
4.0.0
->
4.21.0
Requirements & Enhancements
API token Requirement DiscordBot Token, https://github.com/DiscordBot-PMMP/DiscordBot/wiki/Creating-your-discord-bot
Producers §
  • Collaborators:
    • @JaxkDev
License §

Custom license

View
Open Software License ("OSL") v. 3.0

This Open Software License (the "License") applies to any original work of
authorship (the "Original Work") whose owner (the "Licensor") has placed the
following licensing notice adjacent to the copyright notice for the Original
Work:

Licensed under the Open Software License version 3.0

1) Grant of Copyright License. Licensor grants You a worldwide, royalty-free,
non-exclusive, sublicensable license, for the duration of the copyright, to do
the following:

  a) to reproduce the Original Work in copies, either alone or as part of a
  collective work;

  b) to translate, adapt, alter, transform, modify, or arrange the Original
  Work, thereby creating derivative works ("Derivative Works") based upon the
  Original Work;

  c) to distribute or communicate copies of the Original Work and Derivative
  Works to the public, with the proviso that copies of Original Work or
  Derivative Works that You distribute or communicate shall be licensed under
  this Open Software License;

  d) to perform the Original Work publicly; and

  e) to display the Original Work publicly.

2) Grant of Patent License. Licensor grants You a worldwide, royalty-free,
non-exclusive, sublicensable license, under patent claims owned or controlled
by the Licensor that are embodied in the Original Work as furnished by the
Licensor, for the duration of the patents, to make, use, sell, offer for sale,
have made, and import the Original Work and Derivative Works.

3) Grant of Source Code License. The term "Source Code" means the preferred
form of the Original Work for making modifications to it and all available
documentation describing how to modify the Original Work. Licensor agrees to
provide a machine-readable copy of the Source Code of the Original Work along
with each copy of the Original Work that Licensor distributes. Licensor
reserves the right to satisfy this obligation by placing a machine-readable
copy of the Source Code in an information repository reasonably calculated to
permit inexpensive and convenient access by You for as long as Licensor
continues to distribute the Original Work.

4) Exclusions From License Grant. Neither the names of Licensor, nor the names
of any contributors to the Original Work, nor any of their trademarks or
service marks, may be used to endorse or promote products derived from this
Original Work without express prior permission of the Licensor. Except as
expressly stated herein, nothing in this License grants any license to
Licensor's trademarks, copyrights, patents, trade secrets or any other
intellectual property. No patent license is granted to make, use, sell, offer
for sale, have made, or import embodiments of any patent claims other than the
licensed claims defined in Section 2. No license is granted to the trademarks
of Licensor even if such marks are included in the Original Work. Nothing in
this License shall be interpreted to prohibit Licensor from licensing under
terms different from this License any Original Work that Licensor otherwise
would have a right to license.

5) External Deployment. The term "External Deployment" means the use,
distribution, or communication of the Original Work or Derivative Works in any
way such that the Original Work or Derivative Works may be used by anyone
other than You, whether those works are distributed or communicated to those
persons or made available as an application intended for use over a network.
As an express condition for the grants of license hereunder, You must treat
any External Deployment by You of the Original Work or a Derivative Work as a
distribution under section 1(c).

6) Attribution Rights. You must retain, in the Source Code of any Derivative
Works that You create, all copyright, patent, or trademark notices from the
Source Code of the Original Work, as well as any notices of licensing and any
descriptive text identified therein as an "Attribution Notice." You must cause
the Source Code for any Derivative Works that You create to carry a prominent
Attribution Notice reasonably calculated to inform recipients that You have
modified the Original Work.

7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that
the copyright in and to the Original Work and the patent rights granted herein
by Licensor are owned by the Licensor or are sublicensed to You under the
terms of this License with the permission of the contributor(s) of those
copyrights and patent rights. Except as expressly stated in the immediately
preceding sentence, the Original Work is provided under this License on an "AS
IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without
limitation, the warranties of non-infringement, merchantability or fitness for
a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK
IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this
License. No license to the Original Work is granted by this License except
under this disclaimer.

8) Limitation of Liability. Under no circumstances and under no legal theory,
whether in tort (including negligence), contract, or otherwise, shall the
Licensor be liable to anyone for any indirect, special, incidental, or
consequential damages of any character arising as a result of this License or
the use of the Original Work including, without limitation, damages for loss
of goodwill, work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses. This limitation of liability shall not
apply to the extent applicable law prohibits such limitation.

9) Acceptance and Termination. If, at any time, You expressly assented to this
License, that assent indicates your clear and irrevocable acceptance of this
License and all of its terms and conditions. If You distribute or communicate
copies of the Original Work or a Derivative Work, You must make a reasonable
effort under the circumstances to obtain the express assent of recipients to
the terms of this License. This License conditions your rights to undertake
the activities listed in Section 1, including your right to create Derivative
Works based upon the Original Work, and doing so without honoring these terms
and conditions is prohibited by copyright law and international treaty.
Nothing in this License is intended to affect copyright exceptions and
limitations (including "fair use" or "fair dealing"). This License shall
terminate immediately and You may no longer exercise any of the rights granted
to You by this License upon your failure to honor the conditions in Section
1(c).

10) Termination for Patent Action. This License shall terminate automatically
and You may no longer exercise any of the rights granted to You by this
License as of the date You commence an action, including a cross-claim or
counterclaim, against Licensor or any licensee alleging that the Original Work
infringes a patent. This termination provision shall not apply for an action
alleging patent infringement by combinations of the Original Work with other
software or hardware.

11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this
License may be brought only in the courts of a jurisdiction wherein the
Licensor resides or in which Licensor conducts its primary business, and under
the laws of that jurisdiction excluding its conflict-of-law provisions. The
application of the United Nations Convention on Contracts for the
International Sale of Goods is expressly excluded. Any use of the Original
Work outside the scope of this License or after its termination shall be
subject to the requirements and penalties of copyright or patent law in the
appropriate jurisdiction. This section shall survive the termination of this
License.

12) Attorneys' Fees. In any action to enforce the terms of this License or
seeking damages relating thereto, the prevailing party shall be entitled to
recover its costs and expenses, including, without limitation, reasonable
attorneys' fees and costs incurred in connection with such action, including
any appeal of such action. This section shall survive the termination of this
License.

13) Miscellaneous. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent necessary
to make it enforceable.

14) Definition of "You" in This License. "You" throughout this License,
whether in upper or lower case, means an individual or a legal entity
exercising rights under, and complying with all of the terms of, this License.
For legal entities, "You" includes any entity that controls, is controlled by,
or is under common control with you. For purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the direction or
management of such entity, whether by contract or otherwise, or (ii) ownership
of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
ownership of such entity.

15) Right to Use. You may use the Original Work in all ways not otherwise
restricted or conditioned by this License or by law, and Licensor promises not
to interfere with or be responsible for such uses by You.

16) Modification of This License. This License is Copyright © 2005 Lawrence
Rosen. Permission is granted to copy, distribute, or communicate this License
without modification. Nothing in this License permits You to modify this
License as applied to the Original Work or to Derivative Works. However, You
may modify the text of this License and copy, distribute or communicate your
modified version (the "Modified License") and apply it to other original works
of authorship subject to the following conditions: (i) You may not indicate in
any way that your Modified License is the "Open Software License" or "OSL" and
you may not use those names in the name of your Modified License; (ii) You
must replace the notice specified in the first paragraph above with the notice
"Licensed under <insert your license name here>" or with a notice of your own
that is not confusingly similar to the notice in this License; and (iii) You
may not claim that your original works are open source software unless your
Modified License has been approved by Open Source Initiative (OSI) and You
comply with its license review and certification process.
Categories:
API plugins
General
Permissions
Commands
External Internet clients
Custom threading

You can leave one review per plugin release, and delete or update your review at any time

/ 5
Loading...