GLM - Minecraft WebGL Map

This is a discussion topic for the Ore project, GLM. View the full project on Ore for downloads and more information.


WebGL Map

GLM-Sponge wiki | glm-client wiki | Imgur album

WebGL Map (GLM) is a Minecraft server plugin which allows you to view minecraft server worlds from a web browser. GLM is broken up into two applications, the server side plugin (this) and the client side project, located here. The server endpoint (this plugin) distributes JSON information to clients which requested the information via a WebSocket protocol connection. This plugin disseminates information including but not limited to server information, this plugins settings, player information, and world data / chunk information.

External Connections / Metrics

  • This plugin features a web server, which uses a WebSocket connection to allow ‘clients’ to retrieve information.
  • Gather and stores world chunk information for later retrieval.

Features

  • View multiple worlds.
  • View multiple server from one client connection.
  • Respect each world’s world border.
  • Config options for the client.
  • Client texture pack customization.
  • SSL capable.

Commands and permissions

Command Description Permission
/glm url Gets the url of the GLM map glm.commands.url
/glm create Creates chunks and attempts to add them to the cache. Please note that this command could crash the server if you attempt to create too many chunks. glm.commands.create
/glm purge Purges chunks from the cache glm.commands.purge
/glm toggle Toggles a players visibility on the web map. Gives the permission glm.map.hide glm.commands.toggle
/glm debug Gets debug information for the GLM plugin glm.commands.debug
/glm version Get the current version of the GLM plugin glm.commands.version

Quick Installation / Setup

Note: If you need help with any of the steps below please hop onto the GLM discord and ask for help!
Note: An advanced configuration and installation guide will be provided on the individual project wikis here and here.

Installing the server side plugin

  • Drag and drop this plugin into the mods directory.
  • Initialize the plugin configuration file by starting then stopping the server.
  • Finish up by configuring the plugin to your needs.
    • The configuration file comments are still be a bit lacking at this point. Please ask for help if you do not know what a specific section does.

Installing / Setting up the client side web project

Download pre-built

  • Navigate to the glm-client project releases here and download the pre-compiled files.
  • Add the files to a web server like apache, IIS, or NGIX.

Build form source

Note: In order to build the project glm-client you will need to have git and Node.js installed. The applications might also need to be on the system path.

  • Clone the glm-client project here and run the build.bat or build.sh file.
  • Copy the resulting files from the release folder to a web server like apache, IIS, or NGIX.

Planned features

  • Add top down 3D support.
  • Add texture support for blocks.
  • Add the ability to see players on the map.

Known issues

  • When using the generateWorld config option, it can lead to phase tracker errors in the console.
8 Likes

Screenshots?

I added a Imgur album link to the top of this post; however, I will also link it here.

I should note that the client has ‘texturepack’ capability and I am in the process of expanding on it so the map looks more visually appealing.

2 Likes

I am making a status update at this point since I have been " gone ", for a while. The project is not dead, I have just been busy / burnt out due to the monumental complications and requirements to get REAL 3D working with the map; however, I am working on it. The primary complication, is parsing minecraft block-state JSON files and converting them into usable OpenGL rendering objects. In order to verify the OpenGL rendering objects were constructed correctly, I have chosen to create a separate application to preform these functions. In the mean time, here are a few images of what I have so far with the new application and some UI updates to the map.

https://i.imgur.com/Ftjto1U.png
https://i.imgur.com/telPDXp.png
(Sudo 3D) https://i.imgur.com/tTxOOpm.png

3 Likes