docsify

2023-04-30 17:39:03 +03:00
parent 51dbf116c1
commit c52b91c007
12 changed files with 2097 additions and 16 deletions
@@ -0,0 +1,5 @@
+# ⚠️ В РАЗРАБОТКЕ
+
+## 🧻 Документация
+
+- [API](/ru/api.md)
@@ -0,0 +1,150 @@
+# 🔵 App
+
+Основной класс движка.
+
+При инициализации самостоятельно добавляет HTML элемент `<canvas>`
+в тег `<body>`.
+
+## 🎛️ Параметры
+
+- `w` — ширина холста в пикселях.
+- `h` — высота холста в пикселях.
+- `options` — объект опций.
+
+### options
+
+```text
+{
+    backgroundColor: '#ffcc68',
+    welcome: true,
+}
+```
+
+- `backgroundColor` — фон холста.  
+  По умолчанию `#ffcc68`.
+
+- `welcome` — `bool` тип.  
+  Отображает информацию о движке в **Console**.  
+  По умолчанию `true`.
+
+## 🩻 Методы
+
+...
+
+## 🎮 Пример использования
+
+```javascript
+// init app
+let app = new App(400, 400);
+
+// add app view in document
+window.addEventListener('DOMContentLoaded', () => {
+  document.body.appendChild(app.view);
+});
+```
+
+# 🔵 Scene
+
+Класс сцены.
+
+## 🎛️ Параметры
+
+...
+
+## 🩻 Методы
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```
+
+# 🔵 SceneLayer
+
+Класс слоя сцены.
+
+## 🎛️ Параметры
+
+...
+
+## 🩻 Методы
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```
+
+# 🔵 Object
+
+Класс объекта.
+
+## 🎛️ Параметры
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```
+
+# 🔵 Rect
+
+...
+
+## 🎛️ Параметры
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```
+
+# 🔵 StrokeRect
+
+...
+
+## 🎛️ Параметры
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```
+
+# 🔵 Sprite
+
+...
+
+## 🎛️ Параметры
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```
+
+# 🔵 TiledSprite
+
+...
+
+## 🎛️ Параметры
+
+...
+
+## 🎮 Пример использования
+
+```text
+...
+```