voxel-clientmc

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #machine-learning #deep-learning #linux #docker #nodejs #java #windows #awesome-list #mcp #openai

(★ 59)

Minecraft client using WebSockets and voxel-engine (voxel.js plugin)

파일 탐색기

최종 버전 다운로드 (.zip)

- app.js
- bundled-index.html
- package.json
- README.md
- wsmc
.gitignore
.gitmodules
block_break_animation.js
chat.js
chunks.js
circle.yml
clientmc.js
dig.js
inventory.js
kick.js
mcdata.js
mf-worker.js
package.json
position.js
README.md
resource_pack.js
sound.js
use.js
zlib_worker.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# voxel-clientmc

[![Build Status](https://circleci.com/gh/voxel/voxel-clientmc/tree/master.png)](https://circleci.com/gh/voxel/voxel-clientmc/tree/master)

Web-based Minecraft-compatible client using voxel.js, connects to Minecraft servers using WebSockets

![screenshot](http://i.imgur.com/dzs5BFM.png "Screenshot")

## Downloads

Prebuilt integrated builds are available to download from:

* [![Build Status](https://circleci.com/gh/voxel/voxel-clientmc.svg?style=svg)](https://circleci.com/gh/voxel/voxel-clientmc/tree/master) **[CircleCI](https://circleci.com/gh/voxel/voxel-clientmc/tree/master)** - click the latest build then expand "Artifacts" (requires logging in with GitHub)

### Quick start

1. Download the .jar file and place it in the `plugins` or `mods` folder of your Bukkit or Sponge server

2. Login to your server using the official Minecraft client

3. Click the "Web client enabled (click to view)" link you receive upon login, and open it in your web browser

You should now be disconnected in the vanilla client, and logged in from the voxel-clientmc web-based client.
Once you're logged in, the link you've received in step 3 can be reused to re-login via the web browser
as long as the server is up. You can also use the `/web` command from the console or as a user to retrieve this URL.

For advanced proxy configuration and more details, see the [wsmc documentation](https://github.com/deathcap/wsmc).

---

Screenshot of step 2, when you first login:

![screenshot](http://i.imgur.com/VDNRn9p.png "Screenshot")

Clicking the per-user link will allow you to open the web client:

![screenshot](http://i.imgur.com/iS0raim.png "Screenshot")

And then you'll be logged out and logged in via the web-based client:

![screenshot](http://i.imgur.com/QkghGE7.png "Screenshot")

## Status

Very incomplete, many bugs and missing features. The client is able to observe and interact
with the world in a primitive manner, but full survival gameplay is not yet possible.

For details on the current protocol implementation status, see: https://github.com/voxel/voxel-clientmc/issues/23

## Architecture Overview

The integrated build includes several separate components, pre-packaged together for convenience:

### wsmc

In order to allow connecting from a web browser, the Minecraft server is exposed through a WebSocket
via the wsmc (WebSocket/Mincraft) proxy. Integrated builds include the Java version of
wsmc, but a Node.js version is also available. wsmc/Java can be ran as a Bukkit plugin, or standalone.

WSMC is developed in a separate repository, [https://github.com/deathcap/wsmc](https://github.com/deathcap/wsmc).

### voxel-clientmc plugin

The bulk of this project is composed of a voxel.js plugin,
"voxel-clientmc", maintained in this repository. This [plugin](https://github.com/voxel/voxel-plugins) connects to a wsmc proxy using a WebSocket,
via the [mineflayer](https://github.com/PrismarineJS/mineflayer) abstraction layer, and ties it into
[voxel.js](https://github.com/voxel) for GUI interaction. voxel-clientmc is built from a handful of
small modules, injected at runtime. You can build your own voxel.js app with this plugin.

### voxel-clientmc app

The application in `app/` combines the voxel-clientmc plugin with the
[voxel-engine-stackgl](https://github.com/voxel/voxel-engine-stackgl) engine
and numerous other voxel.js plugins to provide various functionality in the voxel.js environment.
This app is [browserified](http://browserify.org) and made available through wsmc/Java's HTTP server.

## License

MIT

voxel-clientmc

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

voxel-clientmc

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README