Skip to content

Easily install and manage Godot-plugins from GitHub using the command line

License

Notifications You must be signed in to change notification settings

Glow-Project/ppm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

>ppm

badge badge badge


Pour Package Manager

Easily install and manage Godot-plugins from GitHub and the Godot Asset Library using the command line

asciicast

Commands

Initialize

Initialize a ppm.json file

$ ppm init

Install

Either declare a plugin to install or install all plugins that are declared in the ppm.json file

Install plugin from GitHub

$ ppm install <user>/<repository>

You can also install a certain version/tag of the plugin

$ ppm install <user>/<repository>@<version>

When not defining a version, ppm always chooses the default branch

Install plugin from the Godot asset library

$ ppm install <plugin>

Update

Update all your plugins

$ ppm update

Uninstall

Uninstall a dependency

$ ppm uninstall <plugin>

More

For further information and commands use

$ ppm -h

Installation

Main way

Download the binary from the release page

Installation from Source

$ git clone https://github.com/Glow-Project/ppm

$ go install

Migration to newer versions

To migrate your ppm project from an older to a newer version you can simply run:

$ ppm tidy

Create ppm-compatible plugins

  1. (optional) Create a new project in Godot and create a directory with the name of your plugin inside the addons directory
  2. Create the plugin (plugin.cfg, plugin.gd, ...)
  3. (optional) run ppm init inside of the directory of your plugin
  4. publish your plugin (e.g. /home/GodotProject/addons/my-plugin) to GitHub as a public repository
  5. Now you can install your plugin via ppm install <your-username>/<your-repository-name>

References