README.md

README.md 10.3 KiB Download Raw

1	# Paperdoll Renderer
2
3	Desktopeditor voor `.ppd`-projecten, bone-gebonden equipment en geanimeerde 3D-preview, met productie-export naar paperdoll-maps.
4
5	## Starten
6
7	Rust 1.96.0 staat in `rust-toolchain.toml`. Op Debian/Ubuntu gebruik je voor bouwen en het venster `pkg-config`, `libxcb1-dev`, `libx11-dev`, `libxkbcommon-dev`, `libxkbcommon-x11-dev` en `libgl1-mesa-dev`. De native filepicker gebruikt XDG Desktop Portal met een GTK/KDE-backend, of Zenity. Live 3D vereist OpenGL 3.3.
8
9	```bash
10	cargo run
11	cargo run -- "/pad met spaties/character.ppd"
12	cargo run -- --preview-fixture
13	cargo run -- --status
14	```
15
16	## Project en bodies
17
18	Het startvenster biedt Project laden en Nieuw project, beide met een systeembestandkiezer. Nieuw project maakt `character.ppd` en de mappen `assets/body/`, `assets/equipment/`, `presets/`, `cache/` en `renders/`. De CC0-testlichamen worden in `assets/body/` voorbereid. `--preview-fixture` maakt een tijdelijk voorbeeldproject en opent de mannelijke body.
19
20	De eerste projectweergave toont de bodies. Kies man / Kies vrouw selecteert een model. Een extern bestand wordt naar de projectmap gekopieerd; bij een bestaande naam krijgt de kopie een eigen naam. Modellen met bijbestanden kun je met hun relatieve mappenstructuur in de projectmap zetten en daar selecteren. Importoverzicht toont meshes, materialen, textures, joints en clips van glTF/GLB, FBX en OBJ+MTL.
21
22	Open man / Open vrouw opent de body. Een geskind glTF/GLB-model is in de live preview zichtbaar:
23
24	- Sleep om te orbiten. Vast renderkader tonen toont het gele orthografische exportkader; stel per man/vrouw Vaste renderhoogte, Centrum Y (beeldcentrum) en Pivot Y (orbitpunt) in en sla op. Zonder handmatige pivot gebruikt de editor de rustpose-nekhoogte (of een fallback met diagnose); Auto nek wist een handmatige override. Body en equipment delen exact dezelfde camera. Uitvinken geeft vrije perspectief-preview met scrollzoom; die zoom verandert de export niet. Een echte 24-bits depthbuffer houdt voorste oppervlakken vooraan.
25	- Kies een animatieclip en gebruik Pauze / Speel.
26	- Yaw − / Yaw + volgen twaalf hoeken van 30°; pitch -30 / 0 / 30 kiezen de hoogte. Yaw 0 kijkt naar de voorkant van de testlichamen (−Z).
27	- Render alle hoeken rendert alle animaties × alle frames op project-fps × 36 hoeken. De preview wordt direct vervangen door iedere voltooide pass: highres → detail → target/diffuse → depth → normal → specular. Alle passes behouden hun aspect met gecentreerde letterboxing en nearest-neighbor weergave. Voortgang telt echte passes; Annuleer render behoudt geldige gedeeltelijke uitvoer. Live 3D keert terug naar het model; een volgende voltooide renderpass kan de preview weer vervangen.
28	- Stel breedte, hoogte en fps in de Bodies-weergave in.
29
30	![Bodyweergave met animatie- en camerabediening](docs/screenshots/body-live.png)
31
32	## Equipment en opslaan
33
34	Vanuit een body opent Equipment de lijst. Kies een definitie of Nieuw.
35
36	1. Geef een unieke naam van maximaal 64 kleine letters/cijfers/`-`/`_`, zonder spaties; `body` is gereserveerd.
37	2. Kies Man / Vrouw voor het lichaam dat je bekijkt; Geldig voor bepaalt op welke geslachten het preset van toepassing is.
38	3. Onderdeel toevoegen (OBJ) opent de systeembestandkiezer. Rigide OBJ-onderdelen worden inclusief MTL en relatieve PNG-bijbestanden ingesloten. De preview gebruikt diffuse kleur/texture en alpha-cutout (grens 0,5). Bronbestanden mogen de modelmap niet verlaten.
39	4. Vouw Skeleton / botten uit en kies het doelbot. Stel relatieve positie XYZ en rotatie XYZ in graden in (Rz·Ry·Rx). Het onderdeel beweegt met dat bot tijdens walk/attack of een andere geïmporteerde bodyclip. Iedere sekse heeft een eigen botbinding; de numerieke offsets zijn gedeeld.
40	5. Kies shinymap (PNG) moduleert de instelbare glanssterkte. Wis shinymap keert terug naar een uniforme glanssterkte. Vul desgewenst Herkomst / licentie in. Meerdere onderdelen kunnen verschillende botten gebruiken.
41	6. Opslaan bewaart het project plus zelfbevattende binaire `.ppe`-snapshots in `presets/` (geometrie, bronpayloads, materialen/textures, transformaties, bindingen, seksevlaggen en herkomst). Er worden geen bronpaden buiten het project nodig om die opnieuw te laden.
42
43	Preset importeren leest een `.ppe` uit bijvoorbeeld een ander project. Bij een andere rig moet je de botten opnieuw kiezen; er wordt niet stil geretarget. Onvolledige configuraties kunnen worden opgeslagen, maar onopgeloste onderdelen worden niet op een gegist bot getekend. Verwijder onderdeel haalt een onderdeel uit het werkpreset; Verwijder equipmentdefinitie haalt de definitie uit de projectlijst. Oude project-snapshots blijven voor herstel bewaard. Opslaan vereist een bestandssysteem met hardlinks; bij een fout wordt een bestaande snapshot niet overschreven.
44
45	Een preset is begrensd op 32 MiB, 32 onderdelen/bestanden en textures van maximaal 2048×2048. Een project heeft maximaal 64 presets en 64 MiB aan presetbestanden. De volledige containerbeschrijving staat in `design.md`.
46
47	```bash
48	# Zelfbevattend CC0-zwaardvoorbeeld in een nieuw tijdelijk project
49	cargo run --example equipment_fixture --locked
50	```
51
52	![Werkelijke equipment-editor met geanimeerd lichaam en handgebonden OBJ](docs/screenshots/equipment-live.png)
53
54	Bij sluiten of Ander project / Nieuw project met wijzigingen kies je Opslaan, Niet opslaan of Annuleren. Als opslaan mislukt, blijft het project open. Annuleren in de bestandkiezer behoudt je huidige werk.
55
56	## Productie-output
57
58	De bodyknop rendert alleen het lichaam; Render equipment alle hoeken in de equipment-editor rendert het geselecteerde preset, geanimeerd op het gekozen lichaam maar zonder body-occlusie of bodypixels. De vaste camera van dat geslacht blijft gelijk, ook als je in de live preview vrij hebt ingezoomd.
59
60	Per beeld worden alleen vier target-res PNGs opgeslagen: `diffuse`, `normal`, `depth`, `specular`. Diffuse is onbelichte albedo (basiskleur/texture × vertexkleur, alpha behouden), nooit ingebakken lighting/schaduw/glans. Depth is lineaire 16-bit grayscale+alpha met gemeenschappelijke near/far; normal is view-space RGB+alpha; specular is lineaire sterkte (body nul, equipment inclusief ingestelde shinymap). Highres en detail zijn uitsluitend zichtbare hulpstappen en worden niet opgeslagen.
61
62	```text
63	renders/run-<tijd>-<pid>/male/body/clip001-walk/f000012/p-30_y330_diffuse.png
64	```
65
66	Ieder nieuw renderverzoek krijgt een eigen runmap; bestaande uitvoer wordt niet overschreven. `render.json` (schema 3) beschrijft projectidentiteit, bronfingerprints (SHA-256 van bodybestand en optioneel encoded equipment), camera/pivot/sample/materiaalcontract, clipinventaris en telling. Alleen `complete.json` (zelfde schema, met per-PNG SHA-256) betekent een volledige set. `cancelled.json`/`failed.json` markeren een gedeeltelijke run zonder compleet-marker. De bibliotheekmodule `export_set` opent uitsluitend voltooide runs met overeenkomende identiteit en geverifieerde checksums, en leest de echte RGBA8-/depth16-maps met strikte pad-/formaatvalidatie. De map-/camera-/pixelcontracten staan in `design.md`.
67
68	## 2D depth-compositor (bibliotheek)
69
70	De module `compositor` combineert een body-export met nul of meer compatibele equipment-exports (zelfde project-id, geslacht, body-fingerprint, target, fps, framing, near/far en clipinventaris via `export_set`). Per pixel wint het dichtstbijzijnde geldige oppervlak (depth gray dichterbij = kleiner; epsilon `DEPTH_EPSILON_U16 = 1` depthcode; bij gelijke diepte wint de laagste laagindex — geef body eerst, daarna equipment op vaste naamvolgorde). Diffuse, normal en specular komen altijd uit dezelfde winnende laag. Soft alpha van die winnaar blijft behouden; verliezende lagen mixen niet mee (single-depth kan geen willekeurige doorschijnendheid reconstrueren).
71
72	`relight` past lineaire ambient + Lambert diffuse + Blinn-Phong specular toe. De lichtvektor staat al in view-space, gelijk aan de geëxporteerde normal maps; opgeslagen diffuse blijft elders onbelichte albedo.
73
74	```rust
75	use paperdoll_renderer::compositor::{assert_compatible, compose_and_relight, LayerMaps, Light};
76	use paperdoll_renderer::export_set::ExportRun;
77
78	let body = ExportRun::open(&body_run_dir)?;
79	let sword = ExportRun::open(&sword_run_dir)?;
80	assert_compatible(&[&body, &sword])?;
81	let layers = [
82	LayerMaps::from_export_run(&body, "body", "clip000-walk", 0, 0, 0)?,
83	LayerMaps::from_export_run(&sword, "sword", "clip000-walk", 0, 0, 0)?,
84	];
85	let (maps, lit_rgba) = compose_and_relight(&layers, &Light::default())?;
86	```
87
88
89	Highres is exact 8× beide assen; batch-targets zijn momenteel 1–256 pixels per as (highres max 2048). Grotere projectinstellingen geven een duidelijke renderfout, geen stil verkleinde supersampling. Maximaal 500000 PNGs / 16 GiB geschatte ongecomprimeerde targetdata per run; output vereist hardlinks. Productie rendert de eerste skinned glTF/GLB-mesh met driehoekprimitieven, basiskleur/8-bit albedotextures en vertexkleuren. FBX is alleen importoverzicht; morph targets, tangent-normaltextures, volledige PBR en willekeurige transparante lagen zijn niet ondersteund. Live placement blijft een belichte, vereenvoudigde weergave.
90
91	## Openen met
92
93	- Windows: start de uitgepakte `.exe` eenmaal om de editor voor het huidige account aan Openen met toe te voegen. Kies daarna bij een `.ppd` Openen met → Paperdoll Renderer (of selecteer de `.exe` via Bladeren).
94	- Debian/Arch: de pakketten installeren de `.ppd`-MIME-koppeling, desktopstarter en iconen. Kies de editor in Openen met.
95	- Linux AppImage/losse binary: bewaar het bestand op zijn vaste plek en voer `"/pad/Paperdoll.AppImage" --install-desktop` uit. Hiervoor zijn `shared-mime-info` en `desktop-file-utils` nodig. Daarna staat de editor in Openen met. Herhaal dit na verplaatsen van de AppImage.
96
97	Het venster, de Linux-starter en de Windows-executable gebruiken Tims applicatie-icoon.
98
99	## Tests
100
101	```bash
102	cargo fmt --check
103	cargo check --workspace --all-targets --locked
104	cargo clippy --workspace --all-targets --locked -- -D warnings
105	cargo test --workspace --locked
106	# Linux GPU-regressie: echte depth-occlusie, normal/depth/specular en lichtonafhankelijke albedo
107	xvfb-run -a cargo run --example preview_depth_probe --locked
108	```
109
110	De testlichamen komen uit `scripts/generate_test_bodies.py`. Het FBX-testbestand wordt met Blender via `scripts/convert_test_body_to_fbx.py` gemaakt.