Skip to content

Commit 9978b37

Browse files
NeoXiderNeoXider
committed
docs
1 parent 80b2e0a commit 9978b37

27 files changed

Lines changed: 256 additions & 498 deletions

‎DOCUMENTATION_INDEX.md‎

Lines changed: 160 additions & 456 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ player = rt.exact("player").Sprite(speed=5)
109109
from spritePro.readyScenes import ChatScene, ChatStyle
110110
import spritePro as s
111111

112-
s.run(scene=ChatScene, multiplayer=True, use_lobby=True, title="Chat")
112+
s.run(scene=ChatScene, multiplayer=True, multiplayer_use_lobby=True, title="Chat")
113113
```
114114

115115
---
@@ -170,6 +170,7 @@ Web: [docs/builds/building_web.md](docs/builds/building_web.md)
170170
| Что | Где |
171171
|-----|-----|
172172
| Полный индекс | [DOCUMENTATION_INDEX.md](DOCUMENTATION_INDEX.md) |
173+
| Оглавление папки `docs/` | [docs/README.md](docs/README.md) |
173174
| API Reference | [docs/API_REFERENCE.md](docs/API_REFERENCE.md) |
174175
| Для новичков | [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md) |
175176
| Физика | [docs/core/physics_guide.md](docs/core/physics_guide.md) |

‎docs/API_REFERENCE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ TCP клиент.
506506
**Сценарий лобби:**
507507
```python
508508
# Хост
509-
s.run(scene=MainScene, multiplayer=True, use_lobby=True)
509+
s.run(scene=MainScene, multiplayer=True, multiplayer_use_lobby=True)
510510
# Клиент
511511
s.run(scene=MainScene, multiplayer=True, host="127.0.0.1", port=5050)
512512
```
@@ -531,7 +531,7 @@ ChatStyle.color_bg = (18, 20, 28)
531531
ChatStyle.color_panel = (28, 32, 44)
532532
ChatStyle.font_size = 16
533533

534-
s.run(scene=ChatScene, multiplayer=True, use_lobby=True)
534+
s.run(scene=ChatScene, multiplayer=True, multiplayer_use_lobby=True)
535535
```
536536

537537
---

‎docs/GETTING_STARTED.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,11 @@ python -m spritePro.cli --android . --android-orientation portrait
250250
## 7️⃣ Следующие шаги
251251

252252
### Изучите документацию
253-
1. **[API Reference](docs/API_REFERENCE.md)** — полный справочник всех классов и функций
254-
2. **[Physics Guide](docs/core/physics_guide.md)** — физика pymunk + редактор сцен
255-
3. **[UI & Layouts](docs/ui/layout_ui.md)** — UI компоненты и автолейауты
256-
4. **[Animation & Tweens](docs/core/tween_system.md)** — анимации и плавные переходы
253+
1. **[API Reference](API_REFERENCE.md)** — полный справочник всех классов и функций
254+
2. **[Physics Guide](core/physics_guide.md)** — физика pymunk + редактор сцен
255+
3. **[UI & Layouts](ui/layout_ui.md)** — UI компоненты и автолейауты
256+
4. **[Animation & Tweens](core/tween_system.md)** — анимации и плавные переходы
257+
5. **[Полный индекс](../DOCUMENTATION_INDEX.md)** — все статьи одним списком
257258

258259
### Практикуйтесь
259260
- Изучите код демо-игр в `spritePro/demoGames/`
@@ -263,7 +264,7 @@ python -m spritePro.cli --android . --android-orientation portrait
263264
### Сообщество
264265
- [GitHub Issues](https://github.com/NeoXider/SpritePro/issues) — вопросы и баги
265266
- [GitHub Discussions](https://github.com/NeoXider/SpritePro/discussions) — обсуждения
266-
- [multiplayer_course](multiplayer_course/README.md) — курс по сетевой игре
267+
- [multiplayer_course](../multiplayer_course/README.md) — курс по сетевой игре
267268

268269
---
269270

@@ -290,6 +291,6 @@ A: `s.run(scene=MainScene, platform="kivy")`
290291
<div align="center">
291292

292293
**🎮 Готовы к следующему шагу?**
293-
Перейдите к [API Reference](docs/API_REFERENCE.md) или изучите [демо-игры](docs/demo_games/demo_games.md)!
294+
Перейдите к [API Reference](API_REFERENCE.md) или изучите [демо-игры](demo_games/demo_games.md)!
294295

295296
</div>

‎docs/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Документация SpritePro
2+
3+
Все статьи лежат в этой папке. Пути в ссылках ниже указаны **относительно `docs/`** (удобно при просмотре на GitHub внутри `docs/`).
4+
5+
## С чего начать
6+
7+
| Документ | Описание |
8+
|----------|----------|
9+
| [GETTING_STARTED.md](GETTING_STARTED.md) | Установка, первая сцена, CLI `--create`, частые вопросы |
10+
| [API_REFERENCE.md](API_REFERENCE.md) | Справочник по классам и функциям |
11+
| [BEST_PRACTICES.md](BEST_PRACTICES.md) | Рекомендации по коду и архитектуре |
12+
13+
Полный оглавление по всем файлам и демо — в корне репозитория: [DOCUMENTATION_INDEX.md](../DOCUMENTATION_INDEX.md).
14+
15+
## Карта разделов
16+
17+
| Папка | Тема |
18+
|-------|------|
19+
| [core/](core/) | Спрайты, анимации, твины, физика, камера, частицы, ресурсы, билдер |
20+
| [ui/](ui/) | Кнопки, текст, слайдеры, лейаут, маски, скролл в UI |
21+
| [systems/](systems/) | Игровой цикл, ввод, события, таймеры, здоровье, сеть |
22+
| [utils/](utils/) | Сохранения, аудио, отладка, поверхности, эффекты |
23+
| [editor/](editor/) | Sprite Editor, типовые проблемы физики в редакторе |
24+
| [builds/](builds/) | Web, Kivy, mobile, сборки |
25+
| [demo_games/](demo_games/) | Каталог демо и готовые сцены |
26+
| [cli_tools/](cli_tools/) | Плагины и CLI |
27+
28+
## Вне папки `docs/`
29+
30+
| Материал | Путь от корня репо |
31+
|----------|-------------------|
32+
| Обзор проекта и установка | [README.md](../README.md) |
33+
| Участие в разработке | [CONTRIBUTING.md](../CONTRIBUTING.md) |
34+
| Планы | [ROADMAP.md](../ROADMAP.md) |
35+
| История версий | [CHANGELOG.md](../CHANGELOG.md) |
36+
| Курс по мультиплееру | [multiplayer_course/README.md](../multiplayer_course/README.md) |
37+
| Демо с `level.json` в корне | [demoGames/README.md](../demoGames/README.md) |
38+
39+
Соглашение: в **корневых** файлах (`README.md`, `DOCUMENTATION_INDEX.md`) ссылки на статьи ведут как `docs/...`. Внутри `docs/*.md` — относительные пути от текущего файла (`../core/sprite.md` из `docs/ui/` и т.д.).

‎docs/core/input_validation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ for pattern in dangerous_patterns:
7474

7575
## См. также
7676

77-
- [Input](input_system.md)
77+
- [Input](../systems/input_system.md)

‎docs/core/overview.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ from spritePro.layout import (
5151
- `layout_demo.py` — все 7 типов лейаутов
5252
- `menu_shop_demo.py` — меню и инвентарь на flex/grid
5353

54-
Подробнее: [layout.md](../ui/layout_ui.md)
54+
Подробнее: [layout_ui.md](../ui/layout_ui.md)
5555

5656
---
5757

@@ -130,7 +130,7 @@ class MultiplayerScene(s.Scene):
130130

131131
### Курс по мультиплееру
132132

133-
В `multiplayer_course/` — 10 уроков: обмен сообщениями → синхронизация → лобби → меню → результаты → финальная сборка.
133+
В `multiplayer_course/` — 11 уроков: обмен сообщениями → синхронизация → лобби → меню → результаты → финальная сборка → продвинутые темы и декораторы.
134134

135135
Подробнее: [networking_guide.md](../systems/networking_guide.md)
136136

@@ -177,8 +177,8 @@ class MultiplayerScene(s.Scene):
177177
|-----|-----|
178178
| Layout | [docs/ui/layout_ui.md](../ui/layout_ui.md) |
179179
| Tween, Fluent API | [docs/core/tween_system.md](tween_system.md), [docs/core/tween_presets.md](tween_presets.md) |
180-
| Networking | [systems/networking_guide.md](systems/networking_guide.md) |
181-
| Курс мультиплеера | [multiplayer_course/README.md](../multiplayer_course/README.md) |
180+
| Networking | [networking_guide.md](../systems/networking_guide.md) |
181+
| Курс мультиплеера | [multiplayer_course/README.md](../../multiplayer_course/README.md) |
182182
| Демо Layout | `spritePro/demoGames/layout_demo.py` |
183183
| Демо Fluent Tween | `spritePro/demoGames/fluent_tween_demo.py` |
184184
| Демо меню/инвентарь | `spritePro/demoGames/menu_shop_demo.py` |

‎docs/demo_games/readySprites.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ s.scene.add_scene("chat", chat)
4444
## Связанное
4545

4646
- [Networking](../systems/networking_guide.md) — сетевое взаимодействие
47-
- [UI](../ui/) — UI компоненты
47+
- [Layout и UI](../ui/layout_ui.md) — автолейаут и связанные компоненты

‎docs/systems/multiplayer.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Multiplayer (Мультиплеер)
22

3+
> **Актуальный сетевой стек** (TCP, JSON, `s.run(..., multiplayer=True)`, `MultiplayerContext`, лобби) описан в **[networking_guide.md](networking_guide.md)**. Этот файл — справка по модулю `spritePro.multiplayer` и связанным типам; при расхождении с поведением кода ориентируйтесь на `networking_guide` и исходники.
4+
35
Модуль `multiplayer.py` предоставляет функциональность для создания многопользовательских игр с поддержкой сетевого взаимодействия.
46

57
## Обзор
@@ -14,9 +16,9 @@
1416

1517
```
1618
┌─────────────┐ ┌─────────────┐
17-
│ Server │◄───────►│ Client │
18-
│ (Host) │ TCP/ │ (Player) │
19-
└─────────────┘ UDP └─────────────┘
19+
│ Server │◄───────►│ Client │
20+
│ (Host) │ TCP │ (Player) │
21+
└─────────────┘ └─────────────┘
2022
│ │
2123
▼ ▼
2224
┌─────────────┐ ┌─────────────┐

‎docs/systems/networking_guide.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,3 +207,11 @@ if ctx:
207207
for pid, pdata in players.items():
208208
print(f"[{pid}] {pdata['name']} (Хост: {pdata['role'] == 'host'})")
209209
```
210+
211+
---
212+
213+
## См. также
214+
215+
- [Пошаговый курс](../../multiplayer_course/README.md) — уроки 1–11 и пример «крестики-нолики».
216+
- [Готовые сцены (лобби, чат)](../demo_games/readySprites.md).
217+
- [Справка по модулю `multiplayer`](multiplayer.md) — низкоуровневые типы; основной сценарий — этот гайд.

0 commit comments

Comments
 (0)