wassname/metacar
1
0
Fork 0
mirror of https://github.com/wassname/metacar.git synced 2026-09-09 11:26:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Thibault Neveu
2018-06-16 09:21:28 +01:00
committed by GitHub
parent 436db9fd06
commit 4d12ca402b
1 changed files with 75 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+75 -4
View File
@@ -6,13 +6,54 @@
3. [Interact with the environement](#interact-env)
4. [Other events](#other-interact-env)
5. [Custom your environement](#configure-env)
5. [Create your own level](#create-leven)
5. [Create your own level](#create-level)
<a id='getting-started'></a>
Getting Started
Getting started
------------
npm install, from typescript and from include.
Say ton include pixi.js!
### Installing Metacar
You can used Metacar with a direct link in your HTML file or installing it from NPM. However, metacar is based on [Pixi.js](www.pixijs.com): 4.7.1, then you need to include pixi.js as a global dependencies in your HTML.
#### Script Tag
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Metacar: Documentation</title>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pixi.js/4.7.1/pixi.min.js"></script>
</head>
<body>
<script src="https://cdn.jsdelivr.net/npm/metacar@0.0.1/dist/metacar.min.js"></script>
</body>
</html>
```
#### Script Tag and npm
```shell
npm i metacar
```
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Metacar: Documentation</title>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pixi.js/4.7.1/pixi.min.js"></script>
</head>
<body>
<script src="yourscript.js"></script>
</body>
</html>
```
```javascript
import Metacar from "metacar";
```
------------
@@ -20,6 +61,32 @@ Say ton include pixi.js!
Your first environement
------------
Even if you can [create your own level](#create-level), Metacar comes up with a set of predefined level accessible under [metacar.level](#). Once your level is selected, you can use it to create a first environement. <br>
```javascript
// Select a level
const level = metacar.level.level1;
// Create the environement
const env = new metacar.env("env", level);
// Load it
env.load();
```
You also have to create the container in your HTML file.
```html
<div id="env"></div>
```
(NOTE: metacar.env can be instanciate with an object or a string for the level parameters: [doc API](#link))
<b>Wonderful! You just create your first metacar environement. </b> You can take sometime to play around with the key arrow to move the car. The current collision system support the detection of the following events:
* Collisions with other vehicles
* Detection of the road, ground and road with the lidar
* Detection of the car going out track
If you want to see add features to the detection system you can considere [contributing to the project](#link) :)
<a id='interact-env'></a>
Interact with the environement
------------
@@ -49,4 +116,8 @@ Custom your environement
------------
<a id='link'></a>
Link
------------