chipmunkmc/prismarine-web-client-mirror
1
0
Fork 1
mirror of https://github.com/PrismarineJS/prismarine-web-client.git synced 2024-11-24 16:47:52 -05:00
Code Issues Projects Releases Packages Wiki Activity
Minecraft web client running in your browser
128 commits 9 branches 7 tags 96 MiB
JavaScript 96.6%
CSS 1.8%
HTML 1.4%
Dockerfile 0.2%
Find a file
Romain Beaumont c40b00ab5c add service worker for PWA
2021-03-21 01:54:10 +00:00
.github/workflows fix sed replacement 2021-03-14 17:31:05 +01:00
assets add more metadata 2021-03-21 01:31:45 +00:00
extra-textures Cleanup textures in root 2021-03-04 04:02:30 +01:00
lib Add blured title panorama 2021-03-20 16:12:20 +01:00
test add code 2021-02-27 22:12:11 +00:00
.gitignore add .idea to gitignore (#39) 2021-03-02 14:47:40 +01:00
.gitpod remove custom gitpod as the default one is good enough and faster 2021-03-14 22:58:20 +01:00
.npmignore fix package.json 2021-02-27 22:28:08 +00:00
.npmrc Initial commit 2021-02-27 22:27:59 +01:00
config.json Make a nicer menu (#82) 2021-03-14 17:02:35 +01:00
HISTORY.md Release 1.2.0 2021-03-06 00:34:52 +00:00
index.html add service worker for PWA 2021-03-21 01:54:10 +00:00
index.js add service worker for PWA 2021-03-21 01:54:10 +00:00
LICENSE Initial commit 2021-02-27 22:27:59 +01:00
package.json add service worker for PWA 2021-03-21 01:54:10 +00:00
README.md use litelement properly for debugmenu (#110) 2021-03-17 00:00:26 +01:00
screenshot.png Update screenshot.png (#44) 2021-03-07 22:51:08 +01:00
server.js Optimize webpack usage, fix #34 (#58) 2021-03-06 01:29:28 +01:00
styles.css prevent scrolling on mobile 2021-03-21 00:57:54 +00:00
webpack.common.js add service worker for PWA 2021-03-21 01:54:10 +00:00
webpack.dev.js watch node_modules, bump mineflayer and pviewer 2021-03-13 20:44:00 +00:00
webpack.prod.js Optimize webpack usage, fix #34 (#58) 2021-03-06 01:29:28 +01:00

README.md

prismarine-web-client

NPM version Build Status Discord Try it on gitpod

A Minecraft client running in a web page. Live demo at https://webclient.prismarine.js.org/

How it Works

prismarine-web-client runs mineflayer and prismarine-viewer in the browser, which connects over WebSocket to a proxy which translates the WebSocket connection into TCP to connect to normal Minecraft servers.

Screenshot

Screenshot of prismarine-web-client in action

Live Demo

Click on this link to open it in your browser, no installation necessary: https://webclient.prismarine.js.org/

Tested on Chrome & Firefox for desktop platforms.

Usage

To host it yourself, run these commands in bash:

$ npm install -g prismarine-web-client
$ prismarine-web-client

Finally, open http://localhost:8080 in your browser.

Features

  • Display mobs and players
  • Display blocks
  • Movement (you can move, and you see entities moving live)
  • Place and break blocks

Roadmap

  • Containers (inventory, chests, etc.)
  • Sounds
  • More World Interactions (attacking entities, etc.)
  • Cosmetic Rendering Features (day night cycle, fog, etc.)

Development

If you're contributing/making changes, you need to install it differently.

First, clone the repo.

Then, set your working directory to that of the repo. For example:

$ cd ~/prismarine-viewer/

Finally, run

$ npm install
$ npm start

This will start express and webpack in development mode: whenever you save a file, the build will be redone (it takes 5s), and you can refresh the page to get the new result.

Connect to http://localhost:8080 in your browser.

You may want to disable auto saving in your IDE to avoid constant rebuilding, see https://webpack.js.org/guides/development/#adjusting-your-text-editor

To check the production build (take a minute to build), you can run npm run build-start

If you're interested in contributing, you can check projects at https://github.com/PrismarineJS/prismarine-web-client/projects

Some variables are exposed in window for debugging:

  • bot
  • viewer
  • mcData
  • worldView
  • Vec3
  • pathfinder
  • debugMenu

How to add more stuff to the debugMenu ?

debugMenu.customEntries['myKey'] = 'myValue' delete debugMenu.customEntries['myKey']

Some debugging examples

In chrome dev tools

  • bot.chat('test') allows you to use the chat
  • bot.chat(JSON.stringify(Object.values(bot.players).map(({username, ping}) => ({username, ping})) display the ping of everyone
  • window.bot.entity.position.y += 5 jumps
  • bot.chat(JSON.stringify(bot.findBlock({matching:(block) => block.name==='diamond_ore', maxDistance:256}).position)) finds the position of a diamond block
  • bot.physics.stepHeight = 2 allows you to walk about blocks
  • bot.physics.sprintSpeed = 5 walks faster
  • bot.loadPlugin(pathfinder.pathfinder) then bot.pathfinder.goto(new pathfinder.goals.GoalXZ(100, 100)) goes to position 100, 100

For more debugging ideas, read mineflayer doc