https://github.com/glow-project/ppm
Easily install and manage Godot-plugins from GitHub using the command line
https://github.com/glow-project/ppm
cli godot golang package-manager
Last synced: 8 months ago
JSON representation
Easily install and manage Godot-plugins from GitHub using the command line
- Host: GitHub
- URL: https://github.com/glow-project/ppm
- Owner: Glow-Project
- License: mit
- Created: 2021-09-08T14:30:41.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-20T13:48:07.000Z (almost 3 years ago)
- Last Synced: 2025-08-30T19:03:04.977Z (10 months ago)
- Topics: cli, godot, golang, package-manager
- Language: Go
- Homepage:
- Size: 127 KB
- Stars: 9
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Pour Package Manager**
Easily install and manage Godot-plugins from GitHub and the Godot Asset Library using the command line
[](https://asciinema.org/a/D0cRCFOtekhWOmeC8TxUcpJXo)
## Commands
### Initialize
Initialize a `ppm.json` file
```bash
$ 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
```bash
$ ppm install /
```
You can also install a certain version/tag of the plugin
```bash
$ ppm install /@
```
When not defining a version, ppm always chooses the default branch
#### Install plugin from the Godot asset library
```bash
$ ppm install
```
### Update
Update all your plugins
```bash
$ ppm update
```
### Uninstall
Uninstall a dependency
```bash
$ ppm uninstall
```
### More
For further information and commands use
```bash
$ ppm -h
```
## Installation
### Main way
Download the binary from the [**release page**](https://github.com/Glow-Project/ppm/releases)
### Installation from Source
```bash
$ 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:
```sh
$ 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
1. Create the plugin (`plugin.cfg`, `plugin.gd`, ...)
1. (optional) run `ppm init` inside of the directory of your plugin
1. publish your plugin (e.g. `/home/GodotProject/addons/my-plugin`) to GitHub as a public repository
1. Now you can install your plugin via `ppm install /`
#### References
- [Glow-Project/ppm-ui](https://github.com/Glow-Project/ppm-ui)
- [Glow-Project/SettingsManager](https://github.com/Glow-Project/SettingsManager)
- [Glow-Project/DialogueSystem](https://github.com/Glow-Project/DialogueSystem)