[
{
"path": ".clang-format",
"content": "BasedOnStyle: LLVM\nAllowShortFunctionsOnASingleLine: None\nBreakBeforeBraces: Allman\nColumnLimit: 100\nUseTab: Never\nIndentWidth: 4\nTabWidth: 4\nAlignAfterOpenBracket: DontAlign\nCpp11BracedListStyle: false\nBreakStringLiterals: false\nIndentCaseLabels: false\nBinPackArguments: false\nBinPackParameters: false\nAlignTrailingComments: false\nIncludeCategories:\n - Regex: '^\"gba/types\\.h\"$'\n Priority: -4\n - Regex: '^\"global\\.h\"$'\n Priority: -3\n - Regex: '^\"gba/gba\\.h\"$'\n Priority: -2\n - Regex: '^\"gba/'\n Priority: -1\n - Regex: '.\\*'\n Priority: 1\n© 2020 GitHub, Inc.\n"
},
{
"path": ".gitattributes",
"content": "# Auto detect text files and perform LF normalization\n* text=auto\n\n*.bin binary\n\n# Declare files that will always have CRLF line endings on checkout.\n*.pal text eol=crlf\n\n# Declare files that will always have LF line endings on checkout.\n*.sha1 text eol=lf\n\n# Custom for Visual Studio\n*.cs diff=csharp\n\n# Standard to msysgit\n*.doc\t diff=astextplain\n*.DOC\t diff=astextplain\n*.docx diff=astextplain\n*.DOCX diff=astextplain\n*.dot diff=astextplain\n*.DOT diff=astextplain\n*.pdf diff=astextplain\n*.PDF\t diff=astextplain\n*.rtf\t diff=astextplain\n*.RTF\t diff=astextplain\n"
},
{
"path": ".github/workflows/build.yml",
"content": "name: Build CI\n\non:\n push:\n branches: [ \"master\" ]\n\n# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages\npermissions:\n contents: read\n pages: write\n id-token: write\n\n# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.\n# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.\nconcurrency:\n group: \"pages\"\n cancel-in-progress: false\n\njobs:\n build:\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n\n runs-on: ubuntu-latest\n\n steps:\n - name: Install dependencies\n run: sudo apt-get update && sudo apt-get install -y build-essential binutils-arm-none-eabi libpng-dev && python -m pip install ttp numpy pillow\n\n - uses: actions/checkout@v4\n\n - name: Install agbcc\n run: git clone https://github.com/pret/agbcc.git && cd agbcc/ && ./build.sh && ./install.sh .. && cd ..\n\n - name: Build tools\n run: ./build_tools.sh\n\n - name: Mock base ROM\n run: head -c 16M /dev/urandom > baserom.gba\n\n - name: Build target ROM\n run: make fireemblem8.gba\n\n - name: Calculate decomp progress\n run: scripts/calcrom.sh | tee _site/progress.txt\n\n - name: Upload decomp progress\n run: python scripts/upload-progress.py -b \"https://progress.deco.mp\" -a ${{secrets.PROGRESS_API_KEY}} -p fireemblem8 -v us -t scripts/progress-template.txt _site/progress.txt\n\n - name: Extract symbol table\n run: arm-none-eabi-nm -l -n fireemblem8.elf | grep -v '^00' | uniq > _site/symbols.txt\n\n - name: Setup Pages\n uses: actions/configure-pages@v5\n\n - name: Upload artifact\n uses: actions/upload-pages-artifact@v3\n\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v4\n"
},
{
"path": ".github/workflows/supplement-progress.yml",
"content": "name: Supplement progress data for historical commits\n\non:\n workflow_dispatch:\n inputs:\n range:\n description: 'Range'\n required: true\n beforeBuild:\n description: 'Before Build'\n default: 'echo build'\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n environment: supplement-progress\n\n steps:\n - name: Install dependencies\n run: sudo apt-get update && sudo apt-get install -y build-essential gcc-arm-none-eabi libpng-dev && python -m pip install ttp\n\n - uses: actions/checkout@v3\n with:\n fetch-depth: 0\n\n - name: Install agbcc\n run: git clone https://github.com/pret/agbcc.git && cd agbcc/ && ./build.sh && ./install.sh .. && cd ..\n\n - name: Build tools\n run: ./build_tools.sh\n\n - name: Mock base ROM\n run: head -c 16777216 /dev/urandom > baserom.gba\n\n - name: Supplement progress data\n run: for commit in `git log --merges --format=%h ${{ inputs.range }}`; do git checkout -f $commit && git checkout ${{ github.ref_name }} scripts && ${{ inputs.beforeBuild }} && make fireemblem8.gba && sh scripts/calcrom.sh > progress.txt && make clean && python scripts/upload-progress.py -b \"https://progress.deco.mp\" -a ${{secrets.PROGRESS_API_KEY}} -p fireemblem8 -v us -t scripts/progress-template.txt progress.txt; done\n"
},
{
"path": ".gitignore",
"content": "*.sym\n\n/.deps/\n\n# Windows image file caches\nThumbs.db\nehthumbs.db\n\n# Folder config file\nDesktop.ini\n\n# Recycle Bin used on file shares\n$RECYCLE.BIN/\n\n# Windows Installer files\n*.cab\n*.msi\n*.msm\n*.msp\n\n# Windows shortcuts\n*.lnk\n\n# Vim temporary files\n*.swp\n\n# =========================\n# Operating System Files\n# =========================\n\n# OSX\n# =========================\n\n.DS_Store\n.AppleDouble\n.LSOverride\n\n# Thumbnails\n._*\n\n# Files that might appear in the root of a volume\n.DocumentRevisions-V100\n.fseventsd\n.Spotlight-V100\n.TemporaryItems\n.Trashes\n.VolumeIcon.icns\n\n# Directories potentially created on remote AFP share\n.AppleDB\n.AppleDesktop\nNetwork Trash Folder\nTemporary Items\n.apdisk\n\n# =========================\n# Build Outputs\n# =========================\n\n*.gba\n*.elf\n*.map\nobjects.lst\n*.o\nsrc/*.s\n*.dump\ntools/agbcc\n*.exe\n.dep\n*.4bpp\n*.8bpp\n*.gbapal\n*.4bpp.h\n*.8bpp.h\n*.lz\n*.fk\ndata/banim/*.bin\ngraphics/map/layout/*.bin\ngraphics/statscreen/*.bin\n\n*.feimg*.bin\n*.fetsa*.bin\n\n\n# =========================\n# Dump Scripts Output\n# =========================\n\nscripts/out/*\nscripts/__pycache__/*\n\n# =========================\n# Game Save Files\n# =========================\n\n*.sav\n*.ss[0-9]\n\n\n# Created by https://www.gitignore.io/api/c,vim,tags,linux,macos,clion,emacs,python,windows,eclipse,assembler,visualstudio,visualstudiocode\n# Edit at https://www.gitignore.io/?templates=c,vim,tags,linux,macos,clion,emacs,python,windows,eclipse,assembler,visualstudio,visualstudiocode\n\n### Assembler ###\n*.exe\n*.o\n*.obj\n*.bc\n\n### C ###\n# Prerequisites\n*.d\n\n# Object files\n*.ko\n*.elf\n\n# Linker output\n*.ilk\n*.map\n*.exp\n\n# Precompiled Headers\n*.gch\n*.pch\n\n# Libraries\n*.lib\n*.a\n*.la\n*.lo\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.out\n*.app\n*.i*86\n*.x86_64\n*.hex\n\n# Debug files\n*.dSYM/\n*.su\n*.idb\n*.pdb\n\n# Kernel Module Compile Results\n*.mod*\n*.cmd\n.tmp_versions/\nmodules.order\nModule.symvers\nMkfile.old\ndkms.conf\n\n### CLion ###\n# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm\n# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839\n\n# User-specific stuff\n.idea/**/workspace.xml\n.idea/**/tasks.xml\n.idea/**/usage.statistics.xml\n.idea/**/dictionaries\n.idea/**/shelf\n\n# Generated files\n.idea/**/contentModel.xml\n\n# Sensitive or high-churn files\n.idea/**/dataSources/\n.idea/**/dataSources.ids\n.idea/**/dataSources.local.xml\n.idea/**/sqlDataSources.xml\n.idea/**/dynamic.xml\n.idea/**/uiDesigner.xml\n.idea/**/dbnavigator.xml\n\n# Gradle\n.idea/**/gradle.xml\n.idea/**/libraries\n\n# Gradle and Maven with auto-import\n# When using Gradle or Maven with auto-import, you should exclude module files,\n# since they will be recreated, and may cause churn. Uncomment if using\n# auto-import.\n# .idea/modules.xml\n# .idea/*.iml\n# .idea/modules\n# *.iml\n# *.ipr\n\n# CMake\ncmake-build-*/\n\n# Mongo Explorer plugin\n.idea/**/mongoSettings.xml\n\n# File-based project format\n*.iws\n\n# IntelliJ\nout/\n\n# mpeltonen/sbt-idea plugin\n.idea_modules/\n\n# JIRA plugin\natlassian-ide-plugin.xml\n\n# Cursive Clojure plugin\n.idea/replstate.xml\n\n# Crashlytics plugin (for Android Studio and IntelliJ)\ncom_crashlytics_export_strings.xml\ncrashlytics.properties\ncrashlytics-build.properties\nfabric.properties\n\n# Editor-based Rest Client\n.idea/httpRequests\n\n# Android studio 3.1+ serialized cache file\n.idea/caches/build_file_checksums.ser\n\n### CLion Patch ###\n# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721\n\n# *.iml\n# modules.xml\n# .idea/misc.xml\n# *.ipr\n\n# Sonarlint plugin\n.idea/**/sonarlint/\n\n# SonarQube Plugin\n.idea/**/sonarIssues.xml\n\n# Markdown Navigator plugin\n.idea/**/markdown-navigator.xml\n.idea/**/markdown-navigator/\n\n### Eclipse ###\n.metadata\nbin/\ntmp/\n*.tmp\n*.bak\n*.swp\n*~.nib\nlocal.properties\n.settings/\n.loadpath\n.recommenders\n\n# External tool builders\n.externalToolBuilders/\n\n# Locally stored \"Eclipse launch configurations\"\n*.launch\n\n# PyDev specific (Python IDE for Eclipse)\n*.pydevproject\n\n# CDT-specific (C/C++ Development Tooling)\n.cproject\n\n# CDT- autotools\n.autotools\n\n# Java annotation processor (APT)\n.factorypath\n\n# PDT-specific (PHP Development Tools)\n.buildpath\n\n# sbteclipse plugin\n.target\n\n# Tern plugin\n.tern-project\n\n# TeXlipse plugin\n.texlipse\n\n# STS (Spring Tool Suite)\n.springBeans\n\n# Code Recommenders\n.recommenders/\n\n# Annotation Processing\n.apt_generated/\n\n# Scala IDE specific (Scala & Java development for Eclipse)\n.cache-main\n.scala_dependencies\n.worksheet\n\n### Eclipse Patch ###\n# Eclipse Core\n.project\n\n# JDT-specific (Eclipse Java Development Tools)\n.classpath\n\n# Annotation Processing\n.apt_generated\n\n.sts4-cache/\n\n### Emacs ###\n# -*- mode: gitignore; -*-\n*~\n\\#*\\#\n/.emacs.desktop\n/.emacs.desktop.lock\n*.elc\nauto-save-list\ntramp\n.\\#*\n\n# Org-mode\n.org-id-locations\n*_archive\n\n# flymake-mode\n*_flymake.*\n\n# eshell files\n/eshell/history\n/eshell/lastdir\n\n# elpa packages\n/elpa/\n\n# reftex files\n*.rel\n\n# AUCTeX auto folder\n/auto/\n\n# cask packages\n.cask/\ndist/\n\n# Flycheck\nflycheck_*.el\n\n# server auth directory\n/server/\n\n# projectiles files\n.projectile\n\n# directory configuration\n.dir-locals.el\n\n# network security\n/network-security.data\n\n\n### Linux ###\n\n# temporary files which can be created if a process still has a handle open of a deleted file\n.fuse_hidden*\n\n# KDE directory preferences\n.directory\n\n# Linux trash folder which might appear on any partition or disk\n.Trash-*\n\n# .nfs files are created when an open file is removed but is still being accessed\n.nfs*\n\n### macOS ###\n# General\n.DS_Store\n.AppleDouble\n.LSOverride\n\n# Icon must end with two \\r\nIcon\n\n# Thumbnails\n._*\n\n# Files that might appear in the root of a volume\n.DocumentRevisions-V100\n.fseventsd\n.Spotlight-V100\n.TemporaryItems\n.Trashes\n.VolumeIcon.icns\n.com.apple.timemachine.donotpresent\n\n# Directories potentially created on remote AFP share\n.AppleDB\n.AppleDesktop\nNetwork Trash Folder\nTemporary Items\n.apdisk\n\n### Python ###\n# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\npip-wheel-metadata/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n.hypothesis/\n.pytest_cache/\n\n# Translations\n*.mo\n*.pot\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\ntarget/\n\n# pyenv\n.python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# celery beat schedule file\ncelerybeat-schedule\n\n# SageMath parsed files\n*.sage.py\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# Mr Developer\n.mr.developer.cfg\n.pydevproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n### Tags ###\n# Ignore tags created by etags, ctags, gtags (GNU global) and cscope\nTAGS\n.TAGS\n!TAGS/\ntags\n.tags\n!tags/\ngtags.files\nGTAGS\nGRTAGS\nGPATH\nGSYMS\ncscope.files\ncscope.out\ncscope.in.out\ncscope.po.out\n\n\n### Vim ###\n# Swap\n[._]*.s[a-v][a-z]\n[._]*.sw[a-p]\n[._]s[a-rt-v][a-z]\n[._]ss[a-gi-z]\n[._]sw[a-p]\n\n# Session\nSession.vim\nSessionx.vim\n\n# Temporary\n.netrwhist\n\n# Auto-generated tag files\n\n# Persistent undo\n[._]*.un~\n\n# Coc configuration directory\n.vim\n\n### VisualStudioCode ###\n.vscode/*\n!.vscode/settings.json\n!.vscode/tasks.json\n!.vscode/launch.json\n!.vscode/extensions.json\n\n### VisualStudioCode Patch ###\n# Ignore all local history of files\n.history\n\n### Windows ###\n# Windows thumbnail cache files\nThumbs.db\nThumbs.db:encryptable\nehthumbs.db\nehthumbs_vista.db\n\n# Dump file\n*.stackdump\n\n# Folder config file\n[Dd]esktop.ini\n\n# Recycle Bin used on file shares\n$RECYCLE.BIN/\n\n# Windows Installer files\n*.cab\n*.msi\n*.msix\n*.msm\n*.msp\n\n# Windows shortcuts\n*.lnk\n\n### VisualStudio ###\n## Ignore Visual Studio temporary files, build results, and\n## files generated by popular Visual Studio add-ons.\n##\n## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore\n\n# User-specific files\n*.rsuser\n*.suo\n*.user\n*.userosscache\n*.sln.docstates\n\n# User-specific files (MonoDevelop/Xamarin Studio)\n*.userprefs\n\n# Mono auto generated files\nmono_crash.*\n\n# Build results\n[Dd]ebug/\n[Dd]ebugPublic/\n[Rr]elease/\n[Rr]eleases/\nx64/\nx86/\n[Aa][Rr][Mm]/\n[Aa][Rr][Mm]64/\nbld/\n[Bb]in/\n[Oo]bj/\n[Ll]og/\n\n# Visual Studio 2015/2017 cache/options directory\n.vs/\n# Uncomment if you have tasks that create the project's static files in wwwroot\n#wwwroot/\n\n# Visual Studio 2017 auto generated files\nGenerated\\ Files/\n\n# MSTest test Results\n[Tt]est[Rr]esult*/\n[Bb]uild[Ll]og.*\n\n# NUnit\n*.VisualState.xml\nTestResult.xml\nnunit-*.xml\n\n# Build Results of an ATL Project\n[Dd]ebugPS/\n[Rr]eleasePS/\ndlldata.c\n\n# Benchmark Results\nBenchmarkDotNet.Artifacts/\n\n# .NET Core\nproject.lock.json\nproject.fragment.lock.json\nartifacts/\n\n# StyleCop\nStyleCopReport.xml\n\n# Files built by Visual Studio\n*_i.c\n*_p.c\n*_h.h\n*.iobj\n*.ipdb\n*.pgc\n*.pgd\n*.rsp\n*.sbr\n*.tlb\n*.tli\n*.tlh\n*.tmp_proj\n*_wpftmp.csproj\n*.log\n*.vspscc\n*.vssscc\n.builds\n*.pidb\n*.svclog\n*.scc\n\n# Chutzpah Test files\n_Chutzpah*\n\n# Visual C++ cache files\nipch/\n*.aps\n*.ncb\n*.opendb\n*.opensdf\n*.sdf\n*.cachefile\n*.VC.db\n*.VC.VC.opendb\n\n# Visual Studio profiler\n*.psess\n*.vsp\n*.vspx\n*.sap\n\n# Visual Studio Trace Files\n*.e2e\n\n# TFS 2012 Local Workspace\n$tf/\n\n# Guidance Automation Toolkit\n*.gpState\n\n# ReSharper is a .NET coding add-in\n_ReSharper*/\n*.[Rr]e[Ss]harper\n*.DotSettings.user\n\n# JustCode is a .NET coding add-in\n.JustCode\n\n# TeamCity is a build add-in\n_TeamCity*\n\n# DotCover is a Code Coverage Tool\n*.dotCover\n\n# AxoCover is a Code Coverage Tool\n.axoCover/*\n!.axoCover/settings.json\n\n# Visual Studio code coverage results\n*.coverage\n*.coveragexml\n\n# NCrunch\n_NCrunch_*\n.*crunch*.local.xml\nnCrunchTemp_*\n\n# MightyMoose\n*.mm.*\nAutoTest.Net/\n\n# Web workbench (sass)\n.sass-cache/\n\n# Installshield output folder\n[Ee]xpress/\n\n# DocProject is a documentation generator add-in\nDocProject/buildhelp/\nDocProject/Help/*.HxT\nDocProject/Help/*.HxC\nDocProject/Help/*.hhc\nDocProject/Help/*.hhk\nDocProject/Help/*.hhp\nDocProject/Help/Html2\nDocProject/Help/html\n\n# Click-Once directory\npublish/\n\n# Publish Web Output\n*.[Pp]ublish.xml\n*.azurePubxml\n# Note: Comment the next line if you want to checkin your web deploy settings,\n# but database connection strings (with potential passwords) will be unencrypted\n*.pubxml\n*.publishproj\n\n# Microsoft Azure Web App publish settings. Comment the next line if you want to\n# checkin your Azure Web App publish settings, but sensitive information contained\n# in these scripts will be unencrypted\nPublishScripts/\n\n# NuGet Packages\n*.nupkg\n# NuGet Symbol Packages\n*.snupkg\n# The packages folder can be ignored because of Package Restore\n**/[Pp]ackages/*\n# except build/, which is used as an MSBuild target.\n!**/[Pp]ackages/build/\n# Uncomment if necessary however generally it will be regenerated when needed\n#!**/[Pp]ackages/repositories.config\n# NuGet v3's project.json files produces more ignorable files\n*.nuget.props\n*.nuget.targets\n\n# Microsoft Azure Build Output\ncsx/\n*.build.csdef\n\n# Microsoft Azure Emulator\necf/\nrcf/\n\n# Windows Store app package directories and files\nAppPackages/\nBundleArtifacts/\nPackage.StoreAssociation.xml\n_pkginfo.txt\n*.appx\n*.appxbundle\n*.appxupload\n\n# Visual Studio cache files\n# files ending in .cache can be ignored\n*.[Cc]ache\n# but keep track of directories ending in .cache\n!?*.[Cc]ache/\n\n# Others\nClientBin/\n~$*\n*.dbmdl\n*.dbproj.schemaview\n*.jfm\n*.pfx\n*.publishsettings\norleans.codegen.cs\n\n# Including strong name files can present a security risk\n# (https://github.com/github/gitignore/pull/2483#issue-259490424)\n#*.snk\n\n# Since there are multiple workflows, uncomment next line to ignore bower_components\n# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)\n#bower_components/\n\n# RIA/Silverlight projects\nGenerated_Code/\n\n# Backup & report files from converting an old project file\n# to a newer Visual Studio version. Backup files are not needed,\n# because we have git ;-)\n_UpgradeReport_Files/\nBackup*/\nUpgradeLog*.XML\nUpgradeLog*.htm\nServiceFabricBackup/\n*.rptproj.bak\n\n# SQL Server files\n*.mdf\n*.ldf\n*.ndf\n\n# Business Intelligence projects\n*.rdl.data\n*.bim.layout\n*.bim_*.settings\n*.rptproj.rsuser\n*- [Bb]ackup.rdl\n*- [Bb]ackup ([0-9]).rdl\n*- [Bb]ackup ([0-9][0-9]).rdl\n\n# Microsoft Fakes\nFakesAssemblies/\n\n# GhostDoc plugin setting file\n*.GhostDoc.xml\n\n# Node.js Tools for Visual Studio\n.ntvs_analysis.dat\nnode_modules/\n\n# Visual Studio 6 build log\n*.plg\n\n# Visual Studio 6 workspace options file\n*.opt\n\n# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)\n*.vbw\n\n# Visual Studio LightSwitch build output\n**/*.HTMLClient/GeneratedArtifacts\n**/*.DesktopClient/GeneratedArtifacts\n**/*.DesktopClient/ModelManifest.xml\n**/*.Server/GeneratedArtifacts\n**/*.Server/ModelManifest.xml\n_Pvt_Extensions\n\n# Paket dependency manager\n.paket/paket.exe\npaket-files/\n\n# FAKE - F# Make\n.fake/\n\n# CodeRush personal settings\n.cr/personal\n\n# Python Tools for Visual Studio (PTVS)\n*.pyc\n\n# Cake - Uncomment if you are using it\n# tools/**\n# !tools/packages.config\n\n# Tabs Studio\n*.tss\n\n# Telerik's JustMock configuration file\n*.jmconfig\n\n# BizTalk build output\n*.btp.cs\n*.btm.cs\n*.odx.cs\n*.xsd.cs\n\n# OpenCover UI analysis results\nOpenCover/\n\n# Azure Stream Analytics local run output\nASALocalRun/\n\n# MSBuild Binary and Structured Log\n*.binlog\n\n# NVidia Nsight GPU debugger configuration file\n*.nvuser\n\n# MFractors (Xamarin productivity tool) working folder\n.mfractor/\n\n# Local History for Visual Studio\n.localhistory/\n\n# BeatPulse healthcheck temp database\nhealthchecksdb\n\n# Backup folder for Package Reference Convert tool in Visual Studio 2017\nMigrationBackup/\n\n# End of https://www.gitignore.io/api/c,vim,tags,linux,macos,clion,emacs,python,windows,eclipse,assembler,visualstudio,visualstudiocode\n\n# Reverse engineering tool\n*.id?\n*.nam\n*.til\n*.rd?\n*.gdt\n*.gpr\n*.rep\n\n# GCC dump (-da -dv)\ngccdump/\n\n# Artifact of dump_sound\n!scripts/dump_sound/Program.cs\nscripts/dump_sound/\n\n# Converted sound samples\nsound/direct_sound_samples/*.bin\n\n# Converted songs\nsound/songs/midi/*.s\n.vscode/settings.json\n\n# Generated source files\nsrc/msg_data.c\ninclude/msg_data.h\n\n# Source files written in ASM\n!src/rom_header.s\n!src/crt0.s\n!src/m4a_1.s\n!src/libagbsyscall.s\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contribution Guide\n\n1. Register account on [GitHub](https://github.com/)\n1. [Here](https://github.com/laqieer/fireemblem8u/tree/master/asm) are files to decompile. Select a file and click the pencil button to edit it.\n1. Check the build status badge in `README.md` or [commit list](https://github.com/laqieer/fireemblem8u/commits/master).\n1. Edit until the build status is green, and pull request. \n\n**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)\n\n\n# Decompiling Guide\n\nCode starts out in `asm/`. When decompiled to C, it goes into `src/`. The goal is to decompile all the code.\n\nSome of the code in `asm/` is handwritten assembly. It can't and shouldn't be decompiled. It's already commented, so there's no further work to do on these files.\n* `asm/crt0.s`\n* `asm/libagbsyscall.s`\n* `asm/libgcnmultiboot.s`\n* `asm/m4a_1.s`\n* `asm/m4a_3.s`\n\nThe rest of the `.s` files in `asm/` are fair game.\n\nThe basic decompilation process is:\n* Choose a file in `asm/`, i.e. `asm/x.s`. Create a C file called `src/x.c`.\n* Translate the first function in `asm/x.s` to C in `src/x.c`.\n* `make`, and tweak the function until it matches.\n* Clean up the code and comment.\n* Repeat for each function until `asm/x.s` is empty.\n\n\n# For example, let's decompile `asm/cable_car.s`.\n\n\n## 1. Create `src/cable_car.c`\n\n```c\n#include \"global.h\"\n```\n\n`global.h` contains typedefs for GBA programming and more.\nIt must be the first include in the file. Other includes will assume you have included it.\n\n\n## 2. Include it in the rom\n\nInclude `src/cable_car.c` in the rom by adding `src/cable_car.o` to `ld_script.txt`:\n```diff\n asm/battle_message.o(.text);\n asm/choose_party.o(.text);\n+ src/cable_car.o(.text);\n asm/cable_car.o(.text);\n asm/roulette_util.o(.text);\n```\nDo not remove `asm/cable_car.o(.text)`. We want both `src/cable_car.c` and `asm/cable_car.s` in the rom.\n\n\n## 3. Translate the function to C\n\nTake the first function in `asm/cable_car.s`. Either comment it out or remove it, whichever is easier.\n\n```asm\n\tthumb_func_start sub_81231EC\nsub_81231EC: @ 81231EC\n\tpush {r4,lr}\n\tlsls r0, 24\n\tlsrs r4, r0, 24\n\tldr r0, _08123210 @ =gPaletteFade\n\tldrb r1, [r0, 0x7]\n\tmovs r0, 0x80\n\tands r0, r1\n\tcmp r0, 0\n\tbne _0812320A\n\tldr r0, _08123214 @ =sub_8123244\n\tbl SetMainCallback2\n\tadds r0, r4, 0\n\tbl DestroyTask\n_0812320A:\n\tpop {r4}\n\tpop {r0}\n\tbx r0\n\t.align 2, 0\n_08123210: .4byte gPaletteFade\n_08123214: .4byte sub_8123244\n\tthumb_func_end sub_81231EC\n```\n---\n\nThen, start translating the code to `src/cable_car.c`, bit by bit:\n\n```asm\n\tlsls r0, 24\n\tlsrs r4, r0, 24\n```\n```c\nvoid sub_81231EC(u8 r4) {\n```\n---\n```asm\n\tldr r0, _08123210 @ =gPaletteFade\n\tldrb r1, [r0, 0x7]\n\tmovs r0, 0x80\n\tands r0, r1\n```\n```c\n\tr0 = (u8 *)(&gPaletteFade + 7) & 0x80;\n```\n---\n\n---\n```asm\n\tcmp r0, 0\n\tbne _0812320A\n```\n```c\n\tif (!r0) {\n```\n---\n```asm\n\tldr r0, _08123214 @ =sub_8123244\n\tbl SetMainCallback2\n```\n```c\n\t\tSetMainCallback2(&sub_8123244);\n```\n---\n```asm\n\tadds r0, r4, 0\n\tbl DestroyTask\n```\n```c\n\t\tDestroyTask(r4);\n```\n---\n```asm\n_0812320A:\n```\n```c\n\t}\n```\n---\n```asm\n\tpop {r4}\n\tpop {r0}\n\tbx r0\n```\n```c\n\treturn;\n```\nThe type signature of the function depends on the return type.\n* `bx r0`: `void`\n* `bx r1`: `*`\n* `bx lr`: `void`, `*`\n\nYou will need to look at the caller and the function prologue to determine the exact type if not void.\n\nSince it used `bx r0`, it's `void` for sure.\n\n---\n\nPutting it all together, we get:\n```c\nvoid sub_81231EC(u8 r4) {\n\tr0 = (u8 *)(&gPaletteFade + 7) & 0x80;\n\tif (!r0) {\n\t\tSetMainCallback2(&sub_8123244);\n\t\tDestroyTask(r4);\n\t}\n\treturn;\n}\n```\n\n\n## 4. Simplify and document\n\nThis line doesn't look quite right.\n\n```c\n\tr0 = (u8 *)(&gPaletteFade + 7) & 0x80;\n```\n\nWhat is `gPaletteFade`? You can find out where stuff is with `git grep`:\n\n```sh\ngit grep \"gPaletteFade\" include/\n```\n```grep\ninclude/palette.h:extern struct PaletteFadeControl gPaletteFade;\n```\n\nSo it's a struct called `PaletteFadeControl`. Let's look in `palette.h`:\n\n```c\nstruct PaletteFadeControl\n{\n u32 multipurpose1;\n u8 delayCounter:6;\n u16 y:5; // blend coefficient\n u16 targetY:5; // target blend coefficient\n u16 blendColor:15;\n u16 active:1;\n u16 multipurpose2:6;\n u16 yDec:1; // whether blend coefficient is decreasing\n u16 bufferTransferDisabled:1;\n u16 mode:2;\n u16 shouldResetBlendRegisters:1;\n u16 hardwareFadeFinishing:1;\n u16 softwareFadeFinishingCounter:5;\n u16 softwareFadeFinishing:1;\n u16 objPaletteToggle:1;\n u8 deltaY:4; // rate of change of blend coefficient\n};\n```\n---\n\nWhat's the 7th byte in this struct?\n```c\n u32 multipurpose1; // 0-3\n u8 delayCounter:6; // 4\n u16 y:5; // 5\n u16 targetY:5; // 5-6\n u16 blendColor:15; // 7\n u16 active:1; // 7\n```\n\nByte 7 has both `.blendColor` and `.active`.\n\n---\n\nOkay, what's 0x80 mean? It's `0b10000000`, which is the highest bit in a byte.\n\n`.active` comes after, which means it's higher, but it's also only one bit, so it's a safe bet.\n\n```c\n\tr0 = gPaletteFade.active;\n```\n\nMuch better.\n\n---\n\n```c\nvoid sub_81231EC(u8 r4) {\n\tr0 = gPaletteFade.active;\n\tif (!r0) {\n\t\tSetMainCallback2(&sub_8123244);\n\t\tDestroyTask(r4);\n\t}\n\treturn;\n}\n```\n\nNow the temp variable `r0` is a little pointless. We can simplify this to:\n\n```c\nvoid sub_81231EC(u8 taskId) {\n\tif (!gPaletteFade.active) {\n\t\tSetMainCallback2(&sub_8123244);\n\t\tDestroyTask(taskId);\n\t}\n}\n```\n\nLooks done, right?\nThis function is pretty simple, so it doesn't need any comments right now.\n\nBut what about `sub_8123244`? It's still not obvious what that function does. We can find out by decompiling it later.\n\n\n## 5. Build\n\n```sh\nmake\n```\n```gcc\nsrc/cable_car.c: In function `sub_81231EC':\nsrc/cable_car.c:4: `gPaletteFade' undeclared (first use in this function)\nsrc/cable_car.c:4: (Each undeclared identifier is reported only once for each function it appears in.)\nsrc/cable_car.c:5: warning: implicit declaration of function `SetMainCallback2'\nsrc/cable_car.c:5: `sub_8123244' undeclared (first use in this function)\nsrc/cable_car.c:6: warning: implicit declaration of function `DestroyTask'\n```\n\nWe got some errors. We need to tell the compiler what `gPaletteFade`, `SetMainCallback2`, `sub_8123244`, and `DestroyTask` are.\n\nWe know `gPaletteFade` is from `palette.h`. We can do the same with the others. Declare them above the function:\n```c\n#include \"palette.h\"\n#include \"main.h\"\n#include \"task.h\"\n```\nThe odd one out is `sub_8123244`, which is in `asm/cable_car.s`! What then?\n```c\nvoid sub_8123244();\n```\nNormally, we would do `extern void sub_8123244();`, but it won't be `extern` when we're done this file.\n\n---\n\nNow our file looks like this:\n```c\n#include \"global.h\"\n#include \"palette.h\"\n#include \"main.h\"\n#include \"task.h\"\n\nvoid sub_8123244();\n\nvoid sub_81231EC(u8 taskId) {\n\tif (!gPaletteFade.active) {\n\t\tSetMainCallback2(&sub_8123244);\n\t\tDestroyTask(taskId);\n\t}\n}\n```\n\n---\n\nBuild again, and we get:\n```sh\nmake\n```\n```sha1sum\npokeruby.gba: OK\n```\n\nThis means the function matches. Congratulations!\n\n---\n\nIf it doesn't match, you will get:\n```sha1sum\npokeruby.gba: FAILED\nsha1sum: WARNING: 1 computed checksum did NOT match\n```\n\n---\n\nIf you forgot to remove the function from `asm/cable_car.s`, you will get this error:\n```gcc\nasm/cable_car.o: In function `sub_81231EC':\n(.text+0x0): multiple definition of `sub_81231EC'\nsrc/cable_car.o:(.text+0x0): first defined here\n```\n\n\n## 6. Repeat until `asm/cable_car.s` is empty\n\nOnce you're done, you can delete `asm/cable_car.s`, and remove it from `ld_script.txt`.\n\n\n\n# Decompiling Rule\n\n* rule 1: when in doubt, scrub C\n* rule 2: never assume it won't get optimized out.\n* rule 3: when the answer is elusive, never rule out a typo.\n* rule 4: always be prepared to cram a square peg into a circle hole.\n* rule 5: if you still cant get it to match, its a combination that you think you tried before but you havent\n* rule 6: volatile is a dangerous magic sauce that may explode\n* rule 7: if you're afraid you need to use math, be\n* rule 8: if you think you understand the compiler, the compiler will tell you you don't\n* rule 10: rule 9 was optimized out\n\n\n# Resources Collection\n\n- [GitHub Help](https://help.github.com/en)\n- [Compiler Explorer](https://cexplore.karathan.at/z/KhyRi3) [Source Code](https://github.com/SBird1337/cexplore)\n- [Online Decompiler](https://feuniverse.us/t/use-free-online-service-to-assist-the-routine-analysis/3219) (Down now. Try [IDA](https://www.hex-rays.com/products/ida/) / [Ghidra](https://ghidra-sre.org/) / [RetDec](https://retdec.com/) instead.)\n- [Decomp Permuter](https://github.com/laqieer/decomp-permuter-arm)\n- [datadump & funchash](https://github.com/TwitchPlaysPokemon/pret3)\n- [Pokemon Projects](https://github.com/pret/pokeemerald)\n- [GCC online documentation](https://gcc.gnu.org/onlinedocs/)\n- [GCC 2.95 Features](https://gcc.gnu.org/gcc-2.95/features.html)\n"
},
{
"path": "Makefile",
"content": "#### Tools ####\n\nifeq ($(OS),Windows_NT)\n EXE := .exe\nelse\n EXE :=\nendif\n\nUNAME := $(shell uname)\n\nTOOLCHAIN ?= $(DEVKITARM)\nPREFIX ?= arm-none-eabi-\n\nexport PATH := $(TOOLCHAIN)/bin:$(PATH)\n\nifeq ($(UNAME),Darwin)\n\tSHELL := env PATH=$(PATH) /bin/bash\nendif\n\nCPP ?= $(PREFIX)cpp$(EXE)\nAS := $(PREFIX)as$(EXE)\nLD := $(PREFIX)ld$(EXE)\nOBJCOPY := $(PREFIX)objcopy$(EXE)\nSTRIP := $(PREFIX)strip$(EXE)\n\nCC1 := tools/agbcc/bin/agbcc$(EXE)\nCC1_OLD := tools/agbcc/bin/old_agbcc$(EXE)\n\nBIN2C := tools/bin2c/bin2c$(EXE)\nGBAGFX := tools/gbagfx/gbagfx$(EXE)\nSCANINC := tools/scaninc/scaninc$(EXE)\nAIF2PCM := tools/aif2pcm/aif2pcm$(EXE)\nMID2AGB := tools/mid2agb/mid2agb$(EXE)\nTEXTENCODE := tools/textencode/textencode$(EXE)\nJSONPROC := tools/jsonproc/jsonproc$(EXE)\nFETSATOOL := scripts/gfxtools/tsa_generator.py\nTMAP2TSA := scripts/tmap2tsa.py\nMARTOMAP := scripts/mar_to_map.py\n\nifeq ($(UNAME),Darwin)\n\tSED := sed -i ''\nelse\n\tSED := sed -i\nendif\n\nifeq ($(UNAME),Darwin)\n\tSHASUM := shasum\nelse\n\tSHASUM := sha1sum\nendif\n\nCC1FLAGS := -mthumb-interwork -Wimplicit -Wparentheses -Werror -O2 -fhex-asm -ffix-debug-line -g\nCPPFLAGS := -I tools/agbcc/include -iquote include -iquote . -nostdinc -undef\nASFLAGS := -mcpu=arm7tdmi -mthumb-interwork -I include\n\n#### Files ####\n\nC_SUBDIR = src\nASM_SUBDIR = asm\nDATA_SUBDIR = data\nDATA_SRC_SUBDIR = src/data\nSAMPLE_SUBDIR = sound/direct_sound_samples\nMID_SUBDIR = sound/songs/midi\nMAP_LAYOUT_SUBDIR = graphics/map/layout\n\nROM := fireemblem8.gba\nELF := $(ROM:.gba=.elf)\nMAP := $(ROM:.gba=.map)\nLDSCRIPT := ldscript.txt\nSYM_FILES := sym_iwram.txt\nCFILES_GENERATED := $(C_SUBDIR)/msg_data.c\nCFILES := $(wildcard $(C_SUBDIR)/*.c)\nifeq (,$(findstring $(CFILES_GENERATED),$(CFILES)))\nCFILES += $(CFILES_GENERATED)\nendif\nASM_S_FILES := $(wildcard $(ASM_SUBDIR)/*.s)\nSRC_S_FILES := src/rom_header.s src/crt0.s src/m4a_1.s src/libagbsyscall.s\nDATA_S_FILES := $(wildcard $(DATA_SUBDIR)/*.s)\nSOUND_S_FILES := $(wildcard sound/*.s sound/songs/*.s sound/songs/mml/*.s sound/voicegroups/*.s)\nSFILES := $(ASM_S_FILES) $(SRC_S_FILES) $(DATA_S_FILES) $(SOUND_S_FILES)\nSFILES_COMPILED := $(CFILES:.c=.s)\nC_OBJECTS := $(CFILES:.c=.o)\nASM_OBJECTS := $(SFILES:.s=.o)\nBANIM_OBJECT := data/banim/data_banim.o\nMID_FILES := $(wildcard $(MID_SUBDIR)/*.mid)\nMID_OBJECTS := $(MID_FILES:.mid=.o)\nALL_OBJECTS := $(C_OBJECTS) $(ASM_OBJECTS) $(BANIM_OBJECT) $(MID_OBJECTS)\nOBJECTS_LST := objects.lst\nDEPS_DIR := .dep\n\nAUTO_GEN_TARGETS :=\n\n# Use the older compiler to build library code\nsrc/agb_sram.o: CC1FLAGS := -mthumb-interwork -Wimplicit -Wparentheses -Werror -O1 -ffix-debug-line -g\nsrc/m4a.o: CC1 := $(CC1_OLD)\n\n# TODO: find a more elegant solution to the inlining issue\nsrc/bmitem.o: CC1FLAGS += -Wno-error\nsrc/menu_def.o: CC1FLAGS += -Wno-error\n\n#### Main Targets ####\n\ncompare: $(ROM)\n\t$(SHASUM) -c checksum.sha1\n\n.PHONY: compare\n\nCLEAN_FILES := $(ROM) $(ELF) $(MAP) $(OBJECTS_LST) $(SFILES_COMPILED) graphics/*.h $(CFILES_GENERATED)\nCLEAN_DIRS := $(DEPS_DIR)\nCLEAN_BINS := graphics/statscreen/*.bin $(SAMPLE_SUBDIR)/*.bin $(MAP_LAYOUT_SUBDIR)/*.bin $(AUTO_GEN_TARGETS)\nCLEAN_SONGS := $(MID_SUBDIR)/*.s\n\n# Shared clean routine\nclean_common:\n\t$(RM) $(CLEAN_FILES) $(CLEAN_BINS) $(CLEAN_SONGS)\n\t$(RM) -rf $(CLEAN_DIRS)\n\nclean_fast: clean_common\n\t$(RM) $(C_OBJECTS) $(ASM_OBJECTS) $(MID_OBJECTS)\n\t@find . \\( -iname '*.o' -o -iname '*.obj' -o -iname '*.feimg*.bin' -o -iname '*.fetsa*.bin' -o -iname '*.1bpp' -o -iname '*.4bpp' -o -iname '*.8bpp' -o -iname '*.gbapal' -o -iname '*.lz' -o -iname '*.fk' -o -iname '*.latfont' -o -iname '*.hwjpnfont' -o -iname '*.fwjpnfont' \\) -not -path './data/banim/*' -exec rm {} +\n\n.PHONY: clean_fast clean_common\n\nclean: clean_common\n\t$(RM) $(ALL_OBJECTS)\n\t# Remove battle animation binaries\n\t$(RM) -f data/banim/*.bin data/banim/*.o data/banim/*.lz data/banim/*.bak\n\t@find . \\( -iname '*.o' -o -iname '*.obj' -o -iname '*.feimg*.bin' -o -iname '*.fetsa*.bin' -o -iname '*.1bpp' -o -iname '*.4bpp' -o -iname '*.8bpp' -o -iname '*.gbapal' -o -iname '*.lz' -o -iname '*.fk' -o -iname '*.latfont' -o -iname '*.hwjpnfont' -o -iname '*.fwjpnfont' \\) -exec rm {} +\n\n.PHONY: clean\n\ntag:\n\tgtags\n\tctags -R\n\tcscope -Rbkq\n\n.PHONY: tag\n\n#### Recipes ####\n\n# Comprssed Texts Recipes\n\n# =========\n# = Texts =\n# =========\nTEXT_DIR := texts\nTEXT_TOOLS := scripts/texttools\n\nTEXT_DECODER := $(PYTHON) $(TEXT_TOOLS)/textdecoder.py\nTEXT_DPARSER := $(PYTHON) $(TEXT_TOOLS)/textdeparser.py\nTEXT_PROCESS := $(PYTHON) $(TEXT_TOOLS)/textprocess.py\n\nTEXT_MAIN := $(TEXT_DIR)/texts.txt\nTEXT_DEFS := $(TEXT_DIR)/textdefs.txt\nTEXT_SRC := $(TEXT_MAIN) $(shell find $(TEXT_DIR) -type f -name \"*.txt\")\n\nTEXT_HEADER := include/constants/msg.h\nMSG_LIST := src/msg_data.c\n\nsrc/msg_data.c: $(TEXT_SRC) $(TEXT_DEFS)\n\t@$(TEXT_PROCESS) $(TEXT_MAIN) $(TEXT_DEFS) $@ $(TEXT_HEADER) utf8\n\n# Graphics Recipes\n\ninclude graphics_file_rules.mk\ninclude songs.mk\ninclude json_data_rules.mk\n\n%.s: ;\n%.png: ;\n%.pal: ;\n%.aif: ;\n\n%.1bpp: %.png ; $(GBAGFX) $< $@\n%.4bpp: %.png ; $(GBAGFX) $< $@\n%.8bpp: %.png ; $(GBAGFX) $< $@\n%.gbapal: %.pal ; $(GBAGFX) $< $@\n%.gbapal: %.png ; $(GBAGFX) $< $@\n%.lz: % ; $(GBAGFX) $< $@\n%.rl: % ; $(GBAGFX) $< $@\n%.fk: % ; ./scripts/compressor.py $< fk\n%.bin: %.mar ; $(MARTOMAP) $< $@\nsound/%.bin: sound/%.aif ; $(AIF2PCM) $< $@\n\n%.4bpp.h: %.4bpp\n\t$(BIN2C) $< $(subst .,_,$(notdir $<)) | sed 's/^const //' > $@\n\n%.feimg1.bin %.fetsa1.bin: %.png\n\t$(FETSATOOL) $< $*.feimg1.bin $*.fetsa1.bin\n\n%.feimg2.bin %.fetsa2.bin: %.png\n\t$(FETSATOOL) $< $*.feimg2.bin $*.fetsa2.bin\n\n%.feimg3.bin %.fetsa3.bin: %.png\n\t$(FETSATOOL) $< $*.feimg3.bin $*.fetsa3.bin\n\n%.feimg4.bin %.fetsa4.bin: %.png\n\t$(FETSATOOL) $< $*.feimg4.bin $*.fetsa4.bin\n\n# Battle Animation Recipes\n\n$(BANIM_OBJECT): $(shell ./scripts/arm_compressing_linker.py -t linker_script_banim.txt -m)\n\t./scripts/arm_compressing_linker.py -o $@ -t linker_script_banim.txt -b 0x8c02000 -l $(LD) --objcopy $(OBJCOPY) -c ./scripts/compressor.py\n\n%_modes.bin: %_motion.o\n\t$(OBJCOPY) -O binary -j .data.modes $< $@\n\n%_oam_l.bin: %_motion.o\n\t$(OBJCOPY) -O binary -j .data.oam_l $< $@\n\n%_oam_r.bin: %_motion.o\n\t$(OBJCOPY) -O binary -j .data.oam_r $< $@\n\n# Automatic dependency generation\n\nMAKEDEP = mkdir -p $(DEPS_DIR)/$(dir $*) && $(CPP) $(CPPFLAGS) $< -MM -MG -MT $*.o > $(DEPS_DIR)/$*.d\n\nMAKECMDGOALS_NODEP := clean tag\n\nifeq (,$(filter $(MAKECMDGOALS),$(MAKECMDGOALS_NODEP)))\n-include $(addprefix $(DEPS_DIR)/,$(CFILES:.c=.d))\nendif\n\n$(DEPS_DIR)/%.d: %.c\n\t@$(MAKEDEP)\n\n$(OBJECTS_LST): $(ALL_OBJECTS)\n\t@echo $(ALL_OBJECTS) > $@\n\n$(ELF): $(ALL_OBJECTS) $(OBJECTS_LST) $(LDSCRIPT) $(SYM_FILES)\n\t$(LD) -T $(LDSCRIPT) -Map $(MAP) @$(OBJECTS_LST) -R $(BANIM_OBJECT).sym.o -L tools/agbcc/lib -o $@ -lc -lgcc\n\t$(STRIP) -N .gcc2_compiled. $@\n\n%.gba: %.elf\n\t$(OBJCOPY) --strip-debug -O binary --pad-to 0x9000000 --gap-fill=0xff $< $@\n\n$(C_OBJECTS): %.o: %.c $(DEPS_DIR)/%.d\n\t@$(MAKEDEP)\n\t$(CPP) $(CPPFLAGS) $< | iconv -f UTF-8 -t CP932 | $(CC1) $(CC1FLAGS) -o $*.s\n\techo '.ALIGN 2, 0' >> $*.s\nifeq ($(UNAME),Darwin)\n\t$(SED) -f scripts/align_2_before_debug_section_for_osx.sed $*.s\nelse\n\t$(SED) '/.section\t.debug_line/i\\.align 2, 0' $*.s\nendif\n\t$(AS) $(ASFLAGS) $*.s -o $@\n\nifeq ($(NODEP),1)\nasm/%.o: data_dep :=\nelse\nasm/%.o: data_dep = $(shell $(SCANINC) -I include -I \"\" $*.s)\nendif\n\nifeq ($(NODEP),1)\nsrc/%.o: data_dep :=\nelse\nsrc/%.o: data_dep = $(shell $(SCANINC) -I include -I \"\" $*.s)\nendif\n\nifeq ($(NODEP),1)\ndata/%.o: data_dep :=\nelse\ndata/%.o: data_dep = $(shell $(SCANINC) -I include -I \"\" $*.s)\nendif\n\nifeq ($(NODEP),1)\nbanim/%.o: data_dep :=\nelse\nbanim/%.o: data_dep = $(shell $(SCANINC) -I include -I \"\" $*.s)\nendif\n\nifeq ($(NODEP),1)\nsound/%.o: data_dep :=\nelse\nsound/%.o: data_dep = $(shell $(SCANINC) -I include -I \"\" $*.s)\nendif\n\n.SECONDEXPANSION:\n$(ASM_OBJECTS): %.o: %.s $$(data_dep)\n\t$(AS) $(ASFLAGS) -g $< -o $@\n%.lz:$(MAP_LAYOUT_SUBDIR)/%.bin ; $(GBAGFX) $< $@\n\n# Don't delete intermediate files\n.SECONDARY:\n\n# debug print, to use, call \"make print-(your label here)\"\nprint-% : ; $(info $* is a $(flavor $*) variable set to [$($*)]) @true"
},
{
"path": "README.md",
"content": "# Fire Emblem: The Sacred Stones\n\n[](http://makeapullrequest.com)\n\n[FE Decomp Portal](https://laqieer.github.io/fe-decomp-portal/)\n\nThis is a disassembly of Fire Emblem: The Sacred Stones (U)[!]\n\nIt builds the following ROM:\n* fireemblem8.gba `sha1: c25b145e37456171ada4b0d440bf88a19f4d509f`\n\n### Quick Start\n\nIf you just want to get the repo building quickly (Ubuntu/WSL, Arch Linux, or macOS/Homebrew), drop your legally obtained ROM at the repo root as `baserom.gba` and run:\n\n```\n./scripts/quickstart.sh [--rom /path/to/baserom.gba] [--refresh-agbcc]\n```\n\nSee [`docs/quickstart.md`](docs/quickstart.md) for full details, flags, and troubleshooting tips.\n\n### Building\n\nTo build the ROM:\n```bash\nmake fireemblem8.gba -j$(nproc)\n```\nTo clean all build artifacts:\n```bash\nmake clean\n```\nTo clean all build artifacts **except** the extremely slow battle animation compression outputs:\n```bash\nmake clean_fast\n```\n\n### Setting up the repository manually\n\n1. You must have a copy of the Fire Emblem: The Sacred Stones ROM named `baserom.gba` in the repository directory.\n2. Install [devkitPro](https://devkitpro.org/wiki/Getting_Started) or [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm).\n```\n# for Ubuntu/WSL users\napt install binutils-arm-none-eabi\n```\n3. Install [agbcc](https://github.com/pret/agbcc) to this project.\n```\ncd /path/to/agbcc\n./build.sh\n./install.sh /path/to/fireemblem8u\n```\n4. Build tools.\n```\ncd /path/to/fireemblem8u\n./build_tools.sh\n```\n5. Build the project.\n```\nmake\n```\n6. You will see this for success.\n```\nfireemblem8.gba: OK\n```\n\nQ: `fatal error: png.h: No such file or directory`\n\nA: Install [libpng](http://www.libpng.org/pub/png/libpng.html) to build `tools/gbagfx`.\n\nQ: `make: *** No rule to make target 'baserom.gba', needed by 'xxx'. Stop.`\n\nA: You must place a copy of the Fire Emblem: The Sacred Stones ROM named `baserom.gba` in the repository directory.\n\nQ: `unrecognized option '--add-symbol'`\n\nA: Update your devkitPro or embedded toolchain. Read [this](https://github.com/bminor/binutils-gdb/blob/3451a2d7a3501e9c3fc344cbc4950c495f30c16d/binutils/ChangeLog-2015#L120) for more info.\n\nQ: `.dep/src/xxx.d:2: *** missing separator. Stop.`\n\nA: `rm -rf .dep` or disable [VSCode Extension: Makefile Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.makefile-tools) if installed.\n\nCheck [INSTALL.md](https://github.com/pret/pokeruby/blob/master/INSTALL.md) and [INSTALL.md](https://github.com/pret/pokeemerald/blob/master/INSTALL.md) if you have trouble in setting up.\n\nCheck [remove_tools](https://github.com/laqieer/fireemblem8u/tree/remove_tools) branch if you don't want to build agbcc and other tools by yourself. It uses docker to make setting up easier. Follow its [README.md](https://github.com/laqieer/fireemblem8u/blob/remove_tools/README.md) instead.\n"
},
{
"path": "_site/index.html",
"content": "\n\n \n fireemblem8u\n \n \n \n \n\n"
},
{
"path": "asm/arm.s",
"content": "\t.INCLUDE \"macro.inc\"\n\n\t.SYNTAX UNIFIED\n\n\t.global ARMCodeToCopy_Start\nARMCodeToCopy_Start:\n\n.LPal: .4byte gPaletteBuffer @ pool\n.LFadeComponents: .4byte gFadeComponents @ pool\n.LFadeComponentStep: .4byte gFadeComponentStep @ pool\n\n\tARM_FUNC_START ColorFadeTick\nColorFadeTick: @ 0x08000234\n\tpush {r4, r5, r6, r7}\n\n\t@ r7 = start offset of next palette\n @ we start from the end, so palette 0x1F\n\tmov r7, 0x20 * 0x1F\n.Lpal_loop:\n\t @ r0 = gFadeComponentStep + pal_idx\n\tldr r0, .LFadeComponentStep\n\tadd r0, r0, r7, lsr #5\n\n\t@ r5 = component step for this palette\n\tldrsb r5, [r0]\n\n\t@ skip if step is 0\n\ttst r5, r5\n\tbeq .Lpal_loop_continue\n\n\tldr r4, .LFadeComponents\n\n\t@ r4 = r4 + 0x30 + r7 * 1.5\n\tlsr r0, r7, #1\n\tadd r0, r0, r0, lsl #1\n\tadd r0, r0, #0x30\n\tadd r4, r4, r0\n\n\t@ r6 = start offset of next color\n @ starting from the end again\n\tmov r6, #0x1e\n.Lcolor_loop:\n\tsub r4, r4, #3\n\n\t@ the clamp compares could be made branchless with some conditional operations\n @ eg: subs r0, 0x20 ; movlo r0, 0 ; cmp r0, 0x20 ; movhs r0, \n\n\t@ get, update and clamp red component (r0)\n\tldrb r0, [r4]\n\tadd r0, r0, r5\n\tstrb r0, [r4]\n\tsubs r0, r0, #0x20\n\tbpl 1f\n\tmov r0, #0\n1:\n\tcmp r0, #0x20\n\tblo 1f\n\tmov r0, #0x1f\n1:\n\n\t@ get, update and clamp green component (r1)\n\tldrb r1, [r4, #1]\n\tadd r1, r1, r5\n\tstrb r1, [r4, #1]\n\tsubs r1, r1, #0x20\n\tbpl 1f\n\tmov r1, #0\n1:\n\tcmp r1, #0x20\n\tblo 1f\n\tmov r1, #0x1f\n1:\n\n\t@ get, update and clamp blue component (r2)\n\tldrb r2, [r4, #2]\n\tadd r2, r2, r5\n\tstrb r2, [r4, #2]\n\tsubs r2, r2, #0x20\n\tbpl 1f\n\tmov r2, #0\n1:\n\tcmp r2, #0x20\n\tblo 1f\n\tmov r2, #0x1f\n1:\n\n\t@ get combined RGB5 color value\n\tadd r0, r0, r1, lsl #5\n\tadd r0, r0, r2, lsl #10\n\n\t@ store updated color to pal buffer\n\tldr r1, .LPal\n\tadd r1, r1, r6\n\tstrh r0, [r1, r7]\n\tsubs r6, r6, #2\n\tbpl .Lcolor_loop\n.Lpal_loop_continue:\n\tsubs r7, r7, #0x20\n\tbpl .Lpal_loop\n\tpop {r4, r5, r6, r7}\n\tbx lr\n\n\tARM_FUNC_END ColorFadeTick\n\n@ void ClearOam(void * buf, int count);\n\tARM_FUNC_START ClearOam\nClearOam: @ 0x08000304\n\tlsr r1, r1, #4\n\tsub r1, r1, #1\t\t@ count = count / 16 - 1\n\n\t@ set the y-coordinate of each OBJ to 160, which moves it offscreen\n\t@ This loop is unrolled to set 16 OBJs each iteration\n\tmov r2, #160\n1:\n\tstr r2, [r0, 8 * 0]\n\tstr r2, [r0, 8 * 1]\n\tstr r2, [r0, 8 * 2]\n\tstr r2, [r0, 8 * 3]\n\tstr r2, [r0, 8 * 4]\n\tstr r2, [r0, 8 * 5]\n\tstr r2, [r0, 8 * 6]\n\tstr r2, [r0, 8 * 7]\n\tstr r2, [r0, 8 * 8]\n\tstr r2, [r0, 8 * 9]\n\tstr r2, [r0, 8 * 10]\n\tstr r2, [r0, 8 * 11]\n\tstr r2, [r0, 8 * 12]\n\tstr r2, [r0, 8 * 13]\n\tstr r2, [r0, 8 * 14]\n\tstr r2, [r0, 8 * 15]\n\tadd r0, r0, 8 * 16\n\tsubs r1, r1, #1\n\tbpl 1b\n\tbx lr\n\n\tARM_FUNC_END ClearOam\n\n/*\nu32 Checksum32(const u32 * buf, int size)\n{\n\tint i;\n\tfor (i = 0; i < size / 4; i++)\n\t{\n\t\tadd_acc += data_u32[i];\n\t\txor_acc ^= data_u32[i];\n\t}\n\treturn (u16)add_acc + ((u16)xor_acc << 0x10);\n}\n*/\n\tARM_FUNC_START Checksum32\nChecksum32: @ 0x08000360\n\tpush {r4, r5, r6, r7}\n\tsub r1, r1, #2\t\t@ r1 = len\n\tmov r2, #0\t\t\t@ r2 = add_acc\n\tmov r3, #0\t\t\t@ r3 = xor_acc\n1:\n\tldrh r4, [r0]\n\tadd r2, r2, r4\t\t@ r2 = add_acc += data_u32[i]\n\teor r3, r3, r4\t\t@ r3 = xor_acc ^= data_u32[i]\n\tadd r0, r0, #2\n\tsubs r1, r1, #2\n\tbpl 1b\n\n\tmov r0, #0x10000\n\tsub r0, r0, #1\t\t@ 0xFFFF\n\tand r2, r2, r0\n\tlsl r3, r3, #0x10\n\tmov r0, r2\n\tadd r0, r0, r3\t\t@ return (u16)add_acc + ((u16)xor_acc << 0x10)\n\tpop {r4, r5, r6, r7}\n\tbx lr\n\n\tARM_FUNC_END Checksum32\n\n/*\nvoid TmFillRect(u16 * dest, int width, int height, int fillValue)\n{\n\tint i, j;\n\tfor (i = 0; i < height; i++)\n\t\tfor (j = 0; j < width; j++)\n\t\t\tdst[j + 0x20 * i] = fillValue;\n}\n*/\n\tARM_FUNC_START TmFillRect\nTmFillRect: @ 0x080003A8\n\tpush {r4, r5, r6, r7}\n\tmov r4, r0\n\tsub r6, r2, #0\n 1:\n\tsub r5, r1, #0\n 2:\n\tstrh r3, [r4]\n\tadd r4, r4, #2\n\tsubs r5, r5, #1\t\t@ decrement width counter\n\tbpl 2b\n\tadd r0, r0, #0x40\n\tmov r4, r0\n\tsubs r6, r6, #1\t\t@ decrement height counter\n\tbpl 1b\n\tpop {r4, r5, r6, r7}\n\tbx lr\n\n\tARM_FUNC_END TmFillRect\n\n/*\nvoid TmCopyRect(u16 * src, u16 * dst, int width, int height)\n{\n\tint i, j;\n\tfor (i = 0; i < height; i++)\n\t\tfor (j = 0; j < width; j++)\n\t\t\tdst[j + 0x20 * i] = src[j + 0x20 * i];\n}\n*/\n\tARM_FUNC_START TmCopyRect\nTmCopyRect: @ 0x080003E0\n\tpush {r4, r5, r6, r7}\n\ttst r2, r2\n\tbeq .LCopyRectEnd\n\tbmi .LCopyRectEnd\n\ttst r3, r3\n\tbeq .LCopyRectEnd\n\tbmi .LCopyRectEnd\n\tmov r4, #0x40\n\tsub r4, r4, r2, lsl #1\n\tsub r6, r3, #1\n1:\n\tsub r5, r2, #1\n2:\n\t@ *dst++ = *src++\n\tldrh r7, [r0]\n\tstrh r7, [r1]\n\tadd r0, r0, #2\n\tadd r1, r1, #2\n\tsubs r5, r5, #1\n\tbpl 2b\n\tadd r0, r0, r4\n\tadd r1, r1, r4\n\tsubs r6, r6, #1\n\tbpl 1b\n.LCopyRectEnd:\n\tpop {r4, r5, r6, r7}\n\tbx lr\n\n\tARM_FUNC_END TmCopyRect\n\n/*\nstruct TillMapArrangement {\n\tu8 width, height;\n\tu16 data[];\n};\n\nvoid TmApplyTsa(u16 * tilemap, const void * _tsa, int tileref)\n{\n\tconst struct TillMapArrangement * tsa = _tsa;\n\tint width = tsa->width;\n\tint height = tsa->height;\n\tu16 * src = tsa->data;\n\tu16 * dst = TILEMAP_LOCATED(tilemap, height, 0); // dest is set from the bottom to top\n\n\tint w, h;\n\tfor (h = height; h >= 0 ; h--)\n\t{\n\t\tfor (w = width; w >= 0 ; w--)\n\t\t{\n\t\t\t*dst = *src + tileref;\n\t\t\tdst++;\n\t\t\tsrc++;\n\t\t}\n\n\t\tdst = dst - width - 1 - 0x20;\n\t}\n}\n*/\n\tARM_FUNC_START TmApplyTsa\nTmApplyTsa: @ 0x0800043C\n\tpush {r4, r5, r6, r7}\n\tldrb r3, [r1]\t\t@ r3 = width = tsa->width\n\tldrb r4, [r1, #1]\t@ r4 = height = tsa->height\n\tadd r1, r1, #2\t\t@ r1 = src = tsa->data\n\tlsl r7, r4, #6\n\tadd r0, r0, r7\t\t@ dst = TILEMAP_LOCATED(tilemap, height, 0);\n\tmov r6, r4\n1:\n\tmov r5, r3\n2:\n\tldrh r7, [r1]\n\tadd r7, r7, r2\n\tstrh r7, [r0]\n\tadd r0, r0, #2\n\tadd r1, r1, #2\n\tsubs r5, r5, #1\n\tbpl 2b\n\tsub r0, r0, r3, lsl #1\n\tsub r0, r0, #0x42\n\tsubs r6, r6, #1\n\tbpl 1b\n\tpop {r4, r5, r6, r7}\n\tbx lr\n\n\t.align 2, 0\n\tARM_FUNC_END TmApplyTsa\n\n@ void PutOamHi(int x, int y, u16 const * oam_list, int oam2)\n.LOamHiPutIt: .4byte gOamHiPutIt @ pool\n\tARM_FUNC_START PutOamHi\nPutOamHi: @ 0x08000494\n\tpush {r4, r5, r6, r7}\n\tldr r7, .LOamHiPutIt\n.LPutOamExt:\n\tldr r5, [r7]\t\t\t\t@ r5 = dst\n\tldrh r4, [r2]\t\t\t\t@ r4 = count = *oam_list;\n\ttst r4, r4\n\tbeq .LPutOamEnd\n\tbmi .LPutOamEnd\n\tadd r2, r2, #2\t\t\t\t@ src = oam_list + 1;\n\tadd r6, r5, r4, lsl #3\n\tstr r6, [r7]\t\t\t\t@ *pdst = *pdst + count;\n\tmov r7, #0x10000\n\tsub r7, r7, #1\n\tand r0, r0, r7\n\tand r1, r1, r7\n\torr r0, r0, r1, lsl #16\n.LPutOamLoop:\n\t@ ATTR0 = src[0]\n\t@ ATTR0::Y = y\n\tldrh r1, [r2]\n\torr r6, r1, r0, lsr #16\n\tand r6, r6, #0xff00\n\tadd r7, r1, r0, lsr #16\n\tand r7, r7, #0xff\n\torr r6, r6, r7\n\tstrh r6, [r5]\n\n\t@ ATTR1 = src[1]\n\t@ ATTR1::X = x\n\tldrh r1, [r2, #2]\n\torr r6, r1, r0\n\tand r6, r6, #0xfe00\n\tadd r7, r1, r0\n\tlsl r7, r7, #0x17\n\tlsr r7, r7, #0x17\n\torr r6, r6, r7\n\tstrh r6, [r5, #2]\n\n\t@ ATTR2 = src[2] + oam2\n\tldrh r1, [r2, #4]\n\tadd r6, r1, r3\n\tstrh r6, [r5, #4]\n\n\tadd r2, r2, #6\t\t@ src = src + 3;\n\tadd r5, r5, #8\t\t@ dst++;\n\tsubs r4, r4, #1\n\tbne .LPutOamLoop\n.LPutOamEnd:\n\tpop {r4, r5, r6, r7}\n\tbx lr\n\t.align 2, 0\n\tARM_FUNC_END PutOamHi\n\n.LOamLoPutIt: .4byte gOamLoPutIt @ pool\n\n@ void PutOamLo(int x, int y, u16 const * oam_list, int oam2)\n\tARM_FUNC_START PutOamLo\nPutOamLo: @ 0x08000534\n\tpush {r4, r5, r6, r7}\n\tldr r7, .LOamLoPutIt\n\tb .LPutOamExt\n\tARM_FUNC_END PutOamLo\n\nbitTable:\n\t.4byte (1 << 0)\n\t.4byte (1 << 2)\n\t.4byte (1 << 4)\n\t.4byte (1 << 6)\n\t.4byte (1 << 8)\n\t.4byte (1 << 10)\n\t.4byte (1 << 12)\n\t.4byte (1 << 14)\n\nlt_bitTable: .4byte bitTable @ pool\n\n@ void DrawGlyph(u16 * pal, u32 * dst, u32 * src, int subx)\n\tARM_FUNC_START DrawGlyph\nDrawGlyph: @ 0x08000564\n\tpush {r4, r5, r6, r7, r8, r9, sl}\n\tmov r9, #0xf\n\tmov sl, #0x10000\n\tsub sl, sl, #1\n_08000574:\n\t@ u64 ref = src[i] * (1 <<