https://github.com/thebigcrafter/kygekclearconsole

A PocketMine-MP plugin to clear server console using command
https://github.com/thebigcrafter/kygekclearconsole

kygekclearconsole kygekteam kygekteam-plugin pocketmine pocketmine-mp pocketmine-mp-plugin pocketmine-plugin

Last synced: about 21 hours ago
JSON representation

A PocketMine-MP plugin to clear server console using command

• Host: GitHub
• URL: https://github.com/thebigcrafter/kygekclearconsole
• Owner: thebigcrafter
• License: gpl-3.0
• Created: 2021-08-14T11:06:16.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-07T08:01:21.000Z (over 1 year ago)
• Last Synced: 2024-09-26T10:20:33.198Z (about 21 hours ago)
• Topics: kygekclearconsole, kygekteam, kygekteam-plugin, pocketmine, pocketmine-mp, pocketmine-mp-plugin, pocketmine-plugin
• Language: PHP
• Homepage:
• Size: 53.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
KygekClearConsole










# 📖 About

A PocketMine-MP plugin to clear server console using command. This plugin is roughly equivalent to `cls` command on Windows or `clear` command on Linux.

This plugin is not planned to be released on Poggit, because it may break Rule A1 or A2 (see [Poggit Rules](https://poggit.pmmp.io/rules.edit) for more information, and remember to use common sense!).

# ❔ How Does This Plugin Works

This plugin clears the console when the `clearconsole` command (Alias: `cc`) gets executed. This plugin prints `\e[H\e[J` character to console to clear the console. This plugin ensures the command will only show and work on console by using `CommandEvent` to capture the command and cancelling the event to prevent unexpected outputs (e.g. Unknown command) if the sender is from the console.

# 🧩 Features

- Only works in console

- Command gets hidden in command suggestions and help page (Player)

- Sends unknown command message whenever a player tries to execute the command

- API to clear the console (`ClearConsole::clear()`)

# ⬇️ Installation

1. Download the latest version from GitHub Releases or Poggit CI below:

    - Stable version (Recommended for most users): [Latest](https://github.com/thebigcrafter/KygekClearConsole/releases/latest) | [All releases](https://github.com/thebigcrafter/KygekClearConsole/releases)

    - Build version (Only recommended for advanced users): [Poggit CI](https://poggit.pmmp.io/ci/thebigcrafter/KygekClearConsole/~)

2. Drop the downloaded `KygekClearConsole.phar` plugin file into your PocketMine-MP server's `plugins` directory.

3. Restart your server and you're ready to test the plugin!

# 📜 Commands

| Command | Description | Aliases |

| --- | --- | --- |

| `/clearconsole` | Clears server console | `/cc`, `/cls` and `/clr` |

# ⚖️ License

Licensed under the [GNU General Public License v3.0 license](https://github.com/thebigcrafter/KygekClearConsole/blob/main/LICENSE).