Skip to content

Commit

Permalink
migrate style from readme to book
Browse files Browse the repository at this point in the history
  • Loading branch information
barsoosayque committed Aug 1, 2020
1 parent 03a3442 commit ade93d2
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 18 deletions.
4 changes: 4 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
6 changes: 3 additions & 3 deletions doc/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]()
Expand Down
18 changes: 18 additions & 0 deletions doc/style/creatures.md
Original file line number Diff line number Diff line change
@@ -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_<width>x<height>_<size>` template. You can find shadow files in the root of any size directory (e.g. `pngs_normal_32x32`).
1 change: 1 addition & 0 deletions doc/style/image/skin-female.png
1 change: 1 addition & 0 deletions doc/style/image/skin-male.png
8 changes: 8 additions & 0 deletions doc/style/overlay.md
Original file line number Diff line number Diff line change
@@ -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)
12 changes: 12 additions & 0 deletions doc/style/terrain-furniture.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 0 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

<img src="./gfx/UltimateCataclysm/pngs_tall_32x64/overlay/skin/skin_light/skin_light_m.png" /> <img src="./gfx/UltimateCataclysm/pngs_tall_32x64/overlay/skin/skin_light/skin_light_f.png" />

### 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.

<img src="./doc/guidelines/bg-value.png"/>

## Folder/Filename Structure
- Put files into the best appropriate folder (terrain, furniture, mutations, items, etc).
Expand Down

0 comments on commit ade93d2

Please sign in to comment.