https://github.com/geraintluff/node-reapack
Command-line tool for ReaPack (REAPER package tool) index file generation
https://github.com/geraintluff/node-reapack
Last synced: about 1 month ago
JSON representation
Command-line tool for ReaPack (REAPER package tool) index file generation
- Host: GitHub
- URL: https://github.com/geraintluff/node-reapack
- Owner: geraintluff
- Created: 2017-01-12T11:26:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-07T09:04:18.000Z (almost 8 years ago)
- Last Synced: 2025-01-28T21:18:23.029Z (over 1 year ago)
- Language: JavaScript
- Size: 28.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Command-line (Node.js module) for ReaPack index file generation
This is an index generator and release manager for a ReaPack collection (REAPER effects, themes, etc.) hosted on a static site (e.g. GitHub Pages, or your own web-server). It is written in Node (JavaScript).
## How it works
The state is stored in `reapack.json`, and this is used to generate the `index.xml` used by ReaPack. (Do not modify `index.xml`, your changes will be overwritten.)
Each release copies the applicable files to a new release folder, with a JSON file (`reapack-version.json`) describing that release. To create `index.xml`, the directory is scanned for `reapack-version.json` files.
## How to install
```
npm install -g reapack
```
If a global install (`-g`) doesn't work, then you can do a local install, and instead of just running `reapack`, run `node node_modules/reapack`.
## How to use it
The command-line attempts to be intuitive (use `--help` on any command to get more information), but here are some examples to get started:
View the index and list all packages:
```
> reapack index
Geraint's JSFX
--------------
README: README.md
links:
website: https://geraintluff.github.io/jsfx/
packages:
Bad Connection (effect in "Distortion")
Dual Distortion (effect in "Distortion")
Spectrum Matcher (effect in "Utility")
```
View a package:
```
> reapack package "Bad Connection"
Bad Connection
--------------
type: effect
category: Distortion
version: 1.0.1
files:
Bad Connection.jsfx
ui-lib.jsfx-inc
links:
screenshot: Bad Connection.png
```
Add/remove files:
```
> reapack package "Bad Connection" --add "some-file.jsfx" --remove "other-file.jsfx"
```
Simulate a ReaPack install (useful when developing your effects):
```
> reapack install C:\Users\Geraint\AppData\Roaming\REAPER
```
## TODO
There are some missing features (e.g. a command to add links, remove/rename packages), which at the moment are only possible by editing `reapack.json` by hand.