Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nick22985/mclogcleanup

This npm cli gets rid of all errors, chat colors/hex colors and makes a readble log minecraft log file
https://github.com/nick22985/mclogcleanup

cleanup log log-file minecraft

Last synced: 13 days ago
JSON representation

This npm cli gets rid of all errors, chat colors/hex colors and makes a readble log minecraft log file

Awesome Lists containing this project

README

        

@nick22985/mclogcleanup

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/nick22985/mclogcleanup.svg)](https://github.com/nick22985/mclogcleanup/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/nick22985/mclogcleanup.svg)](https://github.com/nick22985/mclogcleanup/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
[![wakatime](https://wakatime.com/badge/github/nick22985/mcLogCleanUp.svg)](https://wakatime.com/badge/github/nick22985/mcLogCleanUp)

---

CLI to clean up log files from minecraft java server.


## 📝 Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Contributing](../CONTRIBUTING.md)

## 🧐 About

This CLI takes minecraft log files and cleans them up. It removes all the error and leaves pure chat. It also get rid of all the annoying colour codes and hex codes in the text so it is readable to a human

## 🏁 Getting Started

npm package https://www.npmjs.com/package/@nick22985/mclogcleanup

### Prerequisites

What things you need to install the software and how to install them.

```
nodeJs (https://nodejs.org/en/)
```

### Installing

A step by step series of examples that tell you how to get a development env running.

You can install the cli by doing npm i -g @nick22985/mclogcleanup. Then it will be accesable by doing mcmclogcleanup -p {logFile path}

```
mcmclogcleanup -p ./log.log
```

This will create a file in the same directory as the log file called name_cleanup.log.

```
mcmclogcleanup -p ./log.log

Will create a file called

./log_cleaned.log
```

### Command Alliases
mclog
mcCleanup

## 🎈 Usage

```
mcmclogcleanup -p {logFile path}
```

## ⛏️ Built Using

- [NodeJs](https://nodejs.org/en/) - Server Environment

## ✍️ Authors

- [@nick22985](https://github.com/nick22985) - Idea & Initial work