From 9d111e13f123b3fefe9fadd6d98c4bdd713bf979 Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Mon, 15 May 2023 14:58:31 +0100 Subject: [PATCH] CONTRIBUTING: added table of in-house dependencies and which classes, functions or namespaces they contain --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45841fc15a..0f3698d49e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,30 @@ Larger contributions like feature additions should be preceded by a [Change Prop ## Other things you'll need - [git](https://git-scm.com/) +## List of `pocketmine` namespaces which are in other repos +PocketMine-MP has several dependencies which are independent from the main server code. Most of them use the `pocketmine` namespace. +Some of these add extra classes to packages which already exist in PocketMine-MP. + +Take a look at the table below if you can't find the class or function you're looking for. + +| Source URL | Namespace, class or function | +|:----------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------| +| [pmmp/BedrockProtocol](https://github.com/pmmp/BedrockProtocol) | `pocketmine\network\mcpe\protocol` | +| [pmmp/BinaryUtils](https://github.com/pmmp/BinaryUtils) | `pocketmine\utils\BinaryDataException`
`pocketmine\utils\BinaryStream`
`pocketmine\utils\Binary` | +| [pmmp/ClassLoader](https://github.com/pmmp/`ClassLoader`) | `BaseClassLoader`
`ClassLoader`
`DynamicClassLoader` | +| [pmmp/Color](https://github.com/pmmp/Color) | `pocketmine\color` | +| [pmmp/ErrorHandler](https://github.com/pmmp/ErrorHandler) | `pocketmine\errorhandler` | +| [pmmp/LogPthreads](https://github.com/pmmp/LogPthreads) | `ThreadedLoggerAttachment`
`ThreadedLogger`
`AttachableThreadedLogger` | +| [pmmp/Log](https://github.com/pmmp/Log) | `AttachableLogger`
`BufferedLogger`
`GlobalLogger`
`LogLevel`
`Logger`
`PrefixedLogger`
`SimpleLogger` | +| [pmmp/Math](https://github.com/pmmp/Math) | `pocketmine\math` | +| [pmmp/NBT](https://github.com/pmmp/NBT) | `pocketmine\nbt` | +| [pmmp/RakLibIpc](https://github.com/pmmp/RakLibIpc) | `raklib\server\ipc` | +| [pmmp/RakLib](https://github.com/pmmp/RakLib) | `raklib` | +| [pmmp/Snooze](https://github.com/pmmp/Snooze) | `pocketmine\snooze` | +| [pmmp/ext-chunkutils2](https://github.com/pmmp/ext-chunkutils2) | `pocketmine\world\format\LightArray`
`pocketmine\world\format\PalettedBlockArray`
`pocketmine\world\format\io\SubChunkConverter` | +| [pmmp/ext-morton](https://github.com/pmmp/ext-morton) | `morton2d_decode`
`morton2d_encode`
`morton3d_decode`
`morton3d_encode` | +| [pmmp/ext-libdeflate](https://github.com/pmmp/ext-libdeflate) | `libdeflate_deflate_compress`
`libdeflate_gzip_compress`
`libdeflate_zlib_compress` | + ## Choosing a target branch PocketMine-MP has three primary branches of development.