3dbrew - User contributions [en]

Setting up Development Environment

2016-11-28T16:50:20Z

Thejsa: /* Windows */

= Setup =
* Install [http://devkitpro.org/ devkitARM]. If it's already installed, update it.
** On Windows, there's a [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ graphical installer].
** On Unix-like platforms such as Linux/macOS, there's a [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitARMupdate.pl/download Perl script]. Make sure you also select libctru and the 3ds examples when installing.
* Depending on the kind of homebrew you want to develop, you may be interested in installing and using additional libraries and tools which don't ship alongside devkitARM/libctru. A list of them can be found in [[Homebrew Libraries and Tools]].

==Windows==
devkitPro provides Win32-native precompiled versions of devkitARM which can be run directly on Windows.
* [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ download the latest version of the graphical installer] from SourceForge and run it, following the instructions as you go.
* An Internet connection is required.
* You will want to make sure devkitARM is selected during the installation process to develop for the 3DS (and also the DS and GBA) - you can also install devkitPPC (for GameCube/Wii development) and devkitPSP (for PlayStation Portable development) if you wish.
* Once the installer has finished, launch MSYS from:
** Windows 7 and earlier: Start -> All Programs -> devkitPro -> MSYS
** Windows 8 and 8.1: Right click on the Start screen and select 'All Apps'. You should find MSYS there.
** Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
** Windows 10 (post-Anniversary Update): Start -> devkitPro -> MSYS

Alternatively starting with Windows 10 Anniversary Update (Version 1607), the [https://msdn.microsoft.com/en-us/commandline/wsl/install_guide Windows Subsystem for Linux (WSL)] may also be used to run the Linux version of devkitARM. Due to the fact that GCC was originally designed for Unix-like platforms its use may yield performance and convenience improvements. For instructions on how to set up devkitARM under WSL refer to the ''Unix-like platforms'' section. For WSL installation instructions, see the linked MSDN page.

==Unix-like platforms==
Currently devkitPro provides precompiled versions of devkitARM for the following Unix-like platforms: Linux (x86/x64), macOS (universal binary). Note that Linux x64 binaries are usable under WSL.

* First, you need to install curl so the installer can download the devkitARM packages, and you should also install Git - you'll need it to update ctrulib or share your code on GitHub, among many other things.

* Find your way into a shell (eg. by opening a Terminal window), and follow the instructions for your OS:
** Debian/Ubuntu/Linux Mint/WSL: <code>sudo apt-get install git curl</code>
** Fedora/CentOS/RHEL: <code>sudo yum install git curl</code>
** openSUSE: <code>sudo zypper install git curl</code>
** macOS: Download Git from [http://git-scm.com/download/mac] and install it. Curl is included with the OS.

* Next, we need to download, make executable and run the devkitARM updater (don't worry, the updater is also the installer.)
<pre>
curl -L https://raw.githubusercontent.com/devkitPro/installer/master/perl/devkitARMupdate.pl -o devkitARMupdate.pl
chmod +x ./devkitARMupdate.pl
sudo ./devkitARMupdate.pl /opt/devkitpro
</pre>

* Finally, we need to tell your shell where to find the devkitARM binaries.
<pre>
echo "export DEVKITPRO=/opt/devkitpro" >> ~/.bashrc
echo "export DEVKITARM=/opt/devkitpro/devkitARM" >> ~/.bashrc
echo "export PATH=$PATH:/opt/devkitpro/devkitARM/bin" >> ~/.bashrc
source ~/.bashrc
</pre>

= Building the examples =
3DS examples are still being created; however, there are a growing number of examples available from the [https://github.com/devkitPro/3ds-examples devkitPro/3ds-examples GitHub repository].
There are now too many to list here in detail, so go ahead and browse them.

* To download these, if you installed Git (as you will have if you followed the above instructions), simply type <code>git clone https://github.com/devkitPro/3ds-examples.git</code> into your shell in the directory you wish to store the 3ds-examples folder in.
** To overwrite the (almost certainly outdated) examples installed by the devkitPro updater, type <code>git clone https://github.com/devkitPro/3ds-examples.git $DEVKITPRO/examples/3ds</code>.

These can be built from the command line.

To start a new homebrew project from the <code>bash</code> shell, simply type the following (replacing <code>'''~/projects/my3dsproject'''</code> with the place you would like your project to be stored, with <code>~</code> meaning your HOME directory):
cp -r $DEVKITPRO/examples/3ds/templates/application '''~/projects/my3dsproject'''
cd '''~/projects/my3dsproject'''

To compile it, type <code>make</code> in the project directory.
To run it on your 3DS, start the Homebrew Launcher, press Y to open the network loader, then on your PC type: <code>$DEVKITARM/bin/3dslink -a '''192.168.X.X''' '''my3dsproject'''.3dsx</code>, replacing '''192.168.X.X''' with your 3DS's IP address (displayed in the network loader screen) and '''my3dsproject''' with the name of the folder your project is in (ie. the folder you have the source folder in and the README file.)
Don't type the full path, just the last segment - eg. for <code>C:\a\b\'''verygood3dsapp'''</code>, you would type <code>'''verygood3dsapp'''.3dsx</code>.

If all goes well, you'll soon see your application running on your 3DS.

==Building the examples on Linux with Netbeans==
* Go to File->New Project...
* Select C/C++ Project with existing code
* Navigate to the examples directory and select the folder for the project you want to build; eg. /home/vtsingaras/3ds/examples/app_launch
* Leave Configuration Mode to 'Automatic' and click 'Finish'.
* It will fail to build. Now edit Makefile and insert these two lines, adjusting for your devkitpro path, at the top:
<pre>export DEVKITPRO=/opt/devkitpro
export DEVKITARM=/opt/devkitpro/devkitARM</pre>
* Right-click the project and go to Properties->Code Assistance and click C Compiler.
* In include directories enter
<pre>/opt/devkitpro/devkitARM/include;/opt/devkitpro/ctrulib/libctru/include</pre>
adjusting again for your devkitPro path.
* Do the same for 'C++ Compiler'.
* Go to 'Run' and click 'Clean and Build Project'.
* Now right-click on the project and select Code Assistance->Reparse Project.

Now you can use Netbeans' code completion feature and build your project from the Run menu.

= Building homebrew for distribution =
To build your homebrew, open a Bash shell as described above, browse to the folder of the homebrew you wish to compile, and run <code>make</code>.

* This will build a .elf file and a .3dsx file (the homebrew executable itself) together with a .smdh file (the icon).
** The Homebrew Launcher can only run homebrew in the 3DSX format, and can only display SMDH icons.

* To build a CCI (.3ds) file, you need to strip the .elf file and use makerom on it (with the provided RSF file):
arm-none-eabi-strip '''[ELF file]'''
makerom -f cci -o '''[.3ds file]''' -rsf '''[RSF file]''' -target t -exefslogo -elf '''[ELF file]''' -icon '''[icon file]''' -banner '''[banner file]'''

= Troubleshooting =
'''I get the "Please set DEVKITARM in your environment." error.'''

Use the following command before installing [http://askubuntu.com/questions/573070/problem-setting-up-environment-for-make-command-execution]:
sudo chown $USER /opt/devkitpro/ -R
echo "export DEVKITPRO="/opt/devkitpro/" >> ~/.profile
echo "export DEVKITARM="/opt/devkitpro/devkitARM/" >> ~/.profile
source ~/.profile
For WSL users, you need to close the Bash shell, then reopen it for WSL to reload all of the variables from a clean state.

'''Unable to load source code when debugging using the provided GDB. It says, "No source files available".'''

When after loading your ELF file, make sure to set a breakpoint at main(), then continue. The GDB will refresh with your source code.

NFC Services

2016-09-19T18:11:49Z

Thejsa: /* NFC service "nfc:p" */

The New3DS NFC module was added with [[8.1.0-0_New3DS]]. The Old3DS NFC module was added with [[9.3.0-21|9.3.0-X]].

On New3DS NFC module uses the [[I2C_Registers|NFC]] hardware via the [[I2C_Services|i2c::NFC]] and [[GPIO_Services|gpio:NFC]] services. On Old3DS NFC module communicates with a NFC peripheral via IR with the IRUSER service.

A total of 6 sessions can be open simultaneously for all of these services combined.

=NFC services=
==NFC user service "nfc:u"==
This is the NFC service used by regular applications, for the NFP API.

This was first seen in the Super Smash Bros eShop demo (only in the exheader, the demo doesn't actually use it), but at that time no system-module was available for NFC on CDN. The first regular application to use this service was Super Smash Bros, with the v1.0.5 game-update, which used the new 9.3.0-X command set.

==NFC management service "nfc:m"==
{| class="wikitable" border="1"
|-
! Command Header
! Available since system-version
! Name
! Input
! Output
! Notes
|-
| 0x040100C2
| Unknown, <[[9.3.0-21|9.3.0-X]]
| ???
| u32 unknownA, u32 unknownB, u32 unknownC, u32 (sizeof(*buffer) << 14 <nowiki>|</nowiki> 0x402), void * buffer
| s32 result
|
|-
| 0x04020000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result, u32 unknownA[16]
| Output seems to be a struct
|-
| 0x04030000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result, u32 unknownA[41]
|
|-
| 0x04040A40
| [[9.3.0-21|9.3.0-X]]
| [[NFCM:SetAmiiboSettings|SetAmiiboSettings]]
|
|
|
|-
| 0x04060000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result
|
|-
| 0x04070000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result, u32 unknownA
|
|-
| 0x04080000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result, u32 unknownA
|
|-
| 0x040C0000
| [[9.3.0-21|9.3.0-X]]
| ?
| None
| s32 result
| Among other things, this will eventually call the savedata writing code referenced in the below savedata section.
|-
| 0x040D0000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result
|
|-
| 0x040E0000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result, u32 unknownA, u32 unknownB
| Again, amiibo applet ignores value unknownA.
|-
| 0x040F0000
| [[9.3.0-21|9.3.0-X]]
| ???
| void
| s32 result, u32 unknownA, u32 unknownB
|
|}

This is used by the [[amiibo Settings]] applet. This service has the above commands, in addition to the command-set listed below.

==NFC development service "nfc:dev"==
This service seems to be intended for use only on dev-units(or at least some of the command(s)).

Unlike the New3DS NFC-module, at least some of these commands are stubbed in the Old3DS NFC-module(only returns an error).

==NFC service "nfc:p"==
This service is used by the mint library-applet, starting with [[9.3.0-21]]. This service was added to the mint service-access-control list with [[9.0.0-20]].
Presumably used for NFC card payments in JPN [[eShop]].

==NFC service "nfc:r"==
This service has no known use.

==NFC service "nfc:s"==
{| class="wikitable" border="1"
|-
! Command header
! Available since system-version
! Description
|-
| 0x00230000
|
| This writes the following command request data to [[I2C_Registers|I2C]], without reading any response: 10 20 00 01 01.
|-
| 0x00240000
|
| This writes the following command request data to [[I2C_Registers|I2C]], without reading any response: 10 40 00 03 00 0F 01.
|}

This service has no known use.

Unlike the New3DS NFC-module, at least some of these commands are stubbed in the Old3DS NFC-module(only returns an error).

="nfc:u" and "nfc:m" command set=
There are at least two different revisions of the NFC module. First version was introduced on New3DS only with firmware [[8.1.0-0_New3DS]]. Second version made its appearance with [[9.3.0-21|9.3.0-X]], on both Old3DS and New3DS.

These two versions are not interchangeable and not compatible, since the newer version uses a different command set and has no implemented commands from the older version. This does not introduce compatibility problems since no retail software used the NFC module, before the system titles added with [[9.3.0-21]] which use NFC.

==9.3.0-X==
{| class="wikitable" border="1"
|-
! Command Header
! Available since system-version
! Name
! Input
! Output
! Notes
|-
| 0x00010040
|
| [[NFC:Initialize|Initialize]]
| u8 inputval
| s32 result
|
|-
| 0x00020040
|
| [[NFC:Shutdown|Shutdown]]
| u8 inputval
| s32 result
|
|-
| 0x00030000
|
| [[NFC:StartCommunication|StartCommunication]]
| void
| s32 result
|
|-
| 0x00040000
|
| [[NFC:StopCommunication|StopCommunication]]
| void
| s32 result
|
|-
| 0x00050040
|
| [[NFC:StartTagScanning|StartTagScanning]]
| u16 inval
| s32 result
|
|-
| 0x00060000
|
| [[NFC:StopTagScanning|StopTagScanning]]
| void
| s32 result
|
|-
| 0x00070000
|
| [[NFC:LoadAmiiboData|LoadAmiiboData]]
|
|
|
|-
| 0x00080000
|
| [[NFC:ResetTagScanState|ResetTagScanState]]
|
|
|
|-
| 0x00090002
|
| [[NFC:UpdateStoredAmiiboData|UpdateStoredAmiiboData]]
|
|
|
|-
| 0x000A0000
|
| ???
| void
| s32 result
|
|-
| 0x000B0000
|
| ???
| void
| s32 result, u32 unknownA, u32 unknownB
| amiibo applet ignores value unknownA. It doesn't even read it from the command buffer.
|-
| 0x000C0000
|
| ???
| void
| s32 result, u32 unknownA, u32 unknownB
| amiibo applet also ignores value unknownA for this command.
|-
| 0x000D0000
|
| [[NFC:GetTagState|GetTagState]]
| void
| s32 result, u8 outval
|
|-
| 0x000F0000
|
| [[NFC:CommunicationGetStatus|CommunicationGetStatus]]
|
|
|
|-
| 0x00100000
|
| ???
| void
| s32 result, u32 unknownA[24]
|
|-
| 0x00110000
|
| [[NFC:GetTagInfo|GetTagInfo]]
|
|
|
|-
| 0x00120000
|
| [[NFC:CommunicationGetResult|CommunicationGetResult]]
|
|
|
|-
| 0x00130040
|
| [[NFC:OpenAppData|OpenAppData]]
|
|
|
|-
| 0x00140384
|
| [[NFC:InitializeWriteAppData|InitializeWriteAppData]]
|
|
|
|-
| 0x00150040
|
| [[NFC:ReadAppData|ReadAppData]]
|
|
|
|-
| 0x00160242
|
| [[NFC:WriteAppData|WriteAppData]]
|
|
|
|-
| 0x00170000
|
| [[NFC:GetAmiiboSettings|GetAmiiboSettings]]
|
|
|
|-
| 0x00180000
|
| [[NFC:GetAmiiboConfig|GetAmiiboConfig]]
|
|
|
|-
| 0x00190000
|
| [[NFC:GetAppDataInitStruct|GetAppDataInitStruct]]
|
|
|
|-
| 0x001A0000
|
|
| None
| No additional output.
|
|-
| 0x001B0000
|
|
| None
| 0x36-byte output structure starting at cmdreply[2].
|
|-
| 0x001C0040
| [[9.6.0-24|9.6.0-X]]
|
| u8 inputval
| No additional output.
| ?
|-
| 0x001D0040
| [[9.6.0-24|9.6.0-X]]
|
| u32 inputval
| No additional output.
| ?
|-
| 0x001E0040
| [[9.6.0-24|9.6.0-X]]
|
| u8 inputval
| u8 outval at cmdreply[2].
| ?
|}

==Pre-9.3.0-X==
{| class="wikitable" border="1"
|-
! Pre-9.3.0-X command header
! Command header starting with 9.3.0-X
! Available since system-version
! Description
|-
| 0x00010000
| ?
| [[8.1.0-0_New3DS]]
| Initialize
|-
| 0x00020000
| ?
| [[8.1.0-0_New3DS]]
| Shutdown
|-
| 0x00030000
| ?
| [[8.1.0-0_New3DS]]
| GetNFCState. This writes an output u8 to cmdreply[2]: 0 = not initialized, 1 = just initialized, 5 = data transfer ready, ...
|-
| 0x00040000
| 0x000B0000
| [[8.1.0-0_New3DS]]
| This writes an output handle to cmdreply[3].
|-
| 0x00050000
| 0x000C0000
| [[8.1.0-0_New3DS]]
| This writes an output handle to cmdreply[3].
|-
| 0x00060040
| ?
| [[8.1.0-0_New3DS]]
| (u8 input)
|-
| 0x00070000
| ?
| [[8.1.0-0_New3DS]]
| The user process must setup the output-buffer hdr+ptr data @ TLS+0x180 when using this. cmdreply[2] = actual output data size?
|-
| 0x00080100
| ?
| [[8.1.0-0_New3DS]]
| (<0x10-bytes starting at cmdreq[1]>)
|-
| 0x00090000
| ?
| [[8.1.0-0_New3DS]]
|
|-
| 0x000A0000
| ?
| [[8.1.0-0_New3DS]]
| The user process must setup the output-buffer hdr+ptr data @ TLS+0x180 when using this.
|-
| 0x000B0042
| ?
| [[8.1.0-0_New3DS]]
| (u32 size, ((Size<<14) <nowiki>|</nowiki> 2), inbufptr)
|-
| 0x000C0044
| ?
| [[8.1.0-0_New3DS]]
| (u32 size, 0x20, <procid set by kernel>, ((Size<<14) <nowiki>|</nowiki> 0x402), inbufptr)
|-
| 0x000D0040
| ?
| [[8.1.0-0_New3DS]]
| (u16 in)
|-
| 0x000E0000
| ?
| [[8.1.0-0_New3DS]]
|
|-
| 0x000F00C2
| ?
| [[8.1.0-0_New3DS]]
| (u32 unk0, u32 unk1, u32 unk2, ((Size<<14) <nowiki>|</nowiki> 0x802), inbufptr)
|-
| 0x00100040
| ?
| [[8.1.0-0_New3DS]]
| (u32 in)
|-
| 0x00110040
| ?
| [[8.1.0-0_New3DS]]
| (u32 in)
|-
| 0x00120040
| ?
| [[8.1.0-0_New3DS]]
| (u32 in)
|-
| 0x00130000
| ?
| [[8.1.0-0_New3DS]]
| Writes an output u32 to cmdreply[2].
|-
| 0x00140000
| ?
| [[8.1.0-0_New3DS]]
| This writes an output 0x30-byte struct starting at cmdreply[2].
|-
| 0x00150000
| 0x00110000
| [[8.1.0-0_New3DS]]
| This writes an output 0x2C-byte struct starting at cmdreply[2].
|-
| 0x00160000
| ?
| [[8.1.0-0_New3DS]]
|
|-
| 0x00170000
| ?
| [[8.1.0-0_New3DS]]
|
|}

=NFC services error codes=
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xc8a17600
| The current NFC tag [[NFC:GetTagState|state]], or other NFC state, is invalid with the NFC command which was used.
|}

=NFC module savedata=
* "/nfp_backup.dat" This contains raw data from the [[Amiibo]] NFC data pages. The filesize is 0x001fbd20-bytes. Certain service cmds will trigger writing to this savedata. This entire file is read during [[amiibo Settings]] startup, it's unknown what command(s) actually triggers that. It seems the Amiibo data here is updated each time the Amiibo NFC data is updated, and read each time the Amiibo NFC data is read. Data is written into this savedata when the Amiibo was never scanned on this system before. The data here is probably also updated when the scanned Amiibo NFC data doesn't match the data stored here.

During NFC writing, the NFC data being written can become corrupted if the Amiibo figure is moved outside of range during writing. When this happens, this nfp_backup data can be used to restore a previous version of that data prior to the last failed write.

==nfp_backup.dat structure==
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x20
| Header
|-
| 0x20
| 0x800
| Amiibo data table header
|-
| 0x7D20
| 0x21C
| The NFC data for the first stored Amiibo is located here. This is the entire raw data from all 0x87 NFC data pages.
|}

===Header structure===
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Unknown, normally the following data? "00 00 02 00 02 00 00 00" (as little-endian u32s: 0x20000, 0x2)
|-
| 0x8
| 0x14
| Unknown, normally all-zero?
|-
| 0x1C
| 0x4
| Unknown. CRC32 / checksum maybe?
|}

===Amiibo data table header===
This is an array with 0x40(?) entries, where the size of each entry is 0x20-bytes. Entry structure:
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| First 8-bytes from [[Amiibo]] NFC serial-number.
|-
| 0x8
| 0x3
| Unknown, normally zero?
|-
| 0xB
| 0x2
| u16 little-endian date value for when this Amiibo was initially written into this savedata, with the same format from [[Amiibo|here]].
|-
| 0xD
| 0xF
| Unknown, normally zero?
|-
| 0x1C
| 0x4
| Unknown. CRC32 / checksum maybe?
|}

=NFC module versions=
{| class="wikitable" border="1"
|-
! System version
! New3DS title-version
! Old3DS title-version
! Changes
|-
| [[9.6.0-24|9.6.0-X]]
| v4102
| v4106
| New3DS and Old3DS: the only changes regarding new commands is that new commands were added for the nfcu/nfcm command-set and new commands for an unknown cmd-handler were added. It's unknown if there's other changes.
|}

=Errors=
{| class="wikitable" border="1"
|-
! Error code
! Description
|-
| 0xC8A17600
| This is returned when the current state is invalid for this command.
|-
| 0xC8A17620
| This is returned by [[NFC:OpenAppData]] when the appdata is uninitialized since [[NFC:InitializeWriteAppData]] wasn't used previously.
|-
| 0xC8A17628
| This is returned by [[NFC:GetAmiiboSettings]] when the amiibo wasn't setup by the amiibo Settings applet.
|-
| 0xC8A17638
| This is returned by [[NFC:OpenAppData]] when the input AppID doesn't match the actual Amiibo AppID.
|-
| 0xC8C1760C
| Returned for HMAC-hash mismatch(data corruption), with HMAC-calculation input_buffer_size=0x34.
|-
| 0xC8A17618
| HMAC-hash mismatch with input_buffer_size=0x1DF(see [[Amiibo|here]]).
|}

Talk:Setting up Development Environment

2016-08-05T06:45:46Z

Thejsa:

<strike>Should we have instructions for setting up the WSL? --[[User:Thejsa|Thejsa]] ([[User talk:Thejsa|talk]]) 10:39, 5 August 2016 (CEST)</strike>
* This is redundant now we have the MSDN link. Added note about not requiring Windows Insider status. --[[User:Thejsa|Thejsa]] ([[User talk:Thejsa|talk]]) 10:45, 5 August 2016 (CEST)

Setting up Development Environment

2016-08-05T06:43:11Z

Thejsa: Add note that you don't actually have to be a Windows Insider to use WSL.

= Setup =
* Install [http://devkitpro.org/ devkitARM]. If it's already installed, update it.
** On Windows, there's a [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ graphical installer].
** On Unix-like platforms such as Linux/macOS, there's a [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitARMupdate.pl/download Perl script]. Make sure you also select libctru and the 3ds examples when installing.
* Depending on the kind of homebrew you want to develop, you may be interested in installing and using additional libraries and tools which don't ship alongside devkitARM/libctru. A list of them can be found in [[Homebrew Libraries and Tools]].

==Windows==
devkitPro provides Win32-native precompiled versions of devkitARM which can be run directly on Windows.
* [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ download the latest version of the graphical installer] from SourceForge and run it, following the instructions as you go.
* An Internet connection is required.
* You will want to make sure devkitARM is selected during the installation process to develop for the 3DS (and also the DS and GBA) - you can also install devkitPPC (for GameCube/Wii development) and devkitPSP (for PlayStation Portable development) if you wish.
* Once the installer has finished, launch MSYS from:
** Windows 7 and earlier: Start -> All Programs -> devkitPro -> MSYS
** Windows 8 and 8.1: Right click on the Start screen and select 'All Apps'. You should find MSYS there.
** Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
** Windows 10 (post-Anniversary Update): Start -> devkitPro -> MSYS

Alternatively starting with Windows 10 Anniversary Update (Version 1607), the [https://msdn.microsoft.com/en-us/commandline/wsl/install_guide Windows Subsystem for Linux (WSL)] may also be used to run the Linux version of devkitARM. Due to the fact that GCC was originally designed for Unix-like platforms its use may yield performance and convenience improvements. For instructions on how to set up devkitARM under WSL refer to the ''Unix-like platforms'' section. For WSL installation instructions, see the MSDN page linked just above, but ignore the part about having to be a Windows Insider; as long as you have the Anniversary Update or later it will work just fine.

==Unix-like platforms==
Currently devkitPro provides precompiled versions of devkitARM for the following Unix-like platforms: Linux (x86/x64), macOS (universal binary). Note that Linux x64 binaries are usable under WSL.

* First, you need to install curl so the installer can download the devkitARM packages, and you should also install Git - you'll need it to update ctrulib or share your code on GitHub, among many other things.

* Find your way into a shell (eg. by opening a Terminal window), and follow the instructions for your OS:
** Debian/Ubuntu/Linux Mint/WSL: <code>sudo apt-get install git curl</code>
** Fedora/CentOS/RHEL: <code>sudo yum install git curl</code>
** openSUSE: <code>sudo zypper install git curl</code>
** macOS: Download Git from [http://git-scm.com/download/mac] and install it. Curl is included with the OS.

* Next, we need to download, make executable and run the devkitARM updater (don't worry, the updater is also the installer.)
<pre>
curl -L http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitARMupdate.pl/download -o devkitARMupdate.pl
chmod +x ./devkitARMupdate.pl
sudo ./devkitARMupdate.pl /opt/devkitpro
</pre>

* Finally, we need to tell your shell where to find the devkitARM binaries.
<pre>
echo "export DEVKITPRO=/opt/devkitpro" >> ~/.bashrc
echo "export DEVKITARM=/opt/devkitpro/devkitARM" >> ~/.bashrc
echo "export PATH=$PATH:/opt/devkitpro/devkitARM/bin" >> ~/.bashrc
source ~/.bashrc
</pre>

= Building the examples =
3DS examples are still being created; however, there are a growing number of examples available from the [https://github.com/devkitPro/3ds-examples devkitPro/3ds-examples GitHub repository].
There are now too many to list here in detail, so go ahead and browse them.

* To download these, if you installed Git (as you will have if you followed the above instructions), simply type <code>git clone https://github.com/devkitPro/3ds-examples.git</code> into your shell in the directory you wish to store the 3ds-examples folder in.
** To overwrite the (almost certainly outdated) examples installed by the devkitPro updater, type <code>git clone https://github.com/devkitPro/3ds-examples.git $DEVKITPRO/examples/3ds</code>.

These can be built from the command line.

To start a new homebrew project from the <code>bash</code> shell, simply type the following (replacing <code>'''~/projects/my3dsproject'''</code> with the place you would like your project to be stored, with <code>~</code> meaning your HOME directory):
cp -r $DEVKITPRO/examples/3ds/templates/application '''~/projects/my3dsproject'''
cd '''~/projects/my3dsproject'''

To compile it, type <code>make</code> in the project directory.
To run it on your 3DS, start the Homebrew Launcher, press Y to open the network loader, then on your PC type: <code>$DEVKITARM/bin/3dslink -a '''192.168.X.X''' '''my3dsproject'''.3dsx</code>, replacing '''192.168.X.X''' with your 3DS's IP address (displayed in the network loader screen) and '''my3dsproject''' with the name of the folder your project is in (ie. the folder you have the source folder in and the README file.)
Don't type the full path, just the last segment - eg. for <code>C:\a\b\'''verygood3dsapp'''</code>, you would type <code>'''verygood3dsapp'''.3dsx</code>.

If all goes well, you'll soon see your application running on your 3DS.

==Building the examples on Linux with Netbeans==
* Go to File->New Project...
* Select C/C++ Project with existing code
* Navigate to the examples directory and select the folder for the project you want to build; eg. /home/vtsingaras/3ds/examples/app_launch
* Leave Configuration Mode to 'Automatic' and click 'Finish'.
* It will fail to build. Now edit Makefile and insert these two lines, adjusting for your devkitpro path, at the top:
<pre>export DEVKITPRO=/opt/devkitpro
export DEVKITARM=/opt/devkitpro/devkitARM</pre>
* Right-click the project and go to Properties->Code Assistance and click C Compiler.
* In include directories enter
<pre>/opt/devkitpro/devkitARM/include;/opt/devkitpro/ctrulib/libctru/include</pre>
adjusting again for your devkitPro path.
* Do the same for 'C++ Compiler'.
* Go to 'Run' and click 'Clean and Build Project'.
* Now right-click on the project and select Code Assistance->Reparse Project.

Now you can use Netbeans' code completion feature and build your project from the Run menu.

= Building homebrew for distribution =
To build your homebrew, open a Bash shell as described above, browse to the folder of the homebrew you wish to compile, and run <code>make</code>.

* This will build a .elf file and a .3dsx file (the homebrew executable itself) together with a .smdh file (the icon).
** The Homebrew Launcher can only run homebrew in the 3DSX format, and can only display SMDH icons.

* To build a CCI (.3ds) file, you need to strip the .elf file and use makerom on it (with the provided RSF file):
arm-none-eabi-strip '''[ELF file]'''
makerom -f cci -o '''[.3ds file]''' -rsf '''[RSF file]''' -target t -exefslogo -elf '''[ELF file]''' -icon '''[icon file]''' -banner '''[banner file]'''

Talk:Setting up Development Environment

2016-08-05T06:39:21Z

Thejsa: Created page with "Should we have instructions for setting up the WSL? --~~~~"

Should we have instructions for setting up the WSL? --[[User:Thejsa|Thejsa]] ([[User talk:Thejsa|talk]]) 10:39, 5 August 2016 (CEST)

User:Thejsa

2016-08-04T22:31:45Z

Thejsa: Create.

Independent web dev, plays with 3DS homebrew and web apps.

Friend code

2016-08-04T22:30:51Z

Thejsa: Add my FC

This is a list of friend codes of different users.

Remember to [http://3dbrew.org/w/index.php?title=Friend_code&action=watch watch this article] if you wish to get notified when someone modifies the list.

{| class="wikitable" border="1"
|-
! width="20%" | User !! width="15%" | IrcNick !! width="20%" | Friend code !! width="10%" |Region !! width="30%" |Comment here !! Mii image
|-
|[[User:Thejsa|thejsa]] || thejsa / jsa_ || 5043-5145-7887 || EUR (UK, N3DS) || My body is ready - ready to Sm4sh, race on MK7 and write homebrew! ||
|-
|[[User:SynRxn|SynRxn]] || ||0962-9776-8195 ||USA ||Let's pwn the 3DS! ||[[File:SynRxn.JPG|120px]]
|-
| z2442 || || <nowiki>4554-0595-5890</nowiki> || USA || hack the 3ds yes! ||
|-
|[[User:ClassicToxin|ClassicToxin]] || || 1864-8732-8338 ||AUS ||Add me can/will probably play any game with you if you like ||
|-
|[[User:Allnewryan1|Allnewryan1]] || || 0001-4540-5587 || USA || Looking to help the devs, add me and send me a message when you find crashes ||
|-
| Crediar || || 2535-3625-3742 || Europe || None ||
|-
| [[User:Skyneo|Skyneo]] || Skyneo || 1950-8547-6804 || Europe (France) || Young beginner dev dreaming of making a Nintendo game. My hair is anarchy. || [[File:SkyneoMii.JPG|120px]]
|-
| Kazuma || || 2277-6646-9164 || Europe || None ||
|-
| SaltyPancakes || || 0044-2836-4738 || Europe || None ||
|-
| Inspectah || || 3909-7495-9525 || Europe || None ||
|-
| XanLoves || || 3995-6523-2805 || Europe || None ||
|-
| muhkuh2005 || || 2449-4689-9707 || Europe || Germanfag ||
|-
| RHOPKINS13 || || 4854-6450-1577 || USA || None || [[File:RHOPKINS13_Mii.JPG]]
|-
| fishuyo || || 2535-3630-0678 || USA || None ||
|-
| marcosxd || || 0216-0901-5448 || Mexico || Crediar add me please, I already added you :) ||
|-
| Mafril || || 5112-3460-1421 || USA || None || [[File:Mafril_Mii.JPG]]
|-
| Epicdude || ||0130-1922-3022 ||USA || None ||
|-
| David || ||3553-9962-0973 ||USA ||Add me ||
|-
| Muzer || || 3136-6762-5385 || Europe || I have added everyone on this list who has a valid friend code (David and marcosxd don't) - so please add me if you get the chance. || [[File:Muzer_Mii.jpg|120px]]
|-
|[[User:Schumi|Schumi]] || || 1934-1000-7068 || Germany (Europe) || add and write with me ;) ||
|-
|[[User:Rikku2000|Rikku2000]] || || EUR: 1461-6425-0347 JPN: 1375-8084-1845 || Germany || Write me on 3DS Letterbox ||[[File:Rikku2000_Mii.JPG|100px]]
|-
|[[User:Elisherer|Elisherer]] || elisherer ||0001-3489-0550 ||USA ||None ||[[File:Elisherer_Mii.JPG|120px]]
|-
|Liam87 || ||2664-2361-9358 ||England ||Add me please, i have added everyone on here, thank you ||
|-
|Luishane || ||1289-8459-2533 ||Venezuela ||Add me...thanks ||
|-
|Immortal_no1 || ||0516-7257-0011 ||UK ||Add me and PM me on gbatemp.net with yours or e-mail me on "immortal_no1@hotmail.com" ||
|-
|CrimsonΣ (CrimsonSigma) || ||5284-1673-1864 ||Brazil ||Add me ||
|-
|E-Chan || ||2062-9187-2394 ||Spain ||Add me please~! Im up for online gaming of any sorts and discussing the scene! ||
|-
|Lazymarek9614 || ||1590-4676-4678 ||Europe ||Online gaming SSF IV 3D, I try to add everyone here! ||
|-
|FireFly || ||4554-0352-3499 ||Europe || None ||
|-
|Hikari06 || ||5241-1966-6545 ||Europe || I added everyone, please add me :) ||[[File:HIKARI06MII.jpg|120px]]
|-
|UpSilon_Project || ||1848-1843-3651 ||France (Europe) || UpSilon from the UpSilon Project ||
|-
|CVosler || ||4554-0499-6731 ||USA || I added everyone. You can also email me your code after you add me "cvosler@hotmail.com" ||[[File:Chip.JPG|120px]]
|-
|[[User:CHR15x94|CHR15x94]] || ||0688-5814-3517 ||Canada (USA) || Feel free to add me. I'll add anyone. If you need to contact me, message me on 3DBrew, or through one of my contacts on my 3DBrew profile. ||[[File:CHR15x94_-_Mii.JPG|120px]]
|-
|[[User:DarkWork0|DarkWork0]] || ||1075-0737-9684 ||USA ||Add me and email me your friends code: darkwork0@gmail.com I'll add anyone who adds me! ||[[File:HNI_0006.JPG‎|120px]]
|-
|[[User:Aliak11|Aliak11]] || ||1160-9718-1643 ||USA ||Add me and email me your friends code: atthegulf@gmail.com ||
|-
|[[User:capt.danny|capt.danny]] || ||4339:2914:5427 ||USA||Added everyone. Email fcs to danny9ds@gmail.com ||
|-
||[[user:jordan|jordan]]|| ||0473-8413-4597||USA||added all.||
|-
|[[User:Stopwatch8|Stopwatch8]] || Stopwatch8 ||2449-4811-6942 ||USA || I have added everyone here. I would be happy if I were added as well! I just like to see what titles everyone plays. :) ||[[File:Stopwatch8.JPG|120px]]
|-
| [[User:mr_seeker|mr_seeker]] || ||3909-7860-3744 ||EUR ||Add me, find me, streetpass me! ||
|-
|[[User:missou|missou]] || missou ||1762-3951-0686 ||EUR || I have added everyone...and everyone can add me! ||[[File:MissouMii.JPG|120px]]
|-
|[[User:GuyInDogSuit|GuyInDogSuit]] || ||4957-2209-2798 ||USA || I have added everyone except David and marcosxd (invalid codes), and everyone can add me in return. ||[[File:GuyInDogSuit.jpg|120px]]
|-
|[[User:NintendoFan|NintendoFan]] || ||2492-4592-1206 ||USA ||None ||
|-
|[[User:Rllns05|Rllns05]] || ||0190-1796-8987 ||USA ||Add me, I won't Bite. ||[[File:Rllns05.JPG|120px]]
|-

News

2016-08-04T22:18:43Z

Thejsa: Correct spelling of 'entries'.

<noinclude>
==Adding an item==
* Log in to the wiki. Editing is disabled if you don't have an account.
* Add the news event to the top of the list, using this format for the date: <tt><nowiki>'''</nowiki>{{#time: d F y}}<nowiki>''' </nowiki></tt>. Please include the application's creator, version number, and a link to a page on 3DBrew about the application. No external links please.
* '''Move the last entry to the [[:News/Archive|news archive]]. There should be no more than 4 entries in the list.'''

==Archives==
For older news, see the [[:News/Archive|news archive]].

=== News ===
</noinclude>
*'''29 July 16''' [[User:Yellows8|Yellows8]] released [https://github.com/yellows8/stickerhax stickerhax], which supports <=[[11.0.0-33]].
*'''27 July 16''' [[User:Yellows8|Yellows8]] released new browserhax(see changelog [[browserhax|here]]) and menuhax [https://github.com/yellows8/3ds_homemenuhax/releases v3.0], all of these now support [[11.0.0-33]].
*'''26 July 16''' Various JPN-only eShop app updates were released. This includes JPN SmileBASIC: the update-title was removed from versionlist, and the main-title was updated. Updating an already installed version of the game will currently update to 3.3.1. Uninstalling and redownloading will give you 3.3.2. [https://plutooo.github.io/smilehax/ smilehax] was fixed in [http://smilebasic.com/debug/ 3.3.2].
*'''22 July 16''' [[User:Dazzozo|Dazzozo]] released [https://citizens.salthax.org/ humblehax v2], supporting the Citizens of Earth update released on the eShop 3 days ago.

Main Page/Welcome

2016-08-04T22:17:04Z

Thejsa: Minor, pedantic, English-nerd tweaks to wording.

{{Main page box|Welcome!|Main Page/Welcome}}
<div style="margin: -.3em -1em -1em -1em;">
{| width="100%" bgcolor="#fff" border="0" cellpadding="2px" cellspacing="2px" style="margin:auto;"
|- align="center" bgcolor="#e7eef6"
! width="50%" | '''What is Homebrew?'''
! width="50%"| '''How do I run homebrew?'''
|- valign="top" align="left" style="background: #F5FAFF;"
| [http://en.wikipedia.org/wiki/Homebrew_(video_games) Homebrew] is a popular term used for applications that are created and executed on a video game console by hackers, programmers, developers, and consumers.
| Keep an eye out on the [[Homebrew Exploits]] page for a list of available exploits and their respective requirements.
|}
{| width="100%" bgcolor="#fff" border="0" cellpadding="2px" cellspacing="2px" style="margin:auto;"
|- align="center" bgcolor="#e7eef6"
! width="50%" | '''How do I develop homebrew?'''
! width="50%"| '''What homebrew can I run?'''
|- valign="top" align="left" style="background: #F5FAFF;"
| See the [[Setting up Development Environment‎]] page for a guide on how to get started with homebrew development for the 3DS. The toolchain supports Windows, Linux, and Mac OS X.
| See the [[Homebrew Applications]] page for a partial list of homebrew applications/games that can be downloaded and installed.
|}

</div>
{{box-footer-empty}}

Setting up Development Environment

2016-08-04T22:13:02Z

Thejsa: Rewrite pretty much everything - add Windows 10 WSL instructions, describe Win32 installation, add instructions for non-Debian Linuxes and OS X, rewrite Examples section.

= Setup =
* Install [http://devkitpro.org/ devkitARM]. If it's already installed, update it.
** On Windows, there's a [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ graphical installer].
** On Linux / Mac OS X / Win10 WSL, there's a [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitARMupdate.pl/download Perl script]. Make sure you also select libctru and the 3ds examples when installing.
* Depending on the kind of homebrew you want to develop, you may be interested in installing and using additional libraries and tools which don't ship alongside devkitARM/libctru. A list of them can be found in [[Homebrew Libraries and Tools]].

==Windows 10==
On Windows 10, if you have installed the Anniversary Update you can use the Windows Subsystem for Linux.
This is essentially a version of the command line portion of Ubuntu Linux running within Windows 10, under the Windows 10 kernel.
It replaces msys, and being built in to the Windows 10 kernel, it is faster.

This is advantageous to use as most of the development tools were originally written for Linux (eg. GCC (compiler), 3dsxtool, etc) and run better than on Windows.

Note that you can still use the standard Windows tools instead. However, if you wish to use the WSL, follow these instructions:

* First, check that you have the Anniversary Update installed. To do this, hit Win+R to open the Run box, type <code>winver</code>, and hit OK. If you have Windows 10 version 1607 or higher, you're good to go.

Screenshot: https://i.imgur.com/01bFYYN.png (image uploading is broken on 3Dbrew)

* Next, open the Settings and enter Update and Security -> For developers.

* Switch to Developer Mode, and reboot.

* Next, hit Start and search for 'features', and select 'Turn Windows features on or off'.

* Scroll down until you find 'Windows Subsystem for Linux' - tick the box to enable it, and hit OK. Reboot again.

* Finally, To do this, hit Win+R to open the Run box, type <code>bash</code>, and hit OK.
** Hit 'y' when it asks you to download the Linux binaries. This shouldn't take long; on a 5Mbps connection, it took about 3 minutes, but YMMV (Your Mileage May Vary).

* Now follow the Linux / Ubuntu instructions to install devkitARM - you can open the <code>bash</code> shell by hitting Start and running the 'Bash on Ubuntu on Windows' application, opening a Command Prompt / PowerShell window and typing <code>bash</code>, or hitting Win+R to open the Run box and typing <code>bash</code>.

==Windows==
If you don't have Windows 10, or don't wish to use the WSL, then you can use the native Win32 tools instead.
* [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ download the latest version of the graphical installer] from SourceForge and run it, following the instructions as you go.
* An Internet connection is required.
* You will want to make sure devkitARM is selected during the installation process to develop for the 3DS (and also the DS and GBA) - you can also install devkitPPC (for GameCube/Wii development) and devkitPSP (for PlayStation Portable development) if you wish.
* Once the installer has finished, launch MSYS from:
** Windows 7 and earlier: Start -> All Programs -> devkitPro -> MSYS
** Windows 8 and 8.1: Right click on the Start screen and select 'All Apps'. You should find MSYS there.
** Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
** Windows 10 (post-Anniversary Update): Start -> devkitPro -> MSYS

==Linux / Mac OS X==
* First, you need to install curl so the installer can download the devkitARM packages, and you should also install Git - you'll need it to update ctrulib or share your code on GitHub, among many other things.

* Find your way into a shell (eg. by opening a Terminal window), and follow the instructions for your OS:
** Debian/Ubuntu/Linux Mint: <code>sudo apt-get install git curl</code>
** Fedora/CentOS/RHEL: <code>sudo yum install git curl</code>
** openSUSE: <code>sudo zypper install git curl</code>
** Mac OS X: Download Git from [http://git-scm.com/download/mac] and install it. Curl is included with the OS.

* Next, we need to download, make executable and run the devkitARM updater (don't worry, the updater is also the installer.)
<pre>
curl -L http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitARMupdate.pl/download -o devkitARMupdate.pl
chmod +x ./devkitARMupdate.pl
sudo ./devkitARMupdate.pl /opt/devkitpro
</pre>

* Finally, we need to tell your shell where to find the devkitARM binaries.
<pre>
echo "export DEVKITPRO=/opt/devkitpro" >> ~/.bashrc
echo "export DEVKITARM=/opt/devkitpro/devkitARM" >> ~/.bashrc
echo "export PATH=$PATH:/opt/devkitpro/devkitARM/bin" >> ~/.bashrc
source ~/.bashrc
</pre>

= Building the examples =
3DS examples are still being created; however, there are a growing number of examples available from the [https://github.com/devkitPro/3ds-examples devkitPro/3ds-examples GitHub repository].
There are now too many to list here in detail, so go ahead and browse them.

* To download these, if you installed Git (as you will have if you followed the above instructions), simply type <code>git clone https://github.com/devkitPro/3ds-examples.git</code> into your shell in the directory you wish to store the 3ds-examples folder in.
** To overwrite the (almost certainly outdated) examples installed by the devkitPro updater, type <code>git clone https://github.com/devkitPro/3ds-examples.git $DEVKITPRO/examples/3ds</code>.

These can be built from the command line - open a Bash shell by following these instructions:
* Windows:
** Windows 10:
*** Anniversary Update and later:
**** Windows Subsystem for Linux: Choose from any of these options:
***** Hit Start and run the 'Bash on Ubuntu on Windows' application.
***** Open a Command Prompt / PowerShell window and type <code>bash</code>.
***** Hit Win+R to open the Run box and type <code>bash</code>.
**** Msys: Start -> devkitPro -> MSYS
*** Pre-Anniversary Update: Start -> All Apps -> devkitPro -> MSYS.
** Windows 8 and 8.1: Right click on the Start screen and select 'All Apps'. You should find MSYS there.
** Windows 7 and earlier: Start -> All Programs -> devkitPro -> MSYS.

To start a new homebrew project from the <code>bash</code> shell, simply type the following (replacing <code>'''~/projects/my3dsproject'''</code> with the place you would like your project to be stored, with <code>~</code> meaning your HOME directory):
cp -r $DEVKITPRO/examples/3ds/templates/application '''~/projects/my3dsproject'''
cd '''~/projects/my3dsproject'''

To compile it, type <code>make</code> in the project directory.
To run it on your 3DS, start the Homebrew Launcher, press Y to open the network loader, then on your PC type: <code>$DEVKITARM/bin/3dslink -a '''192.168.X.X''' '''my3dsproject'''.3dsx</code>, replacing '''192.168.X.X''' with your 3DS's IP address (displayed in the network loader screen) and '''my3dsproject''' with the name of the folder your project is in (ie. the folder you have the source folder in and the README file.)
Don't type the full path, just the last segment - eg. for <code>C:\a\b\'''verygood3dsapp'''</code>, you would type <code>'''verygood3dsapp'''.3dsx</code>.

If all goes well, you'll soon see your application running on your 3DS.

==Building the examples on Linux with Netbeans==
* Go to File->New Project...
* Select C/C++ Project with existing code
* Navigate to the examples directory and select the folder for the project you want to build; eg. /home/vtsingaras/3ds/examples/app_launch
* Leave Configuration Mode to 'Automatic' and click 'Finish'.
* It will fail to build. Now edit Makefile and insert these two lines, adjusting for your devkitpro path, at the top:
<pre>export DEVKITPRO=/opt/devkitpro
export DEVKITARM=/opt/devkitpro/devkitARM</pre>
* Right-click the project and go to Properties->Code Assistance and click C Compiler.
* In include directories enter
<pre>/opt/devkitpro/devkitARM/include;/opt/devkitpro/ctrulib/libctru/include</pre>
adjusting again for your devkitPro path.
* Do the same for 'C++ Compiler'.
* Go to 'Run' and click 'Clean and Build Project'.
* Now right-click on the project and select Code Assistance->Reparse Project.

Now you can use Netbeans' code completion feature and build your project from the Run menu.

= Building homebrew for distribution =
To build your homebrew, open a Bash shell as described above, browse to the folder of the homebrew you wish to compile, and run <code>make</code>.

* This will build a .elf file and a .3dsx file (the homebrew executable itself) together with a .smdh file (the icon).
** The Homebrew Launcher can only run homebrew in the 3DSX format, and can only display SMDH icons.

* To build a CCI (.3ds) file, you need to strip the .elf file and use makerom on it (with the provided RSF file):
arm-none-eabi-strip '''[ELF file]'''
makerom -f cci -o '''[.3ds file]''' -rsf '''[RSF file]''' -target t -exefslogo -elf '''[ELF file]''' -icon '''[icon file]''' -banner '''[banner file]'''