ctr_makebanner is a tool for creating BNR (ctr BaNneR model data) and ICN (ctr ICoN data).
BNR and ICN files are created based on the content in BSF files.
BNR files record banner model data and sound data. ICN files record banner headers and 2D icon data.
Note: As of 2010/9/28, there is no way to check banner data embedded in ROM.
Plans call for a way to check this on the HOME menu in future releases.
You will need the following to create BNR and ICN files:
BSF files contain the information required to create BNR and ICN files. They must be created individually for each application.
% ctr_makebanner32 [-d] SPECFILE [BANNERFILE] [ICONFILE]
SPECFILE must be specified. All other options are optional.
| Options | Description |
|---|---|
-d |
Provides detailed output for debugging. |
| BANNERFILE | Specifies a bnr file. If omitted, the output file will have the same basename as the BSF file used as input, but will have a file extension of .bnr instead of .bsf. |
| ICONFILE | Specifies a .icn file. If omitted, the output file will have the same basename as the BSF file used as input, but will have a file extension of .icn instead of .bsf. |
This file contains the settings for the BNR and ICN files to be generated.
It must be described and saved in Unicode (UTF-16LE with BOM).
Notepad in MS Windows 2000, XP, Vista, and 7 supports Unicode. Select Unicode from the Encoding drop-down list when saving the file.
The delimiter between parameter specifications and values is a colon (:). If the same parameter occurs more than once, the one coming last is used.
Parameter specifications must come at the beginning of each line.
All characters after a '#' are treated as a comment.
With the exception of the spaces at the beginning of a line, all spaces are included in the string. If you want to include leading spaces, surround them with quotation marks (""). Likewise, if you want to include quotation marks or sharps (#), surround them with quotation marks ("""/"#").
The BSF file format is shown below.
BigIconFile: # 48x48-pixel icon file name
LittleIconFile: # 24x24-pixel icon file name
ModelFile: # Banner model file name
SoundFile: # Sound file name
MatchMakeGameCode: # Match-making game ID
MatchMakeGameCodeBit: # Match-making game mode bit flag
Region: # Card region
Ulcd: # Stereoscopic vision flag
AgreeEula: # EULA agreement required flag
AutoSave: # Auto save flag
ExBanner: # Extended banner use flag
SaveData: # Save data use flag
ThumbnailFrame: # Banner animation best frame
JPLongName: # ２-line display title name (Japanese)
ENLongName: # ２-line display title name (English)
FRLongName: # ２-line display title name (French)
GELongName: # ２-line display title name (German)
ITLongName: # ２-line display title name (Italian)
SPLongName: # ２-line display title name (Spanish)
CNLongName: # ２-line display title name (Chinese)
KRLongName: # ２-line display title name (Korean)
DULongName: # ２-line display title name (Dutch)
POLongName: # ２-line display title name (Portuguese)
RULongName: # ２-line display title name (Russian)
JPShortName: # １-line display title name (Japanese)
ENShortName: # １-line display title name (English)
FRShortName: # １-line display title name (French)
GEShortName: # １-line display title name (German)
ITShortName: # １-line display title name (Italian)
SPShortName: # １-line display title name (Spanish)
CNShortName: # １-line display title name (Chinese)
KRShortName: # １-line display title name (Korean)
DUShortName: # １-line display title name (Dutch)
POShortName: # １-line display title name (Portuguese)
RUShortName: # １-line display title name (Russian)
JPPublisher: # Publisher name (Japanese)
ENPublisher: # Publisher name (English)
FRPublisher: # Publisher name (French)
GEPublisher: # Publisher name (German)
ITPublisher: # Publisher name (Italian)
SPPublisher: # Publisher name (Spanish)
CNPublisher: # Publisher name (Chinese)
KRPublisher: # Publisher name (Korean)
DUPublisher: # Publisher name (Dutch)
POPublisher: # Publisher name (Portuguese)
RUPublisher: # Publisher name (Russian)
RatingRequired: # Rating flag
CERO: # CERO rating (Japan)
ESRB: # ESRB rating (North America)
USK: # USK rating (Europe)
PEGI_GEN: # PEGI_GEN rating (Europe)
PEGI_PRT: # PEGI_PRT rating (Europe)
PEGI_BBFC: # PEGI_BBFC rating (Europe)
COB: # COB rating (Australia)
Set the values using the following format:
Key Name: Value
Use the following notation for two-line text such as long title names.
Key Name: Value Line 1
Value Line 2
BSF files contain the information required to create BNR and ICN files. They must be created individually for each application.
| Item | Description | Comments |
|---|---|---|
| BigIconFile | A 48x48-pixel icon file name. Specifies an icon file name as a file path. Either a relative or absolute path may be used. Be sure to specify a *.ctpk file (CTR icon package file) containing a 48x48-pixel icon created using TexturePackager included in the CTR-SDK. |
|
| LittleIconFile | A 24x24-pixel icon file name. Specifies an icon file name as a file path. Either a relative or absolute path may be used. Be sure to specify a *.ctpk file (CTR icon package file) containing a 24x24-pixel icon created using TexturePackager included in the CTR-SDK. |
|
| ModelFile | Specifies a banner model file name. Be sure to specify a *.cbmd file created using BannerModelConverter includedi in the CTR-SDK. |
|
| SoundFile | Specifies a sound file name. Do not use this parameter as it is not yet implemented. |
|
| MatchMakeGameCode | Specifies a match-making game ID. Specify as an 8-digit hexadecimal value. A prefix indicating hexadecimal notation (such as 0x or h) is not required. |
|
| MatchMakeGameCodeBit | Represents the match-making game mode big flag. Specify as an 16-digit hexadecimal value. A prefix indicating hexadecimal notation (such as 0x or h) is not required. |
|
| Region | Indicates the card region. The following character strings can be specified. Japan America Europe EuropeAndAustralia AmericaAndAustralia AmericaAndEuropeAndAustralia |
|
| Ulcd | Be sure to specify True for applications that use stereoscopic vision. Specify either True of False. | Default: True |
| AgreeEula | Be sure to specify True for applications requiring a Eula agreement. Specify either True of False. | Default: False |
| AutoSave | Specify True for applications that always auto-save when exiting the application. The warning message that appears when exiting an application from the HOME menu changes depending on this flag. True: "Would you like to close this software? (Data will be saved.)" False: "Would you like to close this software? (Anything not saved will be lost.)" Specify either True of False. |
Default: False |
| ExBanner | Be sure to specify True for applications that use extended banners. Specify either True of False. | Default: False |
| SaveData: | Be sure to specify True for applications that use save data or extended save data. The warning message related to save that appears when exiting an application from the HOME menu is determined based on this flag. Specify either True of False. |
Default: False |
| ThumbnailFrame | Represents a representative frame of the banner animation. Be sure to specify the most representative frame in the banner. Specify as a floating point number. |
|
| JPLongName | Indicates a ２-line display title name in Japanese. Specify using a newline between the two lines. Leading spaces are ignored at this time. For each line, be sure that text fits in a space equivalent to 17 full-width characters of the Japanese code set. Up to 128 characters (including newlines and null terminator) can be used on these two lines. Only use one line if text can fit on one line. |
|
| ENLongName | Indicates a ２-line display title name in English. Everything else is the same as above. | |
| FRLongName | Indicates a ２-line display title name in French. Everything else is the same as above. | |
| GELongName | Indicates a ２-line display title name in German. Everything else is the same as above. | |
| ITLongName | Indicates a ２-line display title name in Italian. Everything else is the same as above. | |
| SPLongName | Indicates a ２-line display title name in Spanish. Everything else is the same as above. | |
| CNLongName | Indicates a ２-line display title name in Chinese. Everything else is the same as above. | |
| KOLongName | Indicates a ２-line display title name in Korean. Everything else is the same as above. | |
| DULongName | Indicates a ２-line display title name in Dutch. Everything else is the same as above. | |
| POLongName | Indicates a ２-line display title name in Portuguese. Everything else is the same as above. | |
| RULongName | Indicates a ２-line display title name in Russian. Everything else is the same as above. | |
| JPShortName | Indicates a １-line display title name in Japanese. Be sure that text fits in a space equivalent to 17 full-width characters of the Japanese code set. Up to 64 characters (including newlines and null terminator) can be used. Either give one of the two lines that is enough to distinguish the title or omit part some of the two lines of text. If you just can't make the short title fit one line, add "..." to the end to indicate the title has been cut off in the middle. |
|
| ENShortName | Indicates a １-line display title name in English. Everything else is the same as above. | |
| FRShortName | Indicates a １-line display title name in French. Everything else is the same as above. | |
| GEShortName | Indicates a １-line display title name in German. Everything else is the same as above. | |
| ITShortName | Indicates a １-line display title name in Italian. Everything else is the same as above. | |
| SPShortName | Indicates a １-line display title name in Spanish. Everything else is the same as above. | |
| CNShortName | Indicates a １-line display title name in Chinese. Everything else is the same as above. | |
| KOShortName | Indicates a １-line display title name in Korean. Everything else is the same as above. | |
| DUShortName | Indicates a １-line display title name in Dutch. Everything else is the same as above. | |
| POShortName | Indicates a １-line display title name in Portuguese. Everything else is the same as above. | |
| RUShortName | Indicates a １-line display title name in Russian. Everything else is the same as above. | |
| JPPublisher | Indicates the Japanese publisher name. Be sure that text fits in a space equivalent to 17 full-width characters of the Japanese code set. Up to 64 characters (including newlines and null terminator) can be used. |
|
| ENPublisher | Indicates the English publisher name. Everything else is the same as above. | |
| FRPublisher | Indicates the French publisher name. Everything else is the same as above. | |
| GEPublisher | Indicates the German publisher name. Everything else is the same as above. | |
| ITPublisher | Indicates the Italian publisher name. Everything else is the same as above. | |
| SPPublisher | Indicates the Spanish publisher name. Everything else is the same as above. | |
| CNPublisher | Indicates the Chinese publisher name. Everything else is the same as above. | |
| KOPublisher | Indicates the Korean publisher name. Everything else is the same as above. | |
| DUPublisher | Indicates the Dutch publisher name. Everything else is the same as above. | |
| POPublisher | Indicates the Portuguese publisher name. Everything else is the same as above. | |
| RUPublisher | Indicates the Russian publisher name. Everything else is the same as above. | |
| RatingRequired | Specifies whether a rating must be obtained for the application. Specify True for almost all applications. If FALSE is specified, no ratings can be set from any rating organization. |
Default: True |
| CERO | Sets the CERO rating (Japan). Specify as a numeric value. 0 A (all ages) 12 B (age 12 and up) 15 C (age 15 and up) 17 D (age 17 and up) 18 Z (age 18 and up)PENDING: Under review |
|
| ESRB | Sets the ESRB rating (North America). Specify as a numeric value. 3 EARLY CHILDHOOD (EC, all ages) 6 EVELYONE (E, age 6 and up) 10 EVERYONE10+ (E10+, age 10 and up) 13 TEEN (T, age 13 and up) 17 MATURE (M, age 17 and up)PENDING: Under review |
|
| USK | Sets the USK rating (Europe). Specify as a numeric value. 0 No age restriction 6 age 6 and up 12 age 12 and up 16 age 16 and up 18 Inapproriate for minorsPENDING: Under review |
|
| PEGI_GEN | Sets the PEGI_GEN rating (Europe). Specify as a numeric value. 3 age 3 an up 7 age 7 and up 12 age 12 and up 16 age 16 and up 18 age 18 and upPENDING: Under review |
|
| PEGI_PRT | Sets the PEGI_PRT rating (Europe). Specify as a numeric value. 4 age 4 an up 6 age 6 and up 12 age 12 and up 16 age 16 and up 18 age 18 and upPENDING: Under review |
|
| PEGI_BBFC | Sets the PEGI_BBFC rating (Europe). Specify as a numeric value. 3 age 3 and up 4 U, Uc (recommended for age 4 and up) 7 age 7 and up 8 PG (recommended for age 8 and up) 12 age 12 and up 15 age 16 and up 16 age 16 and up 18 age 18 and upPENDING: Under review |
|
| COB | Sets the COB rating (Australia). Specify as a numeric value. 0: G (General, no age specified) 7: PG (Parental guidance recommended, no age specified) 14:M (Recommended for adults, no age specified) 15: MA15+ (Unsuitable for 15 years and younger, consent or a parent or guardian required for 15 years or younger) PENDING: Under review |
The following 7374 chyaracters can be used in title names and publisher names in the Japanese, American, European and Australian regions.
(Some characters may not display correctly depending on your browser.)
Refer to Build Rules (ctr_makebanner) for more information about variables defined within the OMakefile.
CONFIDENTIAL