Skip to content

Commit

Permalink
items style doc
Browse files Browse the repository at this point in the history
  • Loading branch information
barsoosayque committed Aug 1, 2020
1 parent bbb0f9d commit 03a3442
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Installation & Building](installation.md)
- [Style guidelines](style/summary.md)
- [General](style/general.md)
- [Items]()
- [Items](style/items.md)
- [Overlay]()
- [Creatures]()
- [Terrain & Furniture]()
Expand Down
2 changes: 2 additions & 0 deletions doc/style/general.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# General style guidelines

A bunch of rules that can be applied for every type of sprite.

## Use a limited set of colors as in pseudo-16 bit format

![colors](image/colors.png)
Expand Down
Binary file added doc/style/image/containers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/style/image/item-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/style/image/item-proportions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/style/image/source.kra
Binary file not shown.
25 changes: 25 additions & 0 deletions doc/style/items.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
# Items

## Maximum item size is 32x32; small items should fit within 16x16

![item-proportions](image/item-proportions.png)

This is continuation of the general rule.

## Item tiles should be as close to scale as they can be while still recognizable

![item-group](image/item-group.png)

When in doubt, err on the side of larger, but avoid filling an entire 32x32 tile with a single nail or it would look like a nail as large as a survivor.
Even for single items, putting multiple items into the icon could give it more recognizability without making it look comically huge.

## Containers should be drawn empty

![containers](image/containers.png)

Like jars or bottles. The game will use the same tile no matter the actual content of the item.

## 100% black underline without shadow

*// TODO: image*

No shadow will make sure that players don't confuse several big items with furniture. Black underline helps to identify an item in the game world.
7 changes: 0 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +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`).

### Items
- 32x32 tile base; small items should fit within 16x16.
- Item tiles should be as close to scale as they can be while still recognizable. When in doubt, err on the side of larger, but avoid filling an entire 32x32 tile with a single nail or it would look like a nail as large as a survivor.
- Even for single items, putting multiple items into the icon could give it more recognizability without making it look comically huge.
- Containers, like jars or bottles, should be drawn empty as the game will use the same tile no matter the actual content of the item.
- 100% black underline without shadow on the floor so that they are not mistaken for furniture; this helps to identify an item in the game world.

### Overlay
- 32x64 tile base; use these as reference (base male and base female sprites):

Expand Down

0 comments on commit 03a3442

Please sign in to comment.