mwi

mineflayer-web-inventory

Web based viewer for your mineflayer bot's inventory

Showing:

Popularity

Downloads/wk

86

GitHub Stars

27

Maintenance

Last Commit

2mos ago

Contributors

7

Package

Dependencies

7

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Mineflayer Web Inventory

A simple web-based inventory viewer for mineflayer with support for multiple types of windows and updated in real-time.

Install

npm install mineflayer-web-inventory

npm version

Note that from version 1.3.0 mineflayer-web-inventory will only support mineflayer 3.X.X versions If you still wish to use mineflayer-web-inventory with mineflayer 2.X.X you can install mineflayer-web-inventory@1.2.1: npm i mineflayer-web-inventory@1.2.1

Usage

  • Run npm install mineflayer-web-inventory.
  • Import mineflayer-web-inventory: const inventoryViewer = require('mineflayer-web-inventory').
  • Call inventoryViewer with your bot instance: inventoryViewer(bot).
const mineflayer = require('mineflayer')
const inventoryViewer = require('mineflayer-web-inventory')

const bot = mineflayer.createBot({
  host: 'localhost',
  port: 25565,
  username: 'bot'
})

inventoryViewer(bot)

This will start a web server in http://localhost:3000/. You can change the options using:

  let options = {
    port: PORT,
    path: PATH,
    express: EXPRESS,
    app: APP,
    http: HTTP,
    io: IO,
    startOnLoad: BOOLEAN,
    debounceTime: INT
  }

  inventoryViewer(bot, options)

You can access the options in bot.webInventory.options

bot.webInventory.start([cb])

Starts the web server. This function is called when the plugin is first loaded unless options.startOnLoad is false

bot.webInventory.stop([cb])

Stops the web server. You can check the current status of the web server using bot.webInventory.isRunning which returns a boolean

Screenshots

Example Screenshot 1 Example Screenshot 2

https://user-images.githubusercontent.com/17525823/128014178-6ea85f97-6698-43dc-9b1f-81a1802885d4.mp4

Images

The images used in this project are from https://wiki.vg/Inventory and https://github.com/PrismarineJS/minecraft-assets

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
StasUkraine, Kharkiv59 Ratings0 Reviews
Ne loh
1 year ago

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial