Skip to content

Getting Started

ImperaZim edited this page Jun 29, 2026 · 3 revisions

Getting Started

This page is the shortest path to a working EasyLibrary 3.x server.

Requirements

  • PocketMine-MP 5.x.
  • PHP 8.2 or newer.
  • EasyLibrary 3.0.0-dev while the 3.x migration is still in development.
  • Restart access. Package-backed providers are discovered during PMMP boot.

First Boot

Install EasyLibrary.phar, start the server, then run:

/easylibrary doctor
/easylibrary packages doctor
/easylibrary config doctor

At minimum, every doctor should report Problems: 0.

For a quick performance snapshot of EasyLibrary-owned work:

/easylibrary timings

When changing config, reload only the safe config layer:

/easylibrary config reload
/easylibrary runtime reload reload-config

For package, proxy, component, command backend or permission changes, use:

/easylibrary runtime reload request-runtime-reload

That command reports restart boundaries. It does not hot-swap PHP/plugin state.

Choose A Provider Model

Need Recommended provider
One manager plugin owns official libs Package-backed packages
A library must be an independent plugin Standalone PHAR
Old 2.x full-bundle behavior Stay on 2.x while migrating

Do not keep standalone and package-backed copies active long-term for the same library. Mixed mode exists to make migration safe.

Install A Package

Package operations are dry-run by default:

/easylibrary packages install libcommand

To write files, enable package writes in config and repeat with confirm:

/easylibrary packages install libcommand stable confirm
restart server
/easylibrary packages doctor

Plugin Developer Rule

Only hard-depend on EasyLibrary when your plugin cannot run without it:

depend:
  - EasyLibrary

Use soft dependencies for optional integrations:

softdepend:
  - EasyLibrary
  - LibCommand
  - LibPlaceholder
  - LibWorld

Clone this wiki locally