matter-js README

The project's README from github.com/liabru/matter-js. As one markdown file: README.md.

Matter.js

Matter.js is a JavaScript 2D rigid body physics engine for the web

brm.io/matter-js

Demos ・ Gallery ・ Features ・ Plugins ・ Install ・ Usage ・ Examples ・ Docs ・ Wiki ・ References ・ License

Demos


See how others are using matter.js physics

Features

Install

You can install using package managers npm and Yarn using:

npm install matter-js

Alternatively you can download a stable release or try the latest experimental alpha build (master) and include the script in your web page:

<script src="matter.js" type="text/javascript"></script>

Performance with other tools (e.g. Webpack, Vue etc.)

Bundlers and frameworks may reduce real-time performance when using their default configs, especially in development modes.

When using Webpack, the default sourcemap config can have a large impact, for a solution see issue.

When using Vue.js, watchers can have a large impact, for a solution see issue.

Usage

Visit the Getting started wiki page for a minimal usage example which should work in both browsers and Node.js.
Also see the Running and Rendering wiki pages, which show how to use your own game and rendering loops.

Tutorials

See the list of tutorials.

Examples

See the examples directory which contains the source for all demos.
There are even more examples on codepen.

Plugins

The engine can be extended through plugins, see these resources:

Documentation

See the API Documentation and the wiki

Building and Contributing

To build you must first install node.js, then run

npm install

This will install the required build dependencies, then run

npm run dev

to spawn a development server. For information on contributing see CONTRIBUTING.md.

Changelog

To see what's new or changed in the latest version, see the changelog.

References

See the wiki page on References.

License

Matter.js is licensed under The MIT License (MIT)
Copyright (c) 2014 Liam Brummitt

This license is also supplied with the release and source code.
As stated in the license, absolutely no warranty is provided.

matter-js (liabru/matter-js)

Searching Database…

18.5K ·GitHub
Что это такое?Matter.js — это двухмерный физический движок твёрдых тел на JavaScript для веба: физическая симуляция, которую можно вставить в веб-страницы и приложения на Node.js.
Это библиотека физики, которую я вызываю из своего кода, или скорее готовый игровой движок?Это библиотека, которой вы управляете из собственного кода на JavaScript, а не полноценный игровой движок. В комплекте есть рендерер для canvas, но в документации показано, как встроить его в собственный игровой цикл и цикл отрисовки.
Как добавить её в веб-проект?Установите через npm или Yarn (npm install matter-js) либо скачайте стабильный релиз и подключите скрипт на своей странице. Настраивать какие-либо зависимости перед запуском не нужно.
Есть ли подводные камни при использовании в современных сборщиках и фреймворках?Да: стандартные настройки сборщиков и фреймворков могут вредить производительности в реальном времени, особенно в режиме разработки. В README отдельно отмечено, что sourcemaps в Webpack и watchers во Vue.js дают сильное замедление.
Работает только в браузере или ещё и на сервере и на мобильных устройствах?Поддерживаются и браузеры, и Node.js — Chrome, Firefox, Safari и даже IE8+, — а также мобильные устройства с поддержкой touch-событий и адаптивной вёрстки.
Что именно умеет физическая симуляция?Твёрдые, составные и композитные тела, вогнутые и выпуклые оболочки, упругость (restitution), трение, связи (constraints), гравитацию, «засыпание» и статические тела, запросы столкновений вроде рейкастинга и проверки областей, а также масштабирование времени для эффекта замедления.
Это порт другого физического движка?Нет — в README указано, что это оригинальная реализация на JavaScript, а не порт.
Можно ли расширять движок плагинами?Да, есть система плагинов. В README есть ссылки на руководства по использованию и созданию плагинов, список существующих плагинов и стартовый шаблон matter-plugin-boilerplate.
Что такое MatterTools?Набор инструментов, идущий в комплекте с движком, для создания, тестирования и отладки физических миров.
Creator
liabru
Size
22.3 MB
Stars
18.5K
Updated
CommitSep 30
Age
12y
Commits · 90 Days