{"id":15916900,"url":"https://github.com/imharvol/mineflayer-web-inventory","last_synced_at":"2025-04-13T08:20:57.700Z","repository":{"id":41847404,"uuid":"269086818","full_name":"imharvol/mineflayer-web-inventory","owner":"imharvol","description":"Web based viewer for your mineflayer bot's inventory","archived":false,"fork":false,"pushed_at":"2024-03-22T19:11:30.000Z","size":356,"stargazers_count":76,"open_issues_count":6,"forks_count":19,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-29T19:01:45.002Z","etag":null,"topics":["minecraft","mineflayer","mineflayer-plugin","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imharvol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-06-03T12:49:39.000Z","updated_at":"2024-04-20T17:31:47.000Z","dependencies_parsed_at":"2024-01-17T14:11:22.418Z","dependency_job_id":"eebbff12-c15b-4afc-9121-2de2b59fdcec","html_url":"https://github.com/imharvol/mineflayer-web-inventory","commit_stats":{"total_commits":85,"total_committers":10,"mean_commits":8.5,"dds":"0.23529411764705888","last_synced_commit":"6eb3555cdfae36fa1d00808ec961f194ae954c36"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imharvol%2Fmineflayer-web-inventory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imharvol%2Fmineflayer-web-inventory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imharvol%2Fmineflayer-web-inventory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imharvol%2Fmineflayer-web-inventory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imharvol","download_url":"https://codeload.github.com/imharvol/mineflayer-web-inventory/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681598,"owners_count":21144715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["minecraft","mineflayer","mineflayer-plugin","nodejs"],"created_at":"2024-10-06T18:06:51.782Z","updated_at":"2025-04-13T08:20:57.672Z","avatar_url":"https://github.com/imharvol.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mineflayer Web Inventory\nA simple web-based inventory viewer for [mineflayer](https://github.com/PrismarineJS/mineflayer) with support for **multiple types of windows and updated in real-time**.\n\n## Install\n`npm install mineflayer-web-inventory`\n\n[![npm version](https://badge.fury.io/js/mineflayer-web-inventory.svg)](https://badge.fury.io/js/mineflayer-web-inventory)\n\nMinimum recommended mineflayer version: 4.2.0 \nNote that from version 1.3.0 mineflayer-web-inventory will only support mineflayer 3.X.X and 4.X.X versions\nIf 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`\n\n## Usage\n- Run `npm install mineflayer-web-inventory`.\n- Import mineflayer-web-inventory: `const inventoryViewer = require('mineflayer-web-inventory')`.\n- Call inventoryViewer with your bot instance: `inventoryViewer(bot)`.\n\n```js\nconst mineflayer = require('mineflayer')\nconst inventoryViewer = require('mineflayer-web-inventory')\n\nconst bot = mineflayer.createBot({\n  host: 'localhost',\n  port: 25565,\n  username: 'bot',\n  version: '1.18.2' // Its important to set this to the server's minecraft version. Otherwise it might not load data/textures correctly\n})\n\ninventoryViewer(bot)\n```\n\nThis will start a web server in http://localhost:3000/.\nYou can change the options using:\n```js\n  let options = {\n    port: PORT,\n    webPath: PATH,\n    express: EXPRESS,\n    app: APP,\n    http: HTTP,\n    io: IO,\n    startOnLoad: BOOLEAN,\n    windowUpdateDebounceTime: INT\n  }\n\n  inventoryViewer(bot, options)\n```\nYou can access the options in bot.webInventory.options\n\n#### bot.webInventory.start()\nStarts the web server. This function is called when the plugin is first loaded unless `options.startOnLoad` is `false`. Returns a `Promise` that resolves once the HTTP server is open.\n\n#### bot.webInventory.stop()\nStops the web server. Returns a `Promise` that resolves once the HTTP server is closed.\n\nYou can also check the current status of the web server using `bot.webInventory.isRunning` which returns a boolean\n\n## Screenshots\n![Example Screenshot 1](https://user-images.githubusercontent.com/17525823/128013976-493448e3-aa22-43bc-8fb9-428f1ccf9b5f.png)\n![Example Screenshot 2](https://user-images.githubusercontent.com/17525823/128013983-31f50c2f-e453-401b-a697-d21682e0c980.png)\n\nhttps://user-images.githubusercontent.com/17525823/128014178-6ea85f97-6698-43dc-9b1f-81a1802885d4.mp4\n\n### Images\nThe images used in this project are from https://wiki.vg/Inventory and https://github.com/PrismarineJS/minecraft-assets","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimharvol%2Fmineflayer-web-inventory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimharvol%2Fmineflayer-web-inventory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimharvol%2Fmineflayer-web-inventory/lists"}