jhirn / mml-starter-project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MML Starter Project

This project is an example of a server that serves a live MML (Metaverse Markup Language) document via a WebSocket and reloads it live during editing. It can be easily deployed to environments that support Node.js and expose ports to the internet.

The included mml-document.html is the perfect starting point as you discover MML and start experimenting with your own creations. To dive deeper, please see the MML documentation.

Run on CodeSandbox

Click the button below to create a new sandbox on CodeSandbox.io.

Edit mml-starter-project on CodeSandbox

Once your sandbox is initialized, select the 'start: 8080' tab to view the running document as pictured below:

Running locally

Making sure you have Node.js installed, run the following from the root of the repository:

npm install
npm start

Once the server is running, open http://localhost:8080 in your browser.

Sharing your creation

If you're running the project on CodeSandbox, simply click the blue 'Share' button and copy the provided URL.

If you're running it locally, you'll need to expose the server to the internet first so that others can connect. This can be achieved by creating a tunnel using a tool such as ngrok.

Trying out your Creations

You can also try your creations in The Construct by adding the object's wss:// address to your collection. Once you have the object in your collection, visit the "The Construct" through the Events page. Once in the world, approach a special plinth to spawn your creation.

About

License:MIT License


Languages

Language:HTML 72.6%Language:JavaScript 27.4%