papa 4.0.0

A cli mod manager for the Northstar launcher
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<h1 align="center">
 <!-- Formatting idea shamelessly stolen from https://github.com/OneGal/viper ty for the idea :) -->
 <img src="https://static.wikia.nocookie.net/titanfall/images/d/d5/ScorchIcon.png" />
 <br>
 Papa
<br>
<a href="https://github.com/AnActualEmerald/papa/actions/workflows/rust.yml"> 
 <img alt="Rust workflow badge" src="https://github.com/AnActualEmerald/papa/actions/workflows/rust.yml/badge.svg" />
</a>
<a href="https://crates.io/crates/papa">
 <img alt="Crates.io (latest)" src="https://img.shields.io/crates/dv/papa" />
</a>
</h1>


<p align="center">Mod manager CLI for <a href="https://github.com/R2Northstar/Northstar">Northstar</a></p>

## Features
- Install and update Northstar from the command line
- Search Thunderstore for mods from the command line
- Download a mod *and* its dependencies with one command
- Easily keep your mods up to date

## Usage

```bash
papa install fifty.server_utilities #install a mod
papa list #list installed mods
papa update #update any out of date mods
papa remove fifty.server_utilities #uninstall a mod
```

## Upgrading to v4.0.0
v4 includes support for Northstar's new native thunderstore package loading, meaning that
mods that live in the current `mods` directory won't be managed by `papa` anymore. I suggest
running `papa export` before updating to v4, and then running `papa import` to reinstall your
mods in the new `package` directory. The old mods will need to be removed manually, 
just be sure to not delete the `Northstar.` core mods (or at least run `papa ns init -f` to reinstall them afterwards)

## Installation
I suggest that you initialize Northstar to set everything up automatically
```bash
papa ns init
```
Or create a file at `.config/papa/config.toml` and set `install_dir` to whatever directory you want

### Ubuntu/Debian(& derivatives)
Download the `.deb` file from the latest release and install it using whatever you usually use to install packages:
```bash

sudo apt install ./papa_4.0.0.deb

```

### Arch Linux
Community maintained `papa` and `papa-bin` packages are available on the AUR:
```bash
paru -S papa
```

### Windows
Download and run the `.msi` installer from the latest release.

### Using prebuilt binaries
Download the appropriate binary for your system (make sure you get the `.exe` for Windows) and place it somewhere in your PATH. You should then be able to call the `papa` command from your favorite command line.

### Building from source
If you have cargo installed on your system, you should be able to install `papa` directly from [crates.io](https://crates.io)
```bash
 cargo install papa
```
or from the git repo
```bash
 cargo install --git https://github.com/AnActualEmerald/papa
```
If you want to build from source but don't have cargo installed, you should check out [rustup.rs](https://rustup.rs)
#### Dependencies
* pkgconfig
* openssl

## Caveats 
- The default install directory is **relative to the current working directory**, meaning that running `papa install` in `~/` will install mods into `~/mods`