Cosmix

A dead simple CLI-based launcher for Cosmic Reach and Cosmic Quilt.

Installation

# From PyPI (recommended)
python3 -m pip install cosmix-launcher
# From source
git clone https://codeberg.org/emmathemartian/cosmix && cd cosmix
python3 -m pip install -r requirements.txt
python3 -m build
python3 -m pip install ./dist/*.whl

I highly recommend making an alias to Cosmix so that you do not have to repeatedly type python3 -m cosmix.

On Linux and MacOS:

In Zsh, just append this to ~/.zshrc:

alias cosmix="python3 -m cosmix"

On Windows:

On Windows download cosmix.bat and put it in C:\Windows\System32 or somewhere else where your shell can find it / in your path.

Updating

python3 -m pip install --upgrade cosmix-launcher

Uninstallation

python3 -m pip uninstall cosmix-launcher

Troubleshooting

Arch Linux:

Arch Linux and its derivatives may complain with error: externally-managed-environment. To get around this, use the --user --break-system-packages options with pip install.

Obviously this has a chance of breaking something, but in my testing I have yet to have that happen. Though be aware and know that I am not responsible if you break your system.

Maven:

You may also need to install Maven. On Arch Linux this is just pacman -S maven.

Maven is used to download and resolve all of Cosmic Quilt's dependencies automatically, hence why it is required.

Usage

cosmix version
 prints the current installed cosmix version
cosmix debug
 prints a lot of debug information related to cosmix
cosmix add [instance]
 adds and downloads a new instance
 options:
 --version -v VERSION specify a Cosmic Reach version to use. defaults to "latest"
 --quilt-version -q VERSION specify a Cosmic Quilt version to use. defaults to "none"
 --display-name -n NAME optionally specify a display name for the instance
cosmix update [instance]
 updates an existing version
 options:
 --version -v VERSION specify a Cosimc Reach version to use. defaults to "latest"
 --quilt-version -q VERSION specify a Cosmic Quilt version to use. defaults to "none"
cosmix instances
 lists all instances
cosmix launch [instance]
 launches an instance
cosmix info [instance]
 prints info about an instance
cosmix add-mod [instance] [path to mod jar]
 adds a mod jar to an instance
cosmix add-crm1-mod [instance] [mod id]
 adds a mod to an instance via CRM-1. To add repos, see ~/.local/share/cosmix/config.hjson
cosmix trash [instance]
 moves an instance to the system's trash folder

Examples

# Create an unmodded instance named `vanilla` on the latest CR version
cosmix add vanilla
# Create a Cosmic Quilt instance named `my-quilt` on the latest CR version with Cosmic Quilt 1.2.7
cosmix add my-quilt --quilt-version 1.2.7
# Create a vanilla instance named `old-version` on CR 0.0.1
cosmix add old-version -v 0.0.1
# Install the latest version of Flux API available on JoJoJux's autorepo to the instance `test`
cosmix add-crm1-mod test dev.crmodders.flux
# Update the `latest` instance to the latest available versions of Cosmic Reach and Cosmic Quilt
cosmix update latest -v latest -q latest

File Structure

Cosmix stores all of its data in your $XDG_DATA_HOME (typically ~/.local/share/) on Linux and %appdata% on Windows and in the cosmix folder.

This folder will contain the following extra folders:

cosmix/
 config.hjson - Configs for Cosmix
 deps/
 cosmic-reach/
 Contains JARs for each downloaded Cosmic Reach version.
 instances/
 example-instance/
 config.hjson - Configs for the instance.
 deps/
 If the instance is modded, this folder is used to store Cosmic Quilt and its dependencies.