https://github.com/tjkessler/papermc-updater

A command-line tool to update PaperMC server .jar file (in-place)
https://github.com/tjkessler/papermc-updater

command-line-tool papermc papermc-api papermc-server python

Last synced: 12 days ago
JSON representation

A command-line tool to update PaperMC server .jar file (in-place)

• Host: GitHub
• URL: https://github.com/tjkessler/papermc-updater
• Owner: tjkessler
• License: apache-2.0
• Created: 2023-08-19T03:43:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-03T19:06:15.000Z (12 months ago)
• Last Synced: 2024-10-11T03:42:09.022Z (about 1 month ago)
• Topics: command-line-tool, papermc, papermc-api, papermc-server, python
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# papermc-updater

[![GitHub version](https://badge.fury.io/gh/tjkessler%2Fpapermc-updater.svg)](https://badge.fury.io/gh/tjkessler%2Fpapermc-updater)

[![PyPI version](https://badge.fury.io/py/papermc-updater.svg)](https://badge.fury.io/py/papermc-updater)

[![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](https://raw.githubusercontent.com/tjkessler/papermc-updater/master/LICENSE.txt)

A command-line tool to update a PaperMC server .jar file (in-place) to the latest build. Supports latest and previous MC versions.

## Installation

Requires Python 3.10+.

### From PyPI

```

$ python -m pip install papermc-updater

```

or

```

$ pip install papermc-updater

```

### From source

```

$ git clone https://github.com/tjkessler/papermc-updater

$ cd papermc-updater

$ python -m pip install .

```

## Usage

Warning: this tool replaces the existing PaperMC server .jar file!

### Command line

```

$ update-papermc $PATH_TO_EXISTING_JARFILE

```

The default MC version is the latest stable release - specify a different MC version with:

```

$ update-papermc $PATH_TO_EXISTING_JARFILE --version 1.19.4

```

### Python script

```python

from papermc_updater import update_paper_to_latest

update_paper_to_latest("$PATH_TO_EXISTING_JARFILE")  # latest stable release

update_paper_to_latest("$PATH_TO_EXISTING_JARFILE", version="1.19.4")

```