Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/presentkim-pm/consoleexporter
Exports the console to a html file
https://github.com/presentkim-pm/consoleexporter
pmmp-plugin pocketmine-mp-plugin
Last synced: 3 months ago
JSON representation
Exports the console to a html file
- Host: GitHub
- URL: https://github.com/presentkim-pm/consoleexporter
- Owner: presentkim-pm
- License: lgpl-3.0
- Created: 2022-05-17T04:18:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T03:52:17.000Z (9 months ago)
- Last Synced: 2024-09-26T10:21:38.403Z (3 months ago)
- Topics: pmmp-plugin, pocketmine-mp-plugin
- Language: PHP
- Size: 159 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
![Version][version-badge]
[![Stars][stars-badge]][stars-url]
[![License][license-badge]][license-url]
ConsoleExporter
An plugin that recording console and exports to html!
[Contact to me][author-discord] · [Report a bug][issues-url] · [Request a feature][issues-url]
## About The Project
![Project Preview][project-preview]
This plugin is useful for creating test images of console-based plugins.
It records the console and outputs it as an html file.
You can download it as a png through the controls button of the html file.
#### Commands and Permissions
| | name | description | extra |
|------------|:---------------------:|-----------------------------------------------------|:----------------------------------------------------|
| Command | `consoleexport` | -Start console recording
-Export as html file | aliases: `ce`
permission: `consoleexporter.cmd` |
| Permission | `consoleexporter.cmd` | Allows use consoleexport command | default: `op` |
##
-----
## How To Use:
1. Type `/consoleexporter`(or `/ce`) to start recoding.
2. Do anything you want to record.
3. Retype `/consoleexporter`(or `/ce`) to stop recording.
4. The result is output as an HTML file.
- It'll be export to `{plugin_data}/ConsoleExporter/console-exporter-{timestamp}.html`
### Advanced usage:
- `annotation` : Type anything starts with `#`. It will be not executing as command.
- `line-break` : If you type only `#`. It will be replace to empty line.
##
-----
## Target software:
This plugin officially only works with [`Pocketmine-MP`](https://github.com/pmmp/PocketMine-MP/).
##
-----
## Downloads
### Download from [Github Releases][releases-url]
[![Github Downloads][release-badge]][releases-url]
###
### Download from [Poggit Releases][poggit-release-url]
[![Poggit Downloads][poggit-downloads-badge]][poggit-release-url]
##
-----
## Installation
1) Download plugin `.phar` releases
2) Move downloaded `.phar` file to server's **/plugins/** folder
3) Restart the server
##
-----
## License
Distributed under the **LGPL 3.0**. See [LICENSE][license-url] for more information
##
-----
[author-discord]: https://discordapp.com/users/345772340279508993
[poggit-ci-badge]: https://poggit.pmmp.io/ci.shield/presentkim-pm/ConsoleExporter/ConsoleExporter?style=for-the-badge
[poggit-version-badge]: https://poggit.pmmp.io/shield.api/ConsoleExporter?style=for-the-badge
[poggit-downloads-badge]: https://poggit.pmmp.io/shield.dl.total/ConsoleExporter?style=for-the-badge
[version-badge]: https://img.shields.io/github/v/release/presentkim-pm/ConsoleExporter?display_name=tag&style=for-the-badge&label=VERSION
[release-badge]: https://img.shields.io/github/downloads/presentkim-pm/ConsoleExporter/total?style=for-the-badge&label=GITHUB%20
[stars-badge]: https://img.shields.io/github/stars/presentkim-pm/ConsoleExporter.svg?style=for-the-badge
[license-badge]: https://img.shields.io/github/license/presentkim-pm/ConsoleExporter.svg?style=for-the-badge
[poggit-ci-url]: https://poggit.pmmp.io/ci/presentkim-pm/ConsoleExporter/ConsoleExporter
[poggit-release-url]: https://poggit.pmmp.io/p/ConsoleExporter
[stars-url]: https://github.com/presentkim-pm/ConsoleExporter/stargazers
[releases-url]: https://github.com/presentkim-pm/ConsoleExporter/releases
[issues-url]: https://github.com/presentkim-pm/ConsoleExporter/issues
[license-url]: https://github.com/presentkim-pm/ConsoleExporter/blob/main/LICENSE
[project-icon]: https://raw.githubusercontent.com/presentkim-pm/ConsoleExporter/main/assets/icon.png
[project-preview]: https://raw.githubusercontent.com/presentkim-pm/ConsoleExporter/main/assets/preview.png