croquet/microverse

Croquet Microverse (Beta)

Croquet Microverse (Beta)

https://croquet.io

Getting Started

A new project can be started by running npm create croquet-microverse@latest in an empty directory on your computer and then run npm start in the directory. If you wish to make a new Microverse world with a stable version of library, no need to clone this repositoty. For more information, refer to The Quick Start Guide. This repository contains the source code and build scripts of "Microvese Library" that is ued in the npm create ... command. If you wish to learn more aboutMicroverse system itself and modify code in the library to enhance it for your projects, please read on the following.

Description

Croquet Microverse is a framework for building multiplayer immersive 3D virtual worlds on the web. It is built on the Croquet OS and the Worldcore framework.

• Croquet OS provides a clean substrate for building multiuser applications.
• Worldcore Framework provides an abstraction for building 3D applications on top of Croquet OS.
• "Cards" and "Behaviors" abstractions provide a uniform object model, and pluggable behavior descriptions for those objects. It also allows integration with your text editor to support multiuser live programming.
• Three.js provides an industrial-strength 3D rendering backend.
• All Web technology in your browser is available, so the virtual world can access different media, real-world data etc, and vice versa.

By combining all together, Croquet Microverse helps developers to create a metaverse world interactively and quickly. Crucially, the deployed web app requires zero-installation to run on users computers.

License

The source code and assets in this repository are licensed under Apache License 2.0.

Enter a publicly deployed world

The quickest way to get a feel for Microverse is to visit a default world served from the Croquet site:

1. Point your browser at https://croquet.io/microverse.
2. Once the world loads, navigate around by dragging the joystick at bottom center of the window. At this point you are alone in a newly generated private world, that is identified by the extended URL (with automatically added session ID and password) that now appears in your browser's address bar.
3. To bring additional users into this world, load the extended URL in another browser tab. You could do this by...
   • copying the URL from the address bar and pasting it in a fresh tab, or
   • sending the copied URL to a friend, to load in their own browser, or
   • clicking the hamburger menu at top right, and pointing your phone camera at the QR code that appears.
4. All browser tabs with the same URL are in the same world. As you navigate in any tab, everyone else can see your avatar. As you interact with objects, everyone else can see you interacting.

There are other Microverse worlds on https://croquet.io.

• Mythos - A mythical world with advanced shader visual effects.
• Factory - A factory with programmable elements and behaviors.
• Gallery - A gallery with different kinds of assets on the wall.
• Campus - A college campus with programmable demos.
• Physics - A world with an interactive physics simulation.

The worlds on the Croquet server cannot be modified by you. But if you are a developer who already has the tools git and npm, follow these steps to get a taste of how straightforward it is to set up your own shareable worlds:

1. Open a terminal.

2. Clone the GitHub repository for the world you are interested in. They are available at https://github.com/croquet/gallery, https://github.com/croquet/factory, etc.

3. Enter the resulting project folder.
   cd gallery

4. Install necessary libraries.
   npm install

5. Start a Microverse code server.
   npm start

6. Point your browser to localhost:9684. As in the publicly deployed example above, you will find yourself alone in a new world, at a URL that has automatically been extended with a session ID and password.

7. To join this world from other browsers on the same computer, copy and paste the extended URL.

8. [bonus activity] To join the world from other devices that are on the same network, you'll need a URL in which localhost:9684 is replaced with your computer's IP address. If you don't know the address, one place to find it is in the output from the npm start that you ran in step 5. Look for a line of the form

   (Network IPv4 "en0") http://192.168.0.103:9684

   ...and don't forget to add the session ID and password parts of the URL. Once you have loaded this URL on any device, the QR code that it will display from the hamburger menu will work for other devices on the same network.

To learn more about modifying Microverse code and worlds, and obtaining the API key that will let you deploy them beyond your local computer, see the documentation below.

Development

This repository has the equivalent of gallery world and also the "test" world that only has a sky box and a programatically generated flat gridded floor. Check out docs/Development.md for making changes to the system code and test it.

Documentation

The documentation for the Croquet Microverse is located in the docs directory.

• docs/QuickStart.md - Quick Start guide to Microverse IDE
• docs/Development.md - Development Guide on building Microverses
• docs/Card.md - The methods and properties of the Card classes.
• docs/Avatar.md - The methods and properties of the Avatar classes.
• docs/CardSpec.md - Specification for Microverse Cards
• docs/Elected.md - The Election mechanism to choose a peer.
• docs/Physics.md - Using the Rapier Physics Engine in Microverses
• docs/Tutorial.md - The introduction to tutorials
• docs/Tutorial1.md - The tutorial part 1.
• docs/Tutorial2.md - The tutorial part 2.

This project is tested with BrowserStack

Copyright (c) 2022 Croquet Corporation