Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PrismarineJS/prismarine-viewer
Web based viewer for servers and bots
https://github.com/PrismarineJS/prismarine-viewer
Last synced: 9 days ago
JSON representation
Web based viewer for servers and bots
- Host: GitHub
- URL: https://github.com/PrismarineJS/prismarine-viewer
- Owner: PrismarineJS
- License: mit
- Created: 2020-06-10T21:05:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-17T16:34:19.000Z (8 months ago)
- Last Synced: 2024-05-27T12:07:02.734Z (6 months ago)
- Language: JavaScript
- Homepage: https://prismarinejs.github.io/prismarine-viewer/
- Size: 298 MB
- Stars: 243
- Watchers: 6
- Forks: 68
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# prismarine-viewer
Web based viewer for servers and bots
[](http://npmjs.com/package/prismarine-viewer)
[](https://github.com/PrismarineJS/prismarine-viewer/actions?query=workflow%3A%22CI%22)
[](https://discord.gg/GsEFRM8)
[](https://gitter.im/PrismarineJS/general)
[](https://irc.gitter.im/)
[](https://issuehunt.io/r/PrismarineJS/prismarine-viewer)
[](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-viewer)
[
](https://prismarinejs.github.io/prismarine-viewer/)
Supports versions 1.8.8, 1.9.4, 1.10.2, 1.11.2, 1.12.2, 1.13.2, 1.14.4, 1.15.2, 1.16.1, 1.16.4, 1.17.1, 1.18.1, 1.19, 1.20.1.
## Install
```bash
npm install prismarine-viewer
```
## Example
```js
const mineflayer = require('mineflayer')
const mineflayerViewer = require('prismarine-viewer').mineflayer
const bot = mineflayer.createBot({
username: 'Bot'
})
bot.once('spawn', () => {
mineflayerViewer(bot, { port: 3000 }) // Start the viewing server on port 3000
// Draw the path followed by the bot
const path = [bot.entity.position.clone()]
bot.on('move', () => {
if (path[path.length - 1].distanceTo(bot.entity.position) > 1) {
path.push(bot.entity.position.clone())
bot.viewer.drawLine('path', path)
}
})
})
```
More examples:
* First person bot [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/firstperson_bot.js)
* Record view as video file [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/headless.js)
* Streaming video to a python script [example](https://github.com/PrismarineJS/prismarine-viewer/tree/master/examples/python)
* Visualize a world, without a bot [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/standalone.js)
* Visualize the world coming from a proxy [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/proxy.js)
* Click to move [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/clickmove.js)
* Use the core api for viewing worlds [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/core)
* Create an electron app with viewer [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/electron)
* Create a fully front end viewer with an in memory world [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/standalone)
* A minecraft web client example, using mineflayer and a websocket proxy [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/web_client)
* Export parts of worlds as screenshot or 3d models [example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/exporter)
## Projects using prismarine-viewer
* [prismarine-web-client](https://gitlab.com/PrismarineJS/prismarine-web-client) A minecraft client in your browser
## API
### prismarine-viewer
#### viewer
The core rendering library. It provides Viewer and WorldView which together make it possible to render a minecraft world.
Check its [API](viewer/README.md)
#### mineflayer
Serve a webserver allowing to visualize the bot surrounding, in first or third person. Comes with drawing functionnalities.
```js
const { mineflayer } = require('prismarine-viewer')
```
Options:
* `viewDistance` view radius, in chunks, default: `6`
* `firstPerson` is the view first person ? default: `false`
* `port` the port for the webserver, default: `3000`
[example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/bot.js)
#### standalone
Serve a webserver allowing to visualize a world.
```js
const { standalone } = require('prismarine-viewer')
```
Options:
* `version` the version to use, default: `1.13.2`
* `generator` a world generator function, default: `(x, y, z) => 0`
* `center` a vec3 to center the view on, default: `new Vec3(0, 0, 0)`
* `viewDistance` view radius, in chunks, default: `6`
* `port` the port for the webserver, default: `3000`
[example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/standalone.js)
#### headless
Render the bot view and stream it to a file or over TCP.
```js
const { headless } = require('prismarine-viewer')
```
Options:
* `viewDistance` view radius, in chunks, default: `6`
* `output` the output file or a `host:port` address to stream to, default: `output.mp4`
* `frames` number of frames to record, `-1` for infinite, default: `200`
* `width` the width of a frame, default: `512`
* `height` the height of a frame, default: `512`
[example](https://github.com/PrismarineJS/prismarine-viewer/blob/master/examples/headless.js)
### Drawing (mineflayer mode)
All drawing function have a unique id that can be used to replace or erase the primitive.
#### bot.viewer.drawLine (id, points, color=0xff0000)
Draw a line passing through all the `points`.
#### bot.viewer.erase (id)
Remove the primitive with the given id from the display.
#### bot.viewer.close ()
Stop the server and disconnect users.
## Tests
`npm run jestTest -- -t "1.9.4"`