4
edits
Changes
mLine 1:
Line 1: − + − − == Software == − − [[CiTRUS]] - (GUI)(Windows Only) Generating ICN files − − [https://github.com/ps3hen/ctr_toolchain/tree/master/make_banner make_banner] - (CMD)(Windows/Linux) Generating ICN files − − [[3DSExplorer]] - (GUI)(Windows Only) Reading ICN files Line 23:
Line 15: − + + + + + Line 65:
Line 61: − + Line 75:
Line 71: − + + Line 104:
Line 101: − + + + + + + + + + Line 164:
Line 169: − + − + − + − + Line 184:
Line 189: − + − + − These are generated by converting the age rating(decimal) to a hex value and then adding it to '0x80'. For example if '7 years' was the rating, then the flag would be 0x87.+ + − + − + − |- − | All Regions (No region restrictions) − | 7F FF FF FF − + − + − + + + + + + + − + − + − |- − | China − | 00 00 00 50 + + Line 244:
Line 252: − These are a collection of bit-mask flags.+ − + − + + + + + + + + + + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + + + + + + + + + + + + − + − + + − + + − + − | 0x02+ − |-+ − | Allow use of 3D? (For use with parental Controls. An application can use the 3D affect, even when this flag isn't set) − − |- − − | 0x08 − |- − | Autosave on exit? − | 0x10 − |- − | Uses an [[Extended Banner]]? − | 0x20 − |- − | [[SMDH#Region Specific Game Age Ratings|Region game rating]] required? − | 0x40 − |- − | Uses save data? − | 0x80 − − For example, if we wanted an application to use the 3D effect, autosave on exit and use save data. The combined flag would be 0x95: (0x01 | 0x04 | 0x10 | 0x80) − Purpose of this flag: If using an animated BNR, it's the most representative frame for the animation.+ − − This value is generated by taking an input value(default BNR frame) as a float, then representing it a hexadecimal array. Line 353:
Line 362: − + − − There's a header of 0x40 bytes and then comes the raw data. Line 416:
Line 423: + + + + + +
→Application Titles: Grammar fix: space before opening parenthesis
This page describes the format of the icon stored at [[NCCH#CXI|CXI]] ExeFS:/icon and [[CIA]] icons.
This page describes the format of the icon stored at [[NCCH#CXI|CXI]] ExeFS:/icon and [[CIA]] icons.
The size of icons is 0x36c0 bytes. The CXI icon is displayed by [[Home Menu]] and [[System Settings]](3DS Software Management), while [[CIA#Meta|CIA icons]] are dummies and not yet utilised by Dev 3DS' (as of rev 47586).
The size of icons are 0x36c0 bytes. The CXI icon is displayed by [[Home Menu]] and [[System Settings]](3DS Software Management), while [[CIA#Meta|CIA icons]] are dummies and not yet utilised by Dev 3DS' (as of rev 47586).
== Format ==
== Format ==
|-
|-
| 0x04
| 0x04
| 0x04
| 0x02
| Version
|-
| 0x06
| 0x02
| Reserved
| Reserved
|-
|-
All encoded in UTF-16.
All encoded in UTF-16.
There are 16 app title structs(currently only 11 are used), each one for separate languages.
There are 16 app title structs (currently only 12 are used), each one for separate languages.
The languages by order of appearance:
The languages by order of appearance:
* 5th: Italian title name
* 5th: Italian title name
* 6th: Spanish title name
* 6th: Spanish title name
* 7th: Chinese title name
* 7th: Simplified Chinese title name
* 8th: Korean title name
* 8th: Korean title name
* 9th: Dutch title name
* 9th: Dutch title name
* 10th: Portuguese title name
* 10th: Portuguese title name
* 11th: Russian title name
* 11th: Russian title name
* 12th: Traditional Chinese title name
== Application Settings ==
== Application Settings ==
|-
|-
| 0x2028
| 0x2028
| 0x8
| 0x4
| Flags
| Flags
|-
| 0x202C
| 0x2
| EULA Version
|-
| 0x202E
| 0x2
| Reserved
|-
|-
| 0x2030
| 0x2030
| 0x2011
| 0x2011
| 0x1
| 0x1
| Reserved For Future Use
| GRB (South Korea)
|-
|-
| 0x2012
| 0x2012
| 0x1
| 0x1
| Reserved
| CGSRR (Taiwan)
|-
|-
| 0x2013
| 0x2013
| 0x1
| 0x1
| Reserved For Future Use
| Reserved
|-
|-
| 0x2014
| 0x2014
| 0x1
| 0x1
| Reserved For Future Use
| Reserved
|-
|-
| 0x2015
| 0x2015
| 0x2016
| 0x2016
| 0x1
| 0x1
| Reserved For Future Use
| Reserved
|-
|-
| 0x2017
| 0x2017
| 0x1
| 0x1
| Reserved For Future Use
| Reserved
|}
|}
Active ratings have a bitmask of 0x80, and inactive ratings have no bitmask at all. Ratings without the 0x80 bitmask are ignored. 0x40 bitmask indicates Rating Pending. 0x20 bitmask indicates No Age Restriction.
Age limits are set by adding the minimal age to 0x80 (for example, limiting to 12 years and up would give a bitmask of 0x8C)
=== Region Lockout ===
=== Region Lockout ===
This flag is what the Home Menu uses in order to determine the [[Home Menu#Region Lockout|Region Lockout]] of a title. This exists inside the ICN data as little endian. (In the table below they are presented in big endian)
This u32 flag is what the Home Menu uses to determine the [[Home Menu#Region Lockout|Region Lockout]] of a title.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! REGION
! REGION
! VALUE
! BITMASK
|-
|-
| Japan
| Japan
| 00 00 00 01
| 0x01
|-
|-
| North America
| North America
| 00 00 00 02
| 0x02
|-
|-
| Europe
| Europe
| 00 00 00 0C
| 0x04
|-
| Australia
| 0x08
|-
| China
| 0x10
|-
|-
| Korea
| Korea
| 00 00 00 20
| 0x20
|-
|-
| Taiwan
| Taiwan
| 00 00 00 40
| 0x40
|}
|}
Regions are 'included' in region lock by setting their bitmask value. Nintendo defines region free as 0x7fffffff. Early in the 3DS' development, Nintendo grouped the Australian and Europe markets together. Nintendo defines market Europe as having the combined bitmasks of Europe and Australia. No 3DS' which check the Australia bitmask have been seen (Australia uses the European 3DS model).
=== Match Maker IDs ===
=== Match Maker IDs ===
=== Flags ===
=== Flags ===
The u32 is used for storing flags as bit-masks.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! INDEX
! FLAG
! DESCRIPTION
! BITMASK VALUE
|-
| Visibility Flag (Required for visibility on the Home Menu)
| 0x0001
|-
| [[Home Menu#Auto-Boot_Function|Auto-boot]] this gamecard title
| 0x0002
|-
| Allow use of 3D? (For use with parental Controls. An application can use the 3D affect, even when this flag isn't set)
| 0x0004
|-
|-
| 0
| Require accepting CTR EULA before being launched by Home (see below)
| See Table Below
| 0x0008
|-
|-
| 1
| Autosave on exit? (see below)
| Unknown - Usually 0x01(Some Dev Apps have this set to 0x00)
| 0x0010
|-
|-
| 2
| Uses an [[Extended Banner]]?
| Unknown/Unused
| 0x0020
|-
|-
| 3
| [[SMDH#Region Specific Game Age Ratings|Region game rating]] required
| Unknown/Unused
| 0x0040
|-
|-
| 4
| Uses save data? (see below)
| Unknown/Unused
| 0x0080
|-
|-
| 5
| Application usage is to be recorded. If this is not set, it causes the application's usage to be omitted from the Home Menu's [[Home_Menu#Cache.dat & CacheD.dat|icon cache]], as well as in [[????????|other places]].
| Unknown - Usually 0x01
| 0x0100
|-
|-
| 6
| Disables [[SD Savedata Backups]] for this title. This is in addition to [[NS CFA|the blacklist]].
| Unknown/Unused
| 0x0400
|-
|-
| 7
| New 3DS exclusive title. Shows an error if used on Old 3DS.
| Unknown/Unused
| 0x1000
|}
|}
==== Byte[0] ====
====Effect of SaveData and AutoSave====
These options have no effect on the performance of the application itself: they're used to select an appropriate warning when closing an application from [[Home Menu|Home]].
* Both off: "Closing software" (no warning if quitting directly with X)
* SaveData: "Do you want to close [...]? (Unsaved data will be lost.)"
* AutoSave: ?
* Both on: "Saving data and closing software..." (no warning if quitting directly with X)
=== EULA Version ===
This is the EULA version which is checked when the Accept EULA flag is set, the version is compared to one stored in the 3DS. If the SMDH version is greater, then the user will be prompted to accept the EULA.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! FLAG
! START
! BITMASK VALUE
! SIZE
! DESCRIPTION
|-
|-
| Visibility Flag (always present)
| 0x202C
| 0x01
| 0x01
| EULA Version Minor
|-
|-
| [[Home Menu#Auto-Boot Kiosk Function|Auto-boot]] this title? (Game Card titles only?)
| 0x202D
| 0x01
| EULA Version Major
| 0x04
| Require accepting CTR EULA?
|}
|}
=== 'Optimal Animation Default Frame' (for BNR) ===
=== 'Optimal Animation Default Frame' (for BNR) ===
This is a float, indicating the preferred (or 'most representative') frame for the banner animation.
=== CEC (StreetPass) ID ===
=== CEC (StreetPass) ID ===
* ETC1A4
* ETC1A4
This does not necessarily mean the other encodings will be used, it is just that those are the options when compiling. Like we've seen with Super Mario 3D Land Nintendo has changed save file encryption, and likewise they can encode icons and banners differently ''should they choose to''. Currently we've seen just RGB565 so don't be fooled if an icon doesn't show up right! It is probably one of these formats above. Although we will probably not see other formats used for a while it's nice to know they have an opportunity to change.
This does not necessarily mean the other encodings will be used, it is just that those are the options when compiling. Like we've seen with Super Mario 3D Land Nintendo has changed save file encryption, and likewise they can encode icons and banners differently ''should they choose to''. Currently we've seen just RGB565 so don't be fooled if an icon doesn't show up right! It is probably one of these formats above. Although we will probably not see other formats used for a while it's nice to know they have an opportunity to change. Also note that it seems Nintendo stores each pixel in [https://en.wikipedia.org/wiki/RGBA_color_space word-order], so the actual order of order of each color channel in memory will depend on the endianness.
The data is encoded in tiles (starting from size 8x8, continuing recursively).
The data is encoded in tiles (starting from size 8x8, continuing recursively).
|-
|-
|}
|}
== Tools ==
[[CiTRUS]] - (GUI)(Windows Only) Generating ICN files
[[3DSExplorer]] - (GUI)(Windows Only) Parsing ICN files