Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jgniecki/minecraftmotdparser
š PHP library to parse minecraft server motd
https://github.com/jgniecki/minecraftmotdparser
generator mineceraft motd parser php
Last synced: 7 days ago
JSON representation
š PHP library to parse minecraft server motd
- Host: GitHub
- URL: https://github.com/jgniecki/minecraftmotdparser
- Owner: jgniecki
- License: mit
- Created: 2024-02-01T08:44:07.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-13T21:56:01.000Z (about 1 month ago)
- Last Synced: 2024-10-13T23:07:24.354Z (about 1 month ago)
- Topics: generator, mineceraft, motd, parser, php
- Language: PHP
- Homepage: https://packagist.org/packages/dev-lancer/minecraft-motd-parser
- Size: 90.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minecraft MOTD Parser
PHP library to parse minecraft server motd
## Installation
This library can be installed by issuing the following command:
```bash
composer require dev-lancer/minecraft-motd-parser
```
## Documentation
| Lang |
|:----------------------|
| [EN](docs/en/home.md) |
| [PL](docs/pl/home.md) |
## Parsing
### Usage TextParser
To parse a text-based MOTD using custom formatting and colors:
```php
$formatCollection = \DevLancer\MinecraftMotdParser\Collection\FormatCollection::generate();
$colorCollection = \DevLancer\MinecraftMotdParser\Collection\ColorCollection::generate(true); //When set to true, colors from BE are added
$parser = new \DevLancer\MinecraftMotdParser\Parser\TextParser($formatCollection, $colorCollection, '&');
$motd = "A &l&fMine&4craft &rServer";
$motdItemCollection = $parser->parse($motd, new \DevLancer\MinecraftMotdParser\Collection\MotdItemCollection());
```
### Usage ArrayParser
To parse a structured array-based MOTD:
```php
$formatCollection = \DevLancer\MinecraftMotdParser\Collection\FormatCollection::generate();
$colorCollection = \DevLancer\MinecraftMotdParser\Collection\ColorCollection::generate();
$parser = new \DevLancer\MinecraftMotdParser\Parser\ArrayParser($formatCollection, $colorCollection);
$motd = [
[ "text" => "A "],
[
"bold" => true,
"extra" => [
[
"color" => "white",
"text" => "Mine"
],
[
"color" => "dark_red",
"text" => "craft "
],
]
],
[
"text" => "Server"
]
];
$motdItemCollection = $parser->parse($motd, new \DevLancer\MinecraftMotdParser\Collection\MotdItemCollection());
```
### Merging Similar Items
The mergeSimilarItem() method in the MotdItemCollection class merges adjacent MotdItem objects with the same formatting and color. This optimization helps to reduce redundancy in the formatting and color codes, making the MOTD more concise.
```php
$motd = "A &l&fMine&f&lcraft &rServer";
$motdItemCollection = $parser->parse($motd, new \DevLancer\MinecraftMotdParser\Collection\MotdItemCollection());
//Output before
[
['text': "A "],
['bold': true, 'color': "white", 'text': "Mine"],
['bold': true, 'color': "white", 'text': "craft "],
['reset': true, 'text': "Server"],
]
$motdItemCollection->mergeSimilarItem();
//Output after
[
['text': "A "],
['bold': true, 'color': "white", 'text': "Minecraft "],
['reset': true, 'text': "Server"],
]
```
## Generation
### MotdItemCollection
Example of creating a MotdItemCollection:
```php
$parser = new \DevLancer\MinecraftMotdParser\Parser\TextParser();
$motd = "A Ā§lĀ§fMineĀ§4craft Ā§rServer";
$motdItemCollection = $parser->parse($motd, new \DevLancer\MinecraftMotdParser\Collection\MotdItemCollection());
```
### Usage HtmlGenerator
To generate HTML from a parsed MOTD:
```php
$generator = new \DevLancer\MinecraftMotdParser\Generator\HtmlGenerator();
// Generate HTML from the MOTD item collection
echo $generator->generate($motdItemCollection);
```
#### Output
The output will be:
```html
A Mine
craft Server
```
### Usage RawGenerator
To generate raw text from a parsed MOTD:
```php
$generator = new \DevLancer\MinecraftMotdParser\Generator\RawGenerator("Ā§");
// Generate raw text from the MOTD item collection
echo $generator->generate($motdItemCollection);
//output: A Ā§fĀ§lMineĀ§4craft Ā§rServer
```
### Usage TextGenerator
To generate plain text from a parsed MOTD:
```php
$generator = new \DevLancer\MinecraftMotdParser\Generator\TextGenerator();
// Generate plain text from the MOTD item collection
echo $generator->generate($motdItemCollection);
//output: A Minecraft Server
```
## Custom formatter
### Define new class formatter
Example of creating a custom bold formatter:
```php
class CustomBoldFormatter implements FormatterInterface
{
public function getKey(): string
{
return 'l';
}
public function getName(): string
{
return 'bold';
}
public function getFormat(): string
{
return '%s';
}
}
```
### Usage
To use the custom formatter:
```php
// Create a new format collection
$formatCollection = \DevLancer\MinecraftMotdParser\Collection\FormatCollection::generate();
// and override the default formatter for bold
$formatCollection->add(new CustomBoldFormatter());
// Create a new MOTD item
$motdItem = new \DevLancer\MinecraftMotdParser\MotdItem();
$motdItem->setBold(true);
$motdItem->setText("Hello World");
// Create a new MOTD item collection and add the MOTD item
$motdItemCollection = new \DevLancer\MinecraftMotdParser\Collection\MotdItemCollection();
$motdItemCollection->add($motdItem);
// Generate HTML using the custom formatter
$generator = new \DevLancer\MinecraftMotdParser\Generator\HtmlGenerator($formatCollection);
echo $generator->generate($motdItemCollection);
```
### Output
The output will be:
```html
Hello World
```
## License
This library is licensed under the [MIT](LICENSE) License.