mvm 0.1.0

A Minecraft Version Manager for Vanilla and Paper servers.
Documentation 
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
83
84
85
86
87
88
89
90
91
92
93

# mvm: Minecraft Version Manager


**mvm** is a simple CLI-based Minecraft version manager that allows users to manage Vanilla and Paper Minecraft servers effortlessly. It supports downloading, using, and managing specific versions of servers through intuitive subcommands.

---

## Features

- **Install** and **delete** Minecraft server versions (Vanilla or Paper).
- **Activate** a specific version for use.
- **Determine** the path of a specific or recent server version.
- Defaults to **Vanilla** server management unless the `--paper` flag is provided for Paper servers.

---

## Installation

1. **Clone the repository:**
   ```bash
   git clone https://github.com/chriswinterowd/minecraft-version-manager

   cd minecraft-version-manager

   ```

2. **Build the project:**
   ```bash
   cargo build --release

   ```

3. **Install the `mvm` binary globally:**
   Use a symlink to make the `mvm` executable available system-wide:
   ```bash
   sudo ln -s $(pwd)/target/release/mvm /usr/local/bin/mvm

   ```

4. **Verify the installation:**
   ```bash
   mvm --help

   ```
   This should display the CLI help message, confirming that `mvm` is installed correctly.

---

### Subcommands

| Command            | Description                                | 
|--------------------|--------------------------------------------|
| `install`          | Installs a specific or latest server.      | 
| `use`              | Activates a specified server version.      | 
| `uninstall`        | Removes a specific server version.         |
| `which`            | Determines the path of a specified version.|

### Flags

- `--paper` : Specifies that you want to manage **Paper** servers. If this flag is **not provided**, **Vanilla** servers are managed by default.

---

## Examples


1. **Install the latest Vanilla version:**
   ```bash
   mvm install

   ```

2. **Install the latest Paper version:**
   ```bash
   mvm install --paper

   ```

3. **Activate a specific Vanilla version:**
   ```bash
   mvm use 1.20.2

   ```

4. **Activate a specific Paper version:**
   ```bash
   mvm use 1.20.2 --paper

   ```

5. **Uninstall a specific Paper version:**
   ```bash
   mvm uninstall 1.20.2 --paper

   ```

6. **Find the path of the latest installed Vanilla version:**
   ```bash
   mvm which

   ```

---

## License

Refer to [LICENSE.md](https://github.com/chriswinterowd/minecraft-version-manager/blob/master/LICENSE.md).

---