diff --git a/book.toml b/book.toml index 8d456d828d..305845bb70 100644 --- a/book.toml +++ b/book.toml @@ -3,3 +3,7 @@ language = "en" multilingual = false src = "doc" title = "UltimateCataclysm — Documentation" + +[output.html] +git-repository-url = "https://github.com/I-am-Erk/CDDA-Tilesets" +git-repository-icon = "fa-github" diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md index 71e6d8db31..64955b3ec0 100644 --- a/doc/SUMMARY.md +++ b/doc/SUMMARY.md @@ -4,9 +4,9 @@ - [Style guidelines](style/summary.md) - [General](style/general.md) - [Items](style/items.md) - - [Overlay]() - - [Creatures]() - - [Terrain & Furniture]() + - [Overlay](style/overlay.md) + - [Creatures](style/creatures.md) + - [Terrain & Furniture](style/terrain-furniture.md) - [How to]() - [Tileset structure]() - [Autotiles]() diff --git a/doc/style/creatures.md b/doc/style/creatures.md index 6274f757d3..0eb894d131 100644 --- a/doc/style/creatures.md +++ b/doc/style/creatures.md @@ -1 +1,19 @@ # Creatures + +## Take appropriate tile size + +*// TODO: image* + +Consider 32x64 a default human size. + +# Monster sprites should have ~8px offset from the ground + +*// TODO: image* + +To give them a 3d look. + +# Monsters should drop shadows when possible + +*// TODO: image* + +Put shadows in a `bg` field in json, use `shadow_x_` template. You can find shadow files in the root of any size directory (e.g. `pngs_normal_32x32`). diff --git a/doc/style/image/skin-female.png b/doc/style/image/skin-female.png new file mode 120000 index 0000000000..639b1801bb --- /dev/null +++ b/doc/style/image/skin-female.png @@ -0,0 +1 @@ +../../../gfx/UltimateCataclysm/pngs_tall_32x64/overlay/skin/skin_light/skin_light_f.png \ No newline at end of file diff --git a/doc/style/image/skin-male.png b/doc/style/image/skin-male.png new file mode 120000 index 0000000000..91c03ba969 --- /dev/null +++ b/doc/style/image/skin-male.png @@ -0,0 +1 @@ +../../../gfx/UltimateCataclysm/pngs_tall_32x64/overlay/skin/skin_light/skin_light_m.png \ No newline at end of file diff --git a/doc/style/overlay.md b/doc/style/overlay.md index b53301ceec..9e1e273f31 100644 --- a/doc/style/overlay.md +++ b/doc/style/overlay.md @@ -1 +1,9 @@ # Overlay + +Rules about hair, mutations, worn clothes, wielded items and survivour's skin. + +# 32x64 tile base +Use these as reference (base male and base female sprites): + +![male](image/skin-male.png) +![female](image/skin-female.png) diff --git a/doc/style/terrain-furniture.md b/doc/style/terrain-furniture.md index c3dd5d9bdf..6f737d31b9 100644 --- a/doc/style/terrain-furniture.md +++ b/doc/style/terrain-furniture.md @@ -1 +1,13 @@ # Terrain & Furniture + +## Walls and floors are 32x32, other things may vary + +*// TODO: image* + +Again, you should size things accordingly to its size in the world. + +## Keep color value level in medium range + +*// TODO: image* + +It's important to keep value level of the background objects (terrain, furniture) about 60-80, because it would define foreground entities (e.g. monsters) better. diff --git a/readme.md b/readme.md index 8fd99cf862..5c71536ae4 100644 --- a/readme.md +++ b/readme.md @@ -18,21 +18,6 @@ This repository stores individual sprites for UltiCa in PNG format, and also source files with layering in *PSD* (Photoshop), *XCF* (gimp 2.10) or *KRA* (Krita) formats. PNGs will then be compiled into a tileset using a python script maintained by mlangsdorf (The script is located in the main Cataclysm repo under `tools/gfx_tools/compose.py`). -### Overlay -- 32x64 tile base; use these as reference (base male and base female sprites): - - - -### Monsters -- Take appropriate tile size; consider 32x64 a default human size. -- Monster sprites should have ~8px offset from the ground to give them a 3d look. -- Monsters should drop shadows when possible: 50% opaque black, ellipsis under the body. - -### Terrain -- Walls and floors are 32x32, other things you should size accordingly to it's size in the world. -- It's important to keep value level of the background objects (terrain, furniture) about 60-80, because it would define foreground entities (e.g. monsters) better. - - ## Folder/Filename Structure - Put files into the best appropriate folder (terrain, furniture, mutations, items, etc).