Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.57 KB

File metadata and controls

39 lines (30 loc) · 2.57 KB

Документация SpritePro

Все статьи лежат в этой папке. Пути в ссылках ниже указаны относительно docs/ (удобно при просмотре на GitHub внутри docs/).

С чего начать

Документ Описание
GETTING_STARTED.md Установка, первая сцена, CLI --create, частые вопросы
API_REFERENCE.md Справочник по классам и функциям
BEST_PRACTICES.md Рекомендации по коду и архитектуре

Полный оглавление по всем файлам и демо — в корне репозитория: DOCUMENTATION_INDEX.md.

Карта разделов

Папка Тема
core/ Спрайты, анимации, твины, физика, камера, частицы, ресурсы, билдер
ui/ Кнопки, текст, слайдеры, лейаут, маски, скролл в UI
systems/ Игровой цикл, ввод, события, таймеры, здоровье, сеть
utils/ Сохранения, аудио, отладка, поверхности, эффекты
editor/ Sprite Editor, типовые проблемы физики в редакторе
builds/ Web, Kivy, mobile, сборки
demo_games/ Каталог демо и готовые сцены
cli_tools/ Плагины и CLI

Вне папки docs/

Материал Путь от корня репо
Обзор проекта и установка README.md
Участие в разработке CONTRIBUTING.md
Планы ROADMAP.md
История версий CHANGELOG.md
Курс по мультиплееру multiplayer_course/README.md
Демо с level.json в корне demoGames/README.md

Соглашение: в корневых файлах (README.md, DOCUMENTATION_INDEX.md) ссылки на статьи ведут как docs/.... Внутри docs/*.md — относительные пути от текущего файла (../core/sprite.md из docs/ui/ и т.д.).