Paper-Tool

Paper-Tool is a simple and efficient Bash script that helps you download, install, and update PaperMC Minecraft server software. With just a few commands, you can manage different Minecraft and Paper builds effortlessly. Whether you're setting up a new server or keeping your existing server updated, Paper-Tool makes it easy to handle the installation and update process.

---

Table of Contents

• Features
• Installation
• Usage
  • Commands
  • Examples

---

Features

• List Available Versions: View all available Minecraft versions and Paper builds.
• Install Minecraft and Paper: Installs a specific Minecraft version and optionally a specific Paper build.
• Update Server: Update to the latest Paper build for the installed Minecraft version with single command.
• Server Information: Display the current installed Minecraft version and Paper build.
• Server Start: Start easily your server with one command.

---

Installation

From HomeBrew

1. Tap my formula:

   brew tap satanicantichrist/satanicantichrist

2. Install Paper-Tool:

   brew install satanicantichrist/papertool

From source

1. Clone the repository:

   git clone https://github.com/satanicantichrist/Paper-Tool.git

2. Navigate to the script directory:

   cd Paper-Tool

3. Make the script executable:

   chmod +x papertool

4. Run the script:

   ./papertool

Usage

Commands

• papertool-tui Runs Paper-Tool in TUI mode.

• papertool list --minecraft Lists all available Minecraft versions. This command allows you to see all the versions of Minecraft that can be used for your PaperMC server.

• papertool list --paper <minecraft_version> Lists all available Paper builds for a specified Minecraft version. For example, list --paper 1.16.5 will show all Paper builds for Minecraft 1.16.5.

• papertool update Automatically updates to the newest PaperMC build for the currently installed Minecraft version.

• papertool install --minecraft-version <minecraft_version> --paper-version <paper_build_id> Installs a specified Minecraft version and optionally a specific Paper build. If the Paper build ID is provided, it will install that build.

• papertool info Displays information about the currently installed Minecraft version and Paper build ID. This command is helpful to verify your setup.

• papertool run --accept-eula Starts server without gui, if you use flag --accept-eula, it will automatically accept eula and start the server.

---

Examples

All examples are written with brew installation in mind, to use script downloaded from source use ./papertool while being in scripts directory

Example 1: List available Minecraft versions

papertool list --minecraft

output:

1.17.1
1.18.2
1.19.4
1.20.1

Example 2: List available Paper builds for Minecraft 1.18.2

papertool list --paper 1.18.2

output:

385
386
387
388

Example 3: Update to the latest Paper build

papertool update

This command will update your current PaperMC server to the latest stable build for the installed Minecraft version.

Example 4: Install Minecraft 1.19.4 and a specific Paper build

papertool install --minecraft-version 1.19.4 --paper-version 540

This installs Minecraft 1.19.4 and Paper build 540.

Example 5: Check the current installed version and build

papertool info

output:

Installed Minecraft version: 1.21.3
Installed Paper build: 81

This starts your server.

Example 6: Start server

papertool run --accept-eula

This starts your server, and automatically accepts eula, so you don´t have to edit the file after the first start.