Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jasonw4331/libcustompack
A library for compiling and registering resource packs on PocketMine Servers
https://github.com/jasonw4331/libcustompack
php pocketmine pocketmine-mp poggit-virion
Last synced: 3 months ago
JSON representation
A library for compiling and registering resource packs on PocketMine Servers
- Host: GitHub
- URL: https://github.com/jasonw4331/libcustompack
- Owner: jasonw4331
- License: lgpl-3.0
- Created: 2022-06-05T10:49:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T06:06:54.000Z (11 months ago)
- Last Synced: 2024-10-09T23:22:20.106Z (3 months ago)
- Topics: php, pocketmine, pocketmine-mp, poggit-virion
- Language: PHP
- Homepage:
- Size: 80.1 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# libCustomPack
[](https://poggit.pmmp.io/ci/jasonw4331/libCustomPack/libCustomPack)
A small library for building and registering resource packs with PocketMine-MP
## Usage
This viron was made for developers to build resource packs from plugin resources or from files on the disk, and allows adding new resource packs to the stack without requiring a server restart.
*NOTE*: New resource packs are not automatically updated for previously loaded players. Only new players will see new resource packs.
#### Required imports
The following imports are necessary to use the virion library:
```php
use libCustomPack\libCustomPack;
```
### API
#### Building a resource pack
2 methods are added which allow build a resource pack using the plugin's resource directory or any other given path.
```php
libCustomPack::generatePackFromResources($plugin);
//OR
libCustomPack::generatePackFromPath($plugin, $MyFullFolderPath);
```
#### Registering a resource pack
A resource pack can be added to the resource stack using the `registerResourcePack()` method.
```php
libCustomPack::registerResourcePack($resoucePackInstance);
```
#### Unregistering a resource pack
During a plugin's onDisable() method, it is recommended to call the `unregisterResourcePack()` method to be removed from the resource stack.
```php
libCustomPack::unregisterResourcePack($resoucePackInstance);
```
### SubFolders
If the resource pack is a folder we don't know the exact location of within the given folder, we can use the `$packFolderName` parameter to specify the name of the folder to be found.
The default subfolder name is the plugin's name followed by " Pack".
```php
libCustomPack::generatePackFromResources($plugin, $packFolderName);
//OR
libCustomPack::generatePackFromPath($plugin, $MyFullFolderPath, $packFolderName);
```