Code Monkey home page Code Monkey logo

mml-starter-project's Introduction

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.

mml-starter-project's People

Contributors

gwilymio avatar lukasondre avatar marcuslongmuir avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.