Skip to content

Commit

Permalink
chore: update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
epicbigcat committed Dec 7, 2024
1 parent 40bb3b3 commit a4ef3fb
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ The launcher for [Allay](https://github.com/AllayMC/Allay) that aims to be small

## Features

- [x] Detect java status
- [x] Manage Allay
- [x] Discover system proxy setting automatically
- [ ] Arm64 architecture support
- [x] Automatically check java installation status.
- [x] Manage allay server.
- [x] Use a proxy to download updates.
- [x] Broad platform support.
- [ ] Managed java environment.

## Installation

Expand All @@ -27,7 +28,7 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/All

## Commands

Start the server (will download the latest nightly version of allay if allay haven't been downloaded):
Start the server (will download the latest version of allay if it is not installed):

```bash
allay
Expand All @@ -36,41 +37,42 @@ allay
This is equal to:

```bash
allay -u -r -n
allay --run --update --nightly
```

Available options:
Allows concatenation of single-character arguments:

- `-u` Check for update before starting the server
- `-r` Run allay server
- `-n` Use nightly build
- `-a` Pass arguments to java
- `-d` Use deamon mode, which the launcher will restart the server after server stopped
```bash
allay -run
```

Start the server with specified memory limit:
Available options:

Linux:
- `-r`, `--run` Run allay server
- `-u`, `--update` Check for update before starting the server
- `-n`, `--nightly` Use nightly build
- `-d`, `--daemon` Use deamon mode, which the launcher will restart the server after server stopped
- `-a`, `--args` Pass arguments to java

```bash
allay -u -r -n -a '\-Xms1G \-Xmx4G'
```
Pass custom parameters to the JVM, such as memory limits:

Windows(CMD):
> [!IMPORTANT]
> The "-" before the parameter will be automatically added.
```cmd
allay -u -r -n -a '-Xms1G -Xmx4G'
```bash
allay -run --args Xms1G Xmx4G
```

Start the server, and will restart the server if server crashed:
Start the server in daemon mode:

```bash
allay -u -r -n -d
allay -rund
```

Start the server, but do not check for update:

```bash
allay -r
allay --run
```

## License
Expand Down

0 comments on commit a4ef3fb

Please sign in to comment.