sctoolsdata
A collection of StarCraft internal data used to help process replay and map files.
Usage
This library is available via npm:
npm i --save sctoolsdata
TODO: explain more about how this is used.
Reference
Function:
framesToMs(frames[, speed])Parameters:
framesnumber
number of in-game frames per secondspeedstring (default: "fastest")
game speed (virtually always "fastest")
Returns:
- number
the number of milliseconds representing the duration of the game frames
Used to get timestamps of game events for a given game speed. For example, this can be used to display a timestamp for a chat message, or to show the duration of a game.
Function:
getSwatchFromSlotID(id)Parameters:
idnumber
slot ID to return the color for
Returns:
- string
swatch name for the color associated with that player slot ID
Every player ID has a default color; for example, player 1 is red, player 2 is blue, etc. This function is used to return the color swatch name associated with a given ID.
Function:
getColorFromSwatch(swatch[, returnType])Parameters:
swatchstring
swatch name to return the color value forreturnTypestring<"hex" | "int"> (default: "hex")
type of value to return; either a hex string or a number
Returns:
- string | number
the color value of the given swatch name
This function can be used to get the actual colors to be displayed for a given swatch (e.g. "paleBlue" will return "#b8b8e8").
TODO.
In-game colors
Colors work quite inconsistently in StarCraft. There are two sets of color codes: one for briefing messages (and map names), and one for in-game chat messages. These each have their quirks that can be different between Brood War (v1.16.1 and below) and Remastered.
Here's a list of all colors:
| Briefing text colors | |||||
|---|---|---|---|---|---|
| Name | Hex value | Code | Slug | ||
| Pale blue |  | #a4b4f8 | 0x02 | briefingPaleBlue | |
| Green |  | #4cc428 | 0x03 | briefingGreen | |
| Light green |  | #b4fc74 | 0x04 | briefingLightGreen | |
| Gray† |  | #585858 | 0x05 | briefingGray | |
| White |  | #ffffff | 0x06 | briefingWhite | |
| Red |  | #fc0000 | 0x07 | briefingRed | |
| In-game text colors | |||||
| Name/slot ID‡ | Hex value | Code | Slug | ||
| Pale blue |  | #b8b8e8 | 0x02 | ingamePaleBlue | |
| Yellow |  | #dcdc3c | 0x03 | ingameYellow | |
| White |  | #ffffff | 0x04 | ingameWhite | |
| Red |  | #c81818 | 0x06 | ingameRed | |
| Green |  | #10fc18 | 0x07 | ingameGreen | |
| Gray† |  | #847474 | 0x05 | ingameGray | |
| Red | 0 |  | #f40404 | 0x08 | playerRed |
| Blue | 1 |  | #0c48cc | 0x0e | playerBlue |
| Teal | 2 |  | #2cb494 | 0x0f | playerTeal |
| Purple | 3 |  | #88409c | 0x10 | playerPurple |
| Orange | 4 |  | #f88c14 | 0x11 | playerOrange |
| Brown | 5 |  | #703014 | 0x15 | playerBrown |
| White | 6 |  | #cce0d0 | 0x16 | playerWhite |
| Yellow | 7 |  | #fcfc38 | 0x17 | playerYellow |
| Green | 8 |  | #088008 | 0x18 | playerGreen |
| Pale yellow | 9 |  | #fcfc7c | 0x19 | playerPaleYellow |
| Tan | 10 |  | #ecc4b0 | 0x1b | playerTan |
| Cerulean | 11 |  | #4068d4 | 0x1c | playerCerulean |
| Pale green | 12 |  | #74a47c | 0x1d | playerPaleGreen |
| Bluish gray | 13 |  | #9090b8 | 0x1e | playerBluishGray |
| Turquoise | 15 |  | #00e4fc | 0x1f | playerTurquoise |
| Pink | 16 |  | #ffc4e4 | – | playerPink |
| Olive | 17 |  | #787800 | – | playerOlive |
| Lime | 18 |  | #d2f53c | – | playerLime |
| Navy | 19 |  | #0000e6 | – | playerNavy |
| Magenta | 21 |  | #f032e6 | – | playerMagenta |
| Gray | 22 |  | #808080 | – | playerGray |
| Black | 23 |  | #3c3c3c | – | playerBlack |
†: In StarCraft, gray is buggy: when it's used in a map name in Brood War, the rest of the name becomes gray as well—this was fixed in Remastered. In in-game text messages, gray will take over the entire rest of the line, both in Brood War and Remastered. This buggy behavior is not completely implemented in this library, and more research is needed to determine every edge case.
‡: Slot IDs 11, 14, 15 and 20 are not selectable as player colors (the color for 11 is used for the neutral player, however). 11 and 15 are still usable as text color. 14 and 20 are duplicates of Pale Yellow and Cerulean.
A few of the player colors are unavailable on certain tilesets:
| Tileset name | ID | Disallowed colors | |
|---|---|---|---|
| Ash World |  |
3 | Gray, Black |
| Badlands |  |
0 | – |
| Desert |  |
5 | Orange |
| Ice |  |
6 | White |
| Installation |  |
2 | Blue, Navy, Bluish gray |
| Jungle World |  |
4 | – |
| Space Platform |  |
1 | Gray, Black |
| Twilight |  |
7 | Bluish gray |
Game speed
Number of milliseconds per game frame for each game speed.
E.g. for "Fastest", there are approximately 1000 / 42 = ~23.81 frames in a second. This is used to convert the number of game frames into real time.
| Name | ㎳/frame | Frames/second | % of "Fastest" |
|---|---|---|---|
| Fastest | 42 | 23.810 | 100.0% |
| Faster | 48 | 20.833 | 87.5% |
| Fast | 56 | 17.857 | 75.0% |
| Normal | 67 | 14.925 | 62.7% |
| Slow | 83 | 12.048 | 50.6% |
| Slower | 111 | 9.009 | 37.8% |
| Slowest | 167 | 5.988 | 25.1% |
By far most replays use "Fastest" as the speed, but this map can be used for the rare case that isn't. In the very old days of StarCraft, the ladder speed setting was "Fast" by default, but this got changed to "Fastest" relatively early on.
License
MIT license