Leahnaya/sprites
1
0
Fork 0
mirror of https://github.com/smogon/sprites.git synced 2026-07-04 17:54:08 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rename -- to -, - to ~ (deploy, README)

Browse Source
This commit is contained in:
Christopher Monsanto 2020-05-07 18:07:15 -04:00
parent ce77e17d71
commit 5737d672a3
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -93,7 +93,7 @@ CONFIG_DEFAULT_DEFLOPT=true
Pokemon sprite filenames are in a 1-to-1 correspondence with the Pokemon's name, for ease of processing. Filenames may be directly substituted in shell commands without escaping. This naming scheme means that some of the filenames in `src/` are a little awkward looking to humans, but it means that no additional data beyond what is encoded in the filesystem is required to determine the correct name for any given Pokémon.
- Filenames must conform to the POSIX portable filename character set, `[0-9a-zA-Z-._]`. To ensure this, we encode filenames according to the following rules. Characters in `[0-9a-zA-Z-.]` are left as-is. Spaces are converted to an underscore. Other characters are escaped using two underscores and four hex characters, similar to JavaScript Unicode escapes. (example: `Flabébé` -> `Flabe__0301be__0301`)
- Filenames must conform to the POSIX portable filename character set plus tilde, `[0-9a-zA-Z-._~]`. To ensure this, we encode filenames according to the following rules. Characters in `[0-9a-zA-Z-.~]` are left as-is. Spaces are converted to an underscore. Other characters are escaped using two underscores and four hex characters, similar to JavaScript Unicode escapes. (example: `Flabébé` -> `Flabe__0301be__0301`)
The following JS functions may be useful:
```javascript
@ -106,9 +106,9 @@ Pokemon sprite filenames are in a 1-to-1 correspondence with the Pokemon's name,
}
```
- Formes are separated with two dashes from their base. (example: `Necrozma--Dawn-Wings`)
- Pokemon filenames are of the form `<pokedex #>-<forme #>-<base name>-<forme name>`. Each component has `-` escaped as `~`. (example: `0006-001-Charizard-Mega~X`)
- Cosmetic female formes are `--Female` instead of `--F`, so that you may distinguish it from Unown.
- Cosmetic female formes are `-Female` instead of `-F`, so that you may distinguish it from Unown.
## Gotchas

3
tools/deploy/util.js
View File

@ -4,7 +4,7 @@ export function decode(s) {
}
export function decomposeName(name) {
const [num, formeNum, base, forme=null] = name.split("--");
const [num, formeNum, base, forme=null] = name.split("-").map(s => s.replace(/~/g, "-"));
return {num: parseInt(num, 10), formeNum: parseInt(formeNum, 10), base, forme};
}
@ -26,7 +26,6 @@ export function toPSSpriteID(name) {
export function toSmogonAlias(name) {
return name.toLowerCase().
replace("--", "-").
replace(/[ _]+/, "-").
replace(/[^a-z0-9-]+/g, '');
}