Docs: New Guide for adding art/sprites to Stonesense #5207
Conversation
realSquidCoder
changed the title
|
i think i wanna call this good and forgo the XML tutorial since I want to restructure how its done. (non-code changes) |
realSquidCoder
changed the title
realSquidCoder
changed the title
Co-authored-by: Myk <myk.taylor@gmail.com>
…Industries/dfhack into squid-stonesense-docs
realSquidCoder
changed the title
|
ok i think it looks good now, im havign starry read it as she would be one of the target audiences |
| Note that, in order not to conflict with neighboring sprites, a sprite must actually be within a smaller | ||
| area than its 32x32 block, typically 30x30. |
There was a problem hiding this comment.
I don't quite understand this. Why would a sprite that uses its full allocated space "conflict" with its neighboring sprites? The DF sprite sheets have sprites up to their boundary pixels, adjacent to the next sprite over, and there aren't any issues there. What problems does Stonesense have with larger sprites?
Edit: Does this have to do with the layout requirements for isometric perspective? If so, I think that needs to be introduced earlier. Also, is it actually 30x30, or is it the boundary defined by the volume template below?
| Understanding how Stonesense deals with sprites is central to anyone who wishes to modify the content. The | ||
| scheme is not very complicated, and this guide will give a short introduction to how they work. With the | ||
| exception of floors, which we will discuss later, all sprites are 32x32 pixels big and come in groups known | ||
| as Sprite Sheets. All sprites are loaded and rendered in 32-bit full-color PNGs. The image files should have | ||
| a transparent background but pure magenta (RGB: 255,0,255) is also treated as transparent. |
There was a problem hiding this comment.
I think this section needs an introduction to isometric perspective. otherwise the following examples (especially the "template for the area" example) are hard to follow
|
|
||
| Sprite sheets | ||
| ------------- | ||
| There can be an arbitrary number of sprite sheets configured for Stonesense, though there are 3 sheets that are |
There was a problem hiding this comment.
sprite sheets configured for Stonesense
configured where?
| Sprite sheets | ||
| ------------- | ||
| There can be an arbitrary number of sprite sheets configured for Stonesense, though there are 3 sheets that are | ||
| always present as they contain default sprites (see further down). Most of the content XML files allow users to |
There was a problem hiding this comment.
Most of the content XML files
what are content XML files? This might need its own section to explain
| There can be an arbitrary number of sprite sheets configured for Stonesense, though there are 3 sheets that are | ||
| always present as they contain default sprites (see further down). Most of the content XML files allow users to | ||
| specify sprite sheets, and this is done by adding a file attribute to the content nodes. By convention sprite | ||
| sheets should be placed in their appropriate folder, with creature sprite sheets in the creatures folder etc. |
There was a problem hiding this comment.
| sheets should be placed in their appropriate folder, with creature sprite sheets in the creatures folder etc. | |
| sheets should be placed in the same folder as the XML file that references them. |
There was a problem hiding this comment.
i see your reasoning behind it tho you can put xml and the sheets wherever as long as you can provide a path to them in the xml
|
|
||
| Sprite index | ||
| ------------ | ||
| Sprite Index (sometimes referred to as Sheet Index) is a concept for referring to a specific sprite on a sheet. |
There was a problem hiding this comment.
| Sprite Index (sometimes referred to as Sheet Index) is a concept for referring to a specific sprite on a sheet. | |
| The sprite index, or sheet index, is the zero-indexed offset of a sprite on its sprite sheet. |
No description provided.