53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# 🏠 ujs
|
||
|
||
**ujs** — JavaScript библиотека для разработки игр на HTML5/Canvas
|
||
|
||
## 💽 Установка и использование
|
||
|
||
### 💾 Установка
|
||
|
||
Необходимо скачать файл `ujs.js` и разместить его в директории проекта,
|
||
например по слеющуему пути `assets/js`.
|
||
|
||
По [этой ссылке](http://a2s.su/) (**_в данный момент ссылка не работает_**)
|
||
расположена последняя версия (`ujs-beta`) библиотеки.
|
||
|
||
Старые версии и историю изменений можно найти на старнице [🗒️ История версий](versions.md).
|
||
|
||
### ⌨️ Использование
|
||
|
||
Библиотека подключается как модуль из вашего JavaScript файла.
|
||
|
||
Предположим, что файл с Вашим основным кодом игры/приложения называется `game.js`
|
||
и подключён к проекту следующим образом.
|
||
|
||
```html
|
||
<!-- Файл index.html -->
|
||
|
||
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<!-- ... -->
|
||
<script src="./game.js" type="module"></script>
|
||
<!-- ... -->
|
||
</head>
|
||
</html>
|
||
```
|
||
|
||
Для подключения библиотеки необходимо импортировать необходимые объекты библиотеки **ujs** (в данном случае импортируем все объекты)
|
||
с помощью директивы `import`.
|
||
|
||
```javascript
|
||
/* Файл game.js */
|
||
|
||
import * as ujs from './ujs.js';
|
||
```
|
||
|
||
## 📦 Примеры использования библиотеки
|
||
|
||
`⚠️ Этот раздел документации в разработке`
|
||
|
||
## 🧰 Докуменация API
|
||
|
||
Документация по [API](api.md) представлена на [следующей](api.md) странице.
|