mca/README.md
2025-04-23 23:16:55 +05:00

71 lines
1.8 KiB
Markdown

# Minecraft server launcher - utility
MCA is easy-to-use and allows you to run a Minecraft server with
just one short command in the background with the ability to
view the output with GNU Screen and run commands.
## Usage
```bash
mca [-fdx] [MCA_NAME|MCA_JAR|MCA_DIR] [--] [INPUT]
```
## MCA examples
### Running `minecraft` server with 2048 megabytes max memory
```bash
mkdir ~/mca/myserver
cd ~/mca/myserver
# This link is taken from https://www.minecraft.net/en-us/download/server
wget https://piston-data.mojang.com/v1/objects/e6ec2f64e6080b9b5d9b471b291c33cc7f509733/server.jar
echo 'MAX_MEMORY=2048M' >> ./.mcarc
mca
```
### Running `paper` server with Aikar flags
```bash
echo 'PLATFORM=paper' >> ./.mcarc
mca
```
### Running `velocity` server with Aikar flags
```bash
echo 'PLATFORM=velocity' >> ./.mcarc
mca
```
Also, the platform can be determined automatically based on the `.jar` name. For example, the file name is `paper-1.21.5.jar`, since it starts with `paper`, the platform will be `paper` and there is no need to manually specify it in the `PLATFORM` variable.
## Installation
### From Zhira Debian repository
Debian 12 Bookworm has deb packages in the Zhira Debian repository.
#### Add the Zhira Debian repository:
```bash
wget -qO- https://deb.zhira.net/debian/zhira.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/zhira.gpg > /dev/null
echo 'deb [arch=all] https://deb.zhira.net/debian/ bookworm main' | sudo tee /etc/apt/sources.list.d/zhira.list > /dev/null
```
#### Update the package list
```bash
sudo apt update
```
#### Install `mca`
```bash
sudo apt install mca
```
### From sources
#### Clone the repository
```bash
git clone https://git.zhira.net/rozhur/mca
```
### Install `mca` into `/usr/local/bin` directory
```bash
cd ./mca
sudo make PREFIX=/usr/local install
```