meta-client/README.md

MetaJS - The Space Library (Client)

[![Build Status](https://travis-ci.org/cheesyeyes/meta.svg?branch=master)](https://travis-ci.org/cheesyeyes/meta)


# 🏝 Meta - The (Virtual) Space Library. 👩‍🚀 🚀

A javascript library to create shared virtual reality spaces.

[![Meta.js](https://i.imgur.com/pO7cJED.png)](https://metajs.org)

Write one code for any device.
(HTC Vive, Oculus Rift, Desktop, Smartphone, etc.)

# Usage 🚀

```javascript

import {Space, Ground, Grid, Sphere, on} from 'meta-client';

new Space({color:0xff0000})
new Ground({color:0x0000ff});
new Grid({color:0x000000});

space.on('touch', (there) => new Sphere().set(there));

```

# 📖 Docs (http://meta.camp)

The full [documentation](http://meta.camp) on Meta.js.

# 💬 Slack (https://metajsorg.slack.com)

[Talk](https://metajsorg.slack.com) about space.

# 🤖 Requirements

Meta requires NodeJS (https://nodejs.org).

# 🎉 Installation

### Quick (Using [Meta-Kit](https://github.com/cheesyeyes/meta-kit)):

```script
git clone https://github.com/cheesyeyes/meta-kit
cd meta-kit
npm install
npm run build && npm run start
```

Open your browser and visit "localhost:5000".

### Via NPM

```script
npm install meta-client
npm install
npm run build && npm run start
```

[![meta-client](https://badge.fury.io/js/meta-client.svg)](https://badge.fury.io/js/meta-client) (meta-client)

[![meta-server](https://badge.fury.io/js/meta-server.svg)](https://badge.fury.io/js/meta-server) (meta-server)

[![meta-client](https://badge.fury.io/js/meta-console.svg)](https://badge.fury.io/js/meta-console) (meta-console)

### Custom

```script
git clone https://github.com/cheesyeyes/meta
npm install
npm run build && npm start
```

# Usage

Open src/public/index.js:

```script

import {Cube} from 'meta-client'

new Cube();

```

Thats all you need to create a cube in VR.
Two lines.

# Credits

Thanks to Mr Doob and all the others who made threeJS happen.

# References & Inspiration

I have two main sources of inspiration:

I probably leanred most about space from
[<b>Walter Lewin</b>](https://www.youtube.com/watch?v=GtOGurrUPmQ "Walter Lewin").

I probably learned most about Toys from [<b>Julian Summer Miller</b>](https://www.youtube.com/watch?v=F6uYDUPn4oM "Julian Summer Miller").

# License
MIT

# Manifesto

Let's start to redefine space!