Полный указатель материалов репозитория. Все ссылки на статьи в docs/ ведут от корня репозитория (как на GitHub при открытии файла в корне).
| Нужно | Куда |
|---|---|
| Установка и первая сцена | docs/GETTING_STARTED.md |
| Справочник API | docs/API_REFERENCE.md |
| Обзор подсистем | docs/core/overview.md |
| Каталог демо (команды запуска) | docs/demo_games/demo_games.md |
| Сеть и лобби | docs/systems/networking_guide.md |
| Редактор сцен | docs/editor/sprite_editor.md |
| Web / mobile / сборки | docs/builds/building_web.md, docs/builds/mobile_kivy.md |
Папка docs/ на GitHub |
docs/README.md |
| Файл | Описание |
|---|---|
| README.md | Обзор, установка, примеры |
| CONTRIBUTING.md | Как вносить вклад |
| ROADMAP.md | Планы развития |
| CHANGELOG.md | История версий и заметки по документации |
Идеи игр, техспеки и гайды по перфу, если появятся в репозитории, будут добавлены сюда; сейчас см. ROADMAP и CHANGELOG.
| Документ | Тема |
|---|---|
| docs/core/overview.md | Краткий обзор |
| docs/core/comprehensive_guide.md | Развёрнутое руководство |
| docs/core/sprite.md | Класс Sprite |
| docs/core/spriteProGame.md | Игра и точка входа |
| docs/core/animation.md | Покадровая анимация |
| docs/core/tween_system.md | Твины и Fluent API |
| docs/core/tween_presets.md | Пресеты твинов |
| docs/core/physics_guide.md | Физика pymunk |
| docs/core/camera_and_particles.md | Камера и частицы |
| docs/core/particles_guide.md | Частицы подробно |
| docs/core/resources.md | Ресурсы |
| docs/core/BUILDER_API.md | Fluent Builder |
| docs/core/exceptions.md | Исключения |
| docs/core/input_validation.md | Валидация ввода |
| docs/core/VALIDATION_GUIDE.md | Валидация в проекте |
| Документ | Тема |
|---|---|
| docs/ui/button.md | Button |
| docs/ui/toggle_button.md | ToggleButton |
| docs/ui/slider.md | Slider |
| docs/ui/text.md | TextSprite |
| docs/ui/text_input.md | TextInput |
| docs/ui/text_fps.md | Счётчик FPS |
| docs/ui/layout_ui.md | Layout, ScrollView |
| docs/ui/pages_guide.md | Pages |
| docs/ui/mouse_interactor.md | MouseInteractor |
| docs/ui/draggable_sprite.md | Перетаскивание |
| docs/ui/bar.md | Bar |
| docs/ui/bar_background.md | Bar с фоном |
| docs/ui/clip_mask.md | ClipMask |
| Документ | Тема |
|---|---|
| docs/systems/game_loop.md | Цикл, сцены, reference_size |
| docs/systems/input_system.md | Ввод |
| docs/systems/events_system.md | EventBus |
| docs/systems/timer_component.md | Таймеры |
| docs/systems/health_component.md | Здоровье |
| docs/systems/networking_guide.md | Сеть, лобби, декораторы |
| docs/systems/multiplayer.md | Мультиплеер (обзор) |
| Документ | Тема |
|---|---|
| docs/utils/save_load.md | Сохранения |
| docs/utils/surface.md | Поверхности |
| docs/utils/audio.md | Аудио |
| docs/utils/debug_overlay.md | Отладочный оверлей |
| docs/utils/color_effects.md | Цветовые эффекты |
| docs/utils/camera_effects.md | Эффекты камеры |
| docs/utils/scroll.md | ScrollController / ScrollArea |
| docs/utils/grid_renderer.md | Сетка |
| docs/utils/resource_watcher.md | Hot reload |
| docs/utils/angle_utils.md | Углы |
| Документ | Тема |
|---|---|
| docs/editor/sprite_editor.md | Sprite Editor, spawn_scene, экспорт |
| docs/editor/physics_issues.md | Физика в редакторе |
| docs/builds/building_web.md | Web, wheel, pygbag |
| docs/builds/web_build.md | Web-сборка |
| docs/builds/pygame_to_web.md | pygame → web |
| docs/builds/mobile_kivy.md | Kivy / mobile |
| docs/builds/kivy_hybrid.md | Kivy + игровая область |
| Материал | Описание |
|---|---|
| docs/demo_games/demo_games.md | Полный список демо и команд |
| docs/demo_games/readySprites.md | Готовые сцены и компоненты |
| demoGames/README.md | Демо в корне с level.json |
| multiplayer_course/README.md | Курс по сетевой игре |
| multiplayer_course/tictactoe_example/README.md | Крестики-нолики |
Исходники демо: каталог spritePro/demoGames/ (запуск через python -m spritePro.demoGames.<имя>).
| Документ | Тема |
|---|---|
| docs/cli_tools/PLUGINS_GUIDE.md | Плагины |
| Документ | Тема |
|---|---|
| docs/BEST_PRACTICES.md | Практики разработки |
Новичок: README.md → docs/GETTING_STARTED.md → docs/core/sprite.md → docs/ui/button.md → docs/demo_games/demo_games.md.
Игра с уровнями: docs/editor/sprite_editor.md → docs/core/physics_guide.md → демо editor_scene_runtime_demo, physics_demo.
Сеть: docs/systems/networking_guide.md → multiplayer_course/README.md.
Актуальная история изменений библиотеки и сопутствующих правок в доках — в CHANGELOG.md. Этот индекс поддерживается вместе с кодом: при добавлении нового .md в docs/ строка должна появиться в соответствующей таблице выше.
Вопросы и предложения по документации — Issues с тегом documentation или pull request.
Совет: в начале страницы — быстрая навигация. Внутри папки docs/ удобнее открыть docs/README.md.