https://github.com/falkirks/mcpe-banners

Simple MCPE banner service written in Node.js
https://github.com/falkirks/mcpe-banners

Last synced: about 21 hours ago
JSON representation

Simple MCPE banner service written in Node.js

• Host: GitHub
• URL: https://github.com/falkirks/mcpe-banners
• Owner: falkirks
• Created: 2015-09-10T02:14:43.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-02T03:52:16.000Z (over 6 years ago)
• Last Synced: 2024-09-25T12:21:08.969Z (2 days ago)
• Language: JavaScript
• Homepage:
• Size: 504 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#  [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

> This is a cute little Node.js library for generating MCPE server banners. It is part of a new lean backend for http://banner.mcpe.me.

## Install

### CLI

```sh

$ npm i -g mcpe-banners

```

### API

```sh

$ npm install --save mcpe-banners

```

## Usage

### CLI

```sh

$ mcpe-banners --address=sg.lbsg.net --port=19132 > /path/to/my/banner.png

```

### API

```js

var mcpebanners = require('mcpe-banners');

mcpebanners('sg.lbsg.net', 19132, function(err, stream) {

    var writeStream = fs.createWriteStream('/path/to/my/banner.png');

    stream.pipe(writeStream);

});

```

## License

Not yet licensed.

[npm-image]: https://badge.fury.io/js/mcpe-banners.svg

[npm-url]: https://npmjs.org/package/mcpe-banners

[travis-image]: https://travis-ci.org/Falkirks/mcpe-banners.svg?branch=master

[travis-url]: https://travis-ci.org/Falkirks/mcpe-banners

[daviddm-image]: https://david-dm.org/Falkirks/mcpe-banners.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/Falkirks/mcpe-banners