Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v3.1 #7

Merged
merged 6 commits into from
Mar 1, 2025
Merged

v3.1 #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0dca226
Merge pull request #6 from jgniecki/3.0
jgniecki Jul 1, 2024
13e30ff
Added docker-compose.yml
jgniecki Mar 1, 2025
50b2ed5
Added Dockerfile
jgniecki Mar 1, 2025
57f23d5
Renaming classes and tidying up abstract classes
jgniecki Mar 1, 2025
82384cd
Update
jgniecki Mar 1, 2025
be5ec5c
Added MinecraftJavaQueryInterface.php
jgniecki Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
FROM php:7.4-apache

# Install necessary extensions and tools
RUN apt-get update && apt-get install -y \
zip unzip git curl libpq-dev libonig-dev \
&& docker-php-ext-install mbstring

# Install Composer
COPY --from=composer:latest /usr/bin/composer /usr/bin/composer

# Set working directory
WORKDIR /var/www/html

EXPOSE 80
84 changes: 44 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Minecraft Status
![](https://img.shields.io/packagist/l/dev-lancer/minecraft-status?style=for-the-badge)
![](https://img.shields.io/packagist/dt/dev-lancer/minecraft-status?style=for-the-badge)
![](https://img.shields.io/github/v/release/DeveloperLancer/MinecraftStatus?style=for-the-badge)
![](https://img.shields.io/packagist/php-v/dev-lancer/minecraft-status?style=for-the-badge)

Expand All @@ -11,26 +12,29 @@ This library can be installed by issuing the following command:
composer require dev-lancer/minecraft-status
```

## Differences between Ping and Query
## Differences between MinecraftJavaStatus and MinecraftJavaQuery

### Ping
Ping uses the TCP protocol to communicate with the Minecraft server in the java edition and bedrock edition, it uses the port on which the server is running.
### MinecraftJavaStatus
MinecraftJavaStatus uses the TCP protocol to communicate with the Minecraft server in the java edition and bedrock edition, it uses the port on which the server is running.
Ping provides the most necessary information (hostname, motd, favicon, and a sample of players).
Thanks to its simplicity, it does not require any configuration on the server side, communication works with servers from version 1.7 and above.

To communicate with a server which has a version lower than 1.7, use the `PingPreOld17` class
To communicate with a server which has a version lower than 1.7, use the `MinecraftJavaPreOld17Status` class

### Query
Query uses GameSpy 4 protocol for communication,
For bedrock edition servers use class `MinecraftBedrockStatus`


### MinecraftJavaQuery
MinecraftJavaQuery uses GameSpy 4 protocol for communication,
so you should start listening in the server properties.
Query allows you to request more information about the server,
but has more security vulnerabilities.

## Usage

### Query
### Minecraft Java Edition server with Query

Example: [Query](examples/query.php)
Example: [MinecraftJavaQuery](examples/query.php)

This method uses GameSpy4 protocol, and requires enabling `query` listener in your `server.properties` like this:

Expand All @@ -39,7 +43,7 @@ This method uses GameSpy4 protocol, and requires enabling `query` listener in yo

```php
<?php
use \DevLancer\MinecraftStatus\Query;
use \DevLancer\MinecraftStatus\MinecraftJavaQuery;

require_once ("vendor/autoload.php");

Expand All @@ -48,14 +52,14 @@ $port = 25565; //from query.port
$timeout = 3;
$resolveSVR = true;

$query = new Query($host, $port, $timeout, $resolveSVR);
$query = new MinecraftJavaQuery($host, $port, $timeout, $resolveSVR);
$query->connect();
print_r($query->getInfo());
```

### QueryBedrock
### Minecraft Bedrock Edition server status

Example: [Bedrock](examples/bedrock.php)
Example: [MinecraftBedrockStatus](examples/bedrock.php)

Use this class for bedrock edition servers

Expand All @@ -64,7 +68,7 @@ the port on which the server runs is used to communicate with the server

```php
<?php
use \DevLancer\MinecraftStatus\QueryBedrock;
use \DevLancer\MinecraftStatus\MinecraftBedrockStatus;

require_once ("vendor/autoload.php");

Expand All @@ -73,19 +77,19 @@ $port = 19132;
$timeout = 3;
$resolveSVR = true;

$query = new QueryBedrock($host, $port, $timeout, $resolveSVR);
$query = new MinecraftBedrockStatus($host, $port, $timeout, $resolveSVR);
$query->connect();
print_r($query->getInfo());
```

### Ping and PingPreOld17
### Minecraft Java Edition server status

Example: [Ping](examples/ping.php)
Example: [MinecraftJavaStatus](examples/ping.php)

```php
<?php
use \DevLancer\MinecraftStatus\Ping;
use \DevLancer\MinecraftStatus\PingPreOld17;
use \DevLancer\MinecraftStatus\MinecraftJavaStatus;
use \DevLancer\MinecraftStatus\MinecraftJavaPreOld17Status;

require_once ("vendor/autoload.php");

Expand All @@ -94,8 +98,8 @@ $port = 25565;
$timeout = 3;
$resolveSVR = true;

$ping = new Ping($host, $port, $timeout, $resolveSVR);
//$ping = new PingPreOld17($host, $port, $timeout, $resolveSVR); //use when version is older than Minecraft 1.7
$ping = new MinecraftJavaStatus($host, $port, $timeout, $resolveSVR);
//$ping = new MinecraftJavaPreOld17Status($host, $port, $timeout, $resolveSVR); //use when version is older than Minecraft 1.7
$ping->connect();
print_r($ping->getInfo());
```
Expand All @@ -105,26 +109,26 @@ If you want to get `ping` info from a server that uses a version older than Mine
## Methods

### List of methods
| | Query | QueryBedrock | Ping | PingPreOld17 |
|-------------------|-------|--------------|------|--------------|
| connect() | X | X | X | X |
| isConnected() | X | X | X | X |
| disconnect() | X | X | X | X |
| getPlayers() | X | | X | |
| getCountPlayers() | X | X | X | X |
| getMaxPlayers() | X | X | X | X |
| getInfo() | X | X | X | X |
| getFavicon() | | | X | |
| getDelay() | | | X | |
| setTimeout() | X | X | X | X |
| getTimeout() | X | X | X | X |
| setEncoding() | X | X | X | X |
| getEncoding() | X | X | X | X |
| isResolveSRV() | X | X | X | X |
| getHost() | X | X | X | X |
| getPort() | X | X | X | X |
| getMotd() | X | X | X | X |
| getProtocol() | | X | X | X |
| | MinecraftJavaQuery | MinecraftBedrockStatus | MinecraftJavaStatus | MinecraftJavaPreOld17Status |
|-------------------|--------------------|------------------------|---------------------|-----------------------------|
| connect() | X | X | X | X |
| isConnected() | X | X | X | X |
| disconnect() | X | X | X | X |
| getPlayers() | X | | X | |
| getCountPlayers() | X | X | X | X |
| getMaxPlayers() | X | X | X | X |
| getInfo() | X | X | X | X |
| getFavicon() | | | X | |
| getDelay() | | | X | |
| setTimeout() | X | X | X | X |
| getTimeout() | X | X | X | X |
| setEncoding() | X | X | X | X |
| getEncoding() | X | X | X | X |
| isResolveSRV() | X | X | X | X |
| getHost() | X | X | X | X |
| getPort() | X | X | X | X |
| getMotd() | X | X | X | X |
| getProtocol() | | X | X | X |

### Use before connecting

Expand Down
8 changes: 7 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@
"autoload": {
"psr-4": {
"DevLancer\\MinecraftStatus\\": "src/"
}
},
"classmap": [
"src/MinecraftBedrockStatus.php",
"src/MinecraftJavaPreOld17Status.php",
"src/MinecraftJavaQuery.php",
"src/MinecraftJavaStatus.php"
]
},
"require-dev": {
"phpstan/phpstan": "^1.10",
Expand Down
Loading
Loading