summaryrefslogtreecommitdiff
path: root/doc/resources.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2025-01-07 21:16:40 +0100
committermetamuffin <metamuffin@disroot.org>2025-01-07 21:16:40 +0100
commit3d156d75de3852dd36d0eeda33b17a2b6f10aa4a (patch)
tree4633e5934df9ff2519f422da96b64a045e5f7bb9 /doc/resources.md
parentd3e2f02f5f75afb6d6c62e77577452224e4a34a4 (diff)
downloadweareserver-3d156d75de3852dd36d0eeda33b17a2b6f10aa4a.tar
weareserver-3d156d75de3852dd36d0eeda33b17a2b6f10aa4a.tar.bz2
weareserver-3d156d75de3852dd36d0eeda33b17a2b6f10aa4a.tar.zst
new proto doc
Diffstat (limited to 'doc/resources.md')
-rw-r--r--doc/resources.md73
1 files changed, 73 insertions, 0 deletions
diff --git a/doc/resources.md b/doc/resources.md
new file mode 100644
index 0000000..3add075
--- /dev/null
+++ b/doc/resources.md
@@ -0,0 +1,73 @@
+# Resource formats
+
+## Dictionary format
+
+```
+[kkkk vvvv KK... VV...]...
+ ^ ^ ^ ^
+ | | | | value
+ | | | key
+ | | 16-bit kalue length
+ | 16-bit key length
+```
+
+## PrefabIndex
+
+| Key | Value Type |
+| -------- | ---------- |
+| \<Name\> | Resource |
+
+## Prefab
+
+| Key | Value Type | |
+| ----------- | ----------------------- | --------- |
+| mesh | Matrix3, Vec3, Resource | Multi key |
+| light | Vec3, Resource | Multi key |
+| environment | Resource | |
+
+## MeshPart
+
+Combinations of g__, va__ and tex_* are multiplied except normal which is added.
+Defaults should be the identity for that operation, so default is 1 / white
+except normals are zero.
+
+| Key | Value Type | |
+| ---------------- | ------------- | ------------------ |
+| index | Resource | |
+| g_metallic | f32 | |
+| g_roughness | f32 | |
+| g_albedo | Vec3 | |
+| g_transmission | f32 | |
+| g_emission | Vec3 | |
+| va_position | [Resource; 3] | |
+| va_normal | [Resource; 3] | |
+| va_texcoord | [Resource; 2] | |
+| va_roughness | Resource | |
+| va_metallic | Resource | |
+| va_albedo | [Resource; 3] | |
+| va_transmission | Resource | |
+| va_emission | Resource | |
+| tex_normal | Resource | Use color channels |
+| tex_roughness | Resource | Use green channel |
+| tex_metallic | Resource | Use blue channel |
+| tex_albedo | Resource | Use color channels |
+| tex_transmission | Resource | Use alpha channel |
+| tex_emission | Resource | Use color channels |
+
+## LightPart
+
+| Key | Value Type |
+| -------- | ---------- |
+| radius | f32 |
+| emission | Vec3 |
+
+## EnvironmentPart
+
+| Key | Value Type | |
+| ------ | ---------- | ---------------- |
+| skybox | Resource | |
+| sun | Vec3, Vec3 | Direction, Color |
+
+## Texture
+
+WebP