Skip to content

Commit

Permalink
Update README.md with new features and statistics data
Browse files Browse the repository at this point in the history
  • Loading branch information
Kamesuta committed Feb 7, 2024
1 parent a2e44e0 commit 634c5da
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 7 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# BungeePteroPower
![LogoArt](https://github.com/Kamesuta/BungeePteroPower/assets/16362824/e8914f79-806b-436c-a0e6-e4eaf8ad5eca)
[![Spigotmc Available](https://img.shields.io/badge/Spigotmc-Download-green)](https://www.spigotmc.org/resources/%E2%9A%A1-bungeepteropower-%E2%9A%A1-start-stop-servers-when-player-join-leave.114883/)
[![JitPack](https://jitpack.io/v/Kamesuta/BungeePteroPower.svg)](https://jitpack.io/#Kamesuta/BungeePteroPower)
[![License: MIT](https://img.shields.io/github/license/Kamesuta/BungeePteroPower?label=License)](LICENSE)
[![Spigotmc Version](https://img.shields.io/spiget/version/114883?logo=spigotmc&label=Spigotmc%20Version)](https://www.spigotmc.org/resources/%E2%9A%A1-bungeepteropower-%E2%9A%A1-start-stop-servers-when-player-join-leave.114883/)
[![JitPack](https://img.shields.io/jitpack/version/com.github.Kamesuta/BungeePteroPower?logo=jitpack&label=JitPack)](https://jitpack.io/#Kamesuta/BungeePteroPower)
[![Spigotmc Downloads](https://img.shields.io/spiget/downloads/114883?logo=spigotmc&label=Spigotmc%20Downloads)](https://www.spigotmc.org/resources/%E2%9A%A1-bungeepteropower-%E2%9A%A1-start-stop-servers-when-player-join-leave.114883/)
[![bStats Servers](https://img.shields.io/bstats/servers/20917?label=bStats%20Servers)](https://bstats.org/plugin/bungeecord/BungeePteroPower/20917)

BungeePteroPower is a plugin that can automatically start/stop servers based on the number of players.
It can start and stop servers on the [Pterodactyl panel](https://pterodactyl.io/) when players join or leave the Bungeecord proxy server.
Expand Down Expand Up @@ -139,6 +142,9 @@ The `config.yml` file includes the following settings, but not all items need to
- `timeout`: Set the maximum waiting time for players to join after server startup.
- Set this value to the maximum time it takes for the server to start.
- Setting it to 0 disables this feature, and players will not automatically join after startup.
- `joinDelay`: Once the server is pingable, wait the specified amount of seconds before sending the player to the server
- This is useful to wait for plugins like Luckperms to fully load
- If you set it to 0, the player will be connected as soon as the server is pingable
- `pingInterval`: Set the interval for checking the server's status.
- `servers`: Configure settings for each server. Set the server ID and the time until automatic shutdown.
- `timeout`: When there are no players on the server, it will stop after a certain period. The unit is seconds.
Expand All @@ -158,7 +164,11 @@ BungeePteroPower plugin allows fine-grained control over commands available to p

### About Language Files

- Upon startup, a file for the language set in `config.yml` will be generated.
- You can set the language in config.yml using the language option.
- Please refer to the comments in the config file for the supported languages.
- Upon startup, a file for the language set in config.yml will be generated.
- This file allows you to define only the messages you want to change.
- Messages that are not defined will be loaded from the language file set within the plugin.
- You can edit and then reload the plugin's language by using the `/ptero reload` command.
- Contributions via Pull Requests for additional language files are welcome.

Expand Down Expand Up @@ -233,3 +243,11 @@ mvn install
```
- This plugin needs to be built with Java 11 or higher.
- After building, a `BungeePteroPower-<version>.jar` file will be generated in the `target` directory.

## About Statistics Data

BungeePteroPower collects anonymous statistical data using [bStats](https://bstats.org/).
You can find the statistics data [here](https://bstats.org/plugin/bungeecord/BungeePteroPower/20917).

bStats is used to understand the usage of the plugin and help improve it.
To disable the collection of statistical data, please set `enabled` to `false` in `plugins/bStats/config.yml`
24 changes: 21 additions & 3 deletions README_ja.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# BungeePteroPower
![LogoArt](https://github.com/Kamesuta/BungeePteroPower/assets/16362824/e8914f79-806b-436c-a0e6-e4eaf8ad5eca)
[![Spigotmc Available](https://img.shields.io/badge/Spigotmc-ダウンロード-green)](https://www.spigotmc.org/resources/%E2%9A%A1-bungeepteropower-%E2%9A%A1-start-stop-servers-when-player-join-leave.114883/)
[![JitPack](https://jitpack.io/v/Kamesuta/BungeePteroPower.svg)](https://jitpack.io/#Kamesuta/BungeePteroPower)
[![License: MIT](https://img.shields.io/github/license/Kamesuta/BungeePteroPower?label=License)](LICENSE)
[![Spigotmc Version](https://img.shields.io/spiget/version/114883?logo=spigotmc&label=Spigotmc%20Version)](https://www.spigotmc.org/resources/%E2%9A%A1-bungeepteropower-%E2%9A%A1-start-stop-servers-when-player-join-leave.114883/)
[![JitPack](https://img.shields.io/jitpack/version/com.github.Kamesuta/BungeePteroPower?logo=jitpack&label=JitPack)](https://jitpack.io/#Kamesuta/BungeePteroPower)
[![Spigotmc Downloads](https://img.shields.io/spiget/downloads/114883?logo=spigotmc&label=Spigotmc%20Downloads)](https://www.spigotmc.org/resources/%E2%9A%A1-bungeepteropower-%E2%9A%A1-start-stop-servers-when-player-join-leave.114883/)
[![bStats Servers](https://img.shields.io/bstats/servers/20917?label=bStats%20Servers)](https://bstats.org/plugin/bungeecord/BungeePteroPower/20917)

BungeePteroPowerは、サーバーの人数に応じてサーバーを自動的に起動/終了することができるプラグインです。
プレイヤーがBungeecordプロキシサーバーに参加または退出したときに、[Pterodactylパネル](https://pterodactyl.io/)上のサーバーを起動および停止することができます。
Expand Down Expand Up @@ -139,6 +142,9 @@ https://github.com/Kamesuta/BungeePteroPower/assets/16362824/019fdfc5-f0fc-4532-
- `timeout`: サーバー起動後、プレイヤーが参加するまでの最大待機時間を設定します。
- この値をサーバーが起動するまでの最大時間を設定してください。
- 0に設定すると、この機能はOFFになり、起動後にプレイヤーが自動参加することはなくなります。
- `joinDelay`: サーバーがping可能になった後、プレイヤーをサーバーに送る前に指定した秒数待機します。
- この遅延はLuckpermsなどのプラグインが完全に読み込まれるのを待つために役立ちます。
- 0に設定すると、サーバーがping可能になるとすぐにプレイヤーが接続されます。
- `pingInterval`: サーバーのステータスをチェックする間隔を設定します。
- `servers`: サーバーごとの設定を行います。サーバーIDと自動停止までの時間を設定します。
- `timeout`: サーバーからプレイヤーがいなくなった際、一定時間プレイヤーがいない場合にサーバーを停止します。単位は秒です。
Expand All @@ -158,7 +164,11 @@ BungeePteroPowerプラグインでは、パーミッションを使用して、

### 言語ファイルについて

- 起動すると、`config.yml`の `language` で設定した言語のファイルが生成されます。
- `config.yml`の `language` で言語を設定できます。
- 対応している言語は[コンフィグ内のコメント](./src/main/resources/config.yml)を参照してください。
- 起動すると、コンフィグで設定した言語のファイルが生成されます。
- このファイルには、変更したいメッセージのみを定義することができます。
- 定義されていないメッセージはプラグイン内部の設定した言語ファイルから読み込まれます。
- 編集してから `/ptero reload` コマンドで再読み込みすることで、プラグインの言語を変更できます。
- Pull Requestで言語ファイルを追加していただけると嬉しいです。

Expand Down Expand Up @@ -233,3 +243,11 @@ mvn install
```
- このプラグインは、Java 11 以上でビルドする必要があります。
- ビルド後、`target` ディレクトリに `BungeePteroPower-<バージョン>.jar` ファイルが生成されます。

## 統計データについて

BungeePteroPowerは、[bStats](https://bstats.org/)を使用して匿名の統計データを収集しています。
統計データは[こちら](https://bstats.org/plugin/bungeecord/BungeePteroPower/20917)。

bStatsは、プラグインの使用状況を把握するために使用され、プラグインの改善に役立てられます。
統計データの収集を無効にするには、`plugins/bStats/config.yml`の `enabled` を `false` に設定してください。
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>com.kamesuta</groupId>
<artifactId>BungeePteroPower</artifactId>
<version>1.2-SNAPSHOT</version>
<version>1.3-SNAPSHOT</version>
<packaging>jar</packaging>

<name>BungeePteroPower</name>
Expand Down

0 comments on commit 634c5da

Please sign in to comment.