ve-launcher
===========

CLI-based Voxel Eras launcher for development purposes.

Requires you to manually provide binaries for each VE.

Likely only supports Linux right now. Windows and macOS are
untested.

install
-------

Dependencies: Puppy

  git clone https://git.girlkisser.top/ve-launcher
  cd ve-launcher
  cp vel.pup ~/.local/bin/vel

usage
-----

  vel help                       Print help and usage information.
  vel info                       Print info related to vel, instances, etc.
  vel new NAME VERSION           Create a new instance.
  vel del NAME                   Delete an instance.
  vel mod NAME subcommand        Manage mods for instance `NAME`.
  vel play NAME                  Launch the given instance.
  vel dev NAME VERSION           Create a new development environment for a mod called NAME.

  `mod` usage:
    vel mod NAME add|del ...

    add:
      git REPO    Clone a git repo (with --depth=1) as a mod.
      src PATH    Copy a directory to the instance's mods folder.
    del NAME      Delete a mod (moves it to mods/.trash/).

examples
--------

Create a new instance called `meow-beta` for v1.4.2, then
add MEOW to the instance by cloning it from the Git repo,
then launch:
  vel new meow-beta 1.4.2
  vel mod meow-beta add git https://git.girlkisser.top/emmeline/meow/
  vel play meow-beta

Create a new development env for a mod called `my-mod`:
  vel dev my-mod 1.4.2
  vel play my-mod