File names

[Eebit]

I have been thinking recently about the file names in the repository.

During the last little while of working on the decompilation, we have mostly left the file names alone if they had already been split from code (e.g. bmmind, koido, bksel). It's my general understanding that the source of those file names came from the prototypes. However, the current names don't lend themselves very well to someone who is looking to understand, say, how the battle forecast is implemented, or whether it has been decompiled (it has been in bksel.c, for reference).

Would people who use this repo be in favour of us taking a cue from the FE6 decompilation (and Nat's fork of FE8) and doing a pass of renaming files with names that better reflect their purpose?

For example:

• bmmind -> action
• bksel -> battle_forecast
• bb -> subtitle_help
• koido -> rescue_transfer (or combine with other files into bmfx, as in FE6)
• etc.

PRs like #442 move us in the direction of friendlier names, and I like the idea of being consistent with FE6 where possible.

A secondary goal of this issue would be to decide to standardize on hyphens vs. underscores in the file names, since there is a bit of a mix currently.

[CT075]

Personally I think that, if we can get a rough consensus that friendlier names are a good idea in general, it's easiest to just make the PR and be done with it.

I am completely for better names (god knows how much trouble I have finding things), but I also am not a fan of name bikeshedding.

[Veslyquix]

I just reference the decomp a lot, but easier names would be really nice. Also, do we really need bm in front of everything?

[GigaExcalibur]

As someone who references the decomp, I support friendlier names. Their greater ease of use, in my opinion at least, vastly outweighs the consistency with the prototype ROM.

Specifically seconding the question about why bm is in front of a lot of file names as well.

[laqieer]

I agree with friendlier names.

As a community project with some existing users, we need to consider more than developers' personal preferences. Friendlier names are good, but we are supposed to be careful to do breaking changes.

However, if something is really hard to understand and has caused real trouble, and it brings more benefits than costs to make a change, let's change it.

I list all file names in prototype here for discussion.

$ $DEVKITARM/bin/arm-none-eabi-strings.exe 0011\ -\ Fire\ Emblem\ -\ Seima\ no\ Kouseki\ \(Japan\)\ \(Beta\).gba | grep '.\.c$'
main.c
fe3_dummy.c
hardware.c
dma.c
soundwrapper.c
ramfunc.c
proc.c
icon.c
fontgrp.c
animedrv.c
ctc.c
face.c
ap.c
gamectrl.c
messdecode.c
spline.c
evtcmd_gmap.c
event.c
evtscr.c
evtsub.c
hino.c
bm.c
bmitem.c
bmunit.c
bmmap.c
bmidoten.c
bmdebug.c
bmfx.c
bmmenu.c
bmudisp.c
bmreliance.c
bmufx.c
bmbattle.c
bmtrade.c
bmtrick.c
bmusemind.c
bmio.c
bmcontainer.c
bmusort.c
bmarena.c
bmmind.c
bmtrap.c
bmarch.c
bmdifficulty.c
cpdecide.c
cpperform.c
cpsub.c
cpdatsub.c
cpcustom.c
siobtl.c
siobmain.c
winmenu.c
battleunit.c
battlemagic.c
battleopinfo.c
dbattlefx.c
demyrand.c
mu.c
muctrl.c
onbt.c
onbtfx.c
case.c
evt_com.c
evt_bmap.c
evt_tuto.c
evt_L00.c
evt_L01.c
evt_L02.c
evt_L03.c
evt_L04.c
evt_L05.c
evt_L06.c
evt_L07.c
evt_L08.c
evt_E09.c
evt_E10.c
evt_E11.c
evt_E12.c
evt_E13.c
evt_E14.c
evt_E15.c
evt_E16.c
evt_E17.c
evt_E18.c
evt_E19.c
evt_E20.c
evt_I09.c
evt_I10.c
evt_I11.c
evt_I12.c
evt_I13.c
evt_I14.c
evt_I15.c
evt_I16.c
evt_I17.c
evt_I18.c
evt_I19.c
evt_I20.c
evt_T01-T10.c
evt_R01-R10.c
evt_C00.c
evt_H00.c
evt_D00.c
evt_ending.c
curinfo.c
atmenu.c
atselect.c
augury_rank.c
augury_sien.c
senseki_pass.c
backup.c
bupfile.c
bupintr.c
bupcert.c
download.c
gmapdt.c
ending_comp.c
free_map.c
gmap_scr.c
gmap_unit.c
gmap_base.c
gmap_cur.c
gmap_route.c
gmap_work.c
gmap_mu.c
gmap_pinfo.c
gmap_evt.c
gmap_jyokyo.c
gmap_effect.c
STUWgmap_tmb.c
gmap_rm.c
gmap_amu.c
gmap_bmenu.c
o5.c

[zyntm]

I have been thinking recently about the file names in the repository.

During the last little while of working on the decompilation, we have mostly left the file names alone if they had already been split from code (e.g. bmmind, koido, bksel). It's my general understanding that the source of those file names came from the prototypes. However, the current names don't lend themselves very well to someone who is looking to understand, say, how the battle forecast is implemented, or whether it has been decompiled (it has been in bksel.c, for reference).

Would people who use this repo be in favour of us taking a cue from the FE6 decompilation (and Nat's fork of FE8) and doing a pass of renaming files with names that better reflect their purpose?

For example:

• bmmind -> action
• bksel -> battle_forecast
• bb -> subtitle_help
• koido -> rescue_transfer (or combine with other files into bmfx, as in FE6)
• etc.

PRs like #442 move us in the direction of friendlier names, and I like the idea of being consistent with FE6 where possible.

A secondary goal of this issue would be to decide to standardize on hyphens vs. underscores in the file names, since there is a bit of a mix currently.

It would be nice to write a document for these friendlier names :)
By the way, do you kown what is the word "Ekr" meaning int the code? Such as "banim-ekrbattle.c", "gEkrGaugeHp"