Using InvMenu in a plugin

Running InvMenu from .phar

In a development environment

Download the DEVirion plugin and place the InvMenu .phar file in your virions/ folder.

pmmp_folder
|-- plugins
|   `-- devirion.phar
|-- virions
|   `-- InvMenu.phar

In a production environment

In a production environment, it is not necessary or recommended to install the DEVirion plugin or the InvMenu as a virion. These tools are intended for use during development and testing. When deploying your plugin for production, follow these steps:

1. Convert your plugin to a PHAR file
2. Download the InvMenu PHAR file
3. Inject the virion into your plugin PHAR by running bin/php7/bin/php path/to/InvMenu.phar path/to/yourplugin.phar
4. Install your injected plugin PHAR file on your production server (by moving it to your server's plugins/ directory)

If you have published your plugin on Poggit, you can skip the process of creating a production-ready version of your plugin and installing it in a production environment. Poggit will handle these tasks for you by injecting virions into your plugin and generating a deployable PHAR file. However, you will need to ensure that you have defined the virion in your .poggit.yml file so Poggit can properly build and package your plugin for deployment:

 --- # Poggit-CI Manifest. Open the CI at https://poggit.pmmp.io/ci/Muqsit/PlayerVaults
 branches:
 - master
 projects:
   PlayerVaults:
     path: ""
+    libs:
+      - src: muqsit/InvMenu/InvMenu
+        branch: "4.0"
+        version: ^4.4.1 # refer to InvMenu's virion.yml to find the latest version
 ...

Once the PHAR file has been generated by Poggit, you can directly install it on your production server.

Running InvMenu from source

It is generally not necessary to run InvMenu from source unless you are planning to make changes to the source code for your own personal use or to contribute back to the project. In most cases, it is sufficient to use the pre-built PHAR version which can be easily installed on your server.

To run InvMenu from source, download the DEVirion plugin and place the InvMenu source folder in your virions/ folder.

pmmp_folder
|-- plugins
|   `-- devirion.phar
|-- virions
|   |-- InvMenu-master
|      |-- src
|      `-- virion.yml