Leahnaya/Flips
1
0
Fork 0
mirror of https://github.com/Alcaro/Flips.git synced 2026-04-24 23:10:45 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update --help and readme a bit

Browse Source
This commit is contained in:
Alcaro 2017-05-18 12:06:31 +02:00
parent c7848c0ac4
commit 094a48b850
2 changed files with 17 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,19 +2,19 @@ Floating IPS is a patcher for IPS and BPS files, aiming for a simple interface y
Features:
- Creates the smallest BPS patches of any known tool in existence, and is faster than any other comparable creator
- Creates the smallest IPS patches of any known tool in existence, too (but only yields tiny gains over Lunar IPS)
- Creates the smallest IPS patches of any known tool in existence, too (but only a little smaller, Lunar IPS is quite good)
- Fully-featured GUIs under Windows and GTK+, including command line support; can also be a pure command line program
- Can apply multiple patches to the same ROM, and creates a huge pile of ROMs
- Remembers which ROMs you've used, and will use them again if it thinks it's correct (BPS only)
- Can launch emulators after patching the ROMs (combined with the above, this allows you to double click a BPS to launch its ROM)
- Can apply multiple patches to the same ROM, creating a huge pile of ROMs (GUI only)
- Remembers which ROMs you've used, and will use them again if it thinks it's correct (BPS only, GUI only)
- Can launch other programs after patching the ROMs, allowing you to double click a BPS to launch an emulator (GUI only)
Planned:
- Automatically enable ROM guesser (open a message box the first time it guesses a ROM, asking if you want that)
- Different emulators for different filetypes (check the extension)
- Better support for ROM database in CLI; the -d flag, or DB enabling from the GUI (for pure-CLI, existence of flipsdb.bin file beside Flips), will store ROMs in the database; the filename "-" will read from it, and "wrong ROM" will look for the right one (but not automatically use it)
- Different emulators for different filetypes (check the extension, or default to the OS default handler?)
- Better support for ROM database in CLI; the -d flag, or DB enabling from the GUI (for pure-CLI, existence of flipsdb.bin file beside Flips), will store ROMs in the database; the filename "." will read from it, and "wrong ROM" will look for the right one (but not automatically use it)
- Use path of patch as output filename, not the ROM path
- Better autodetection for command line; if the first two files have same extension, create, else apply
Not planned (if your plans are different, send a PR):
- Non-console OSX support; I don't have the right hardware
- Qt support; my distro prefers GTK+, and all distros I've seen can run both GTK+ and Qt (and QString's UTF-16 irritates me)
- OSX GUI support; I don't have the right hardware
- Qt GUI support; my distro prefers GTK+, and all distros I've seen can run both GTK+ and Qt, not worth the effort (and QString's UTF-16 irritates me)

23
flips.cpp
View File

@ -934,34 +934,29 @@ void usage()
" "
#ifndef FLIPS_CLI
"flips\n"
"or flips patch.ips\n"
"or flips patch.bps\n"
"or "
#endif
"flips [--apply] [--exact] patch.bps rom.smc [outrom.smc]\n"
"or flips [--create] [--exact] [--bps | --bps-linear | --ips] clean.smc\n"
" hack.smc [patch.bps]\n"
#ifndef FLIPS_CLI
"(for scripting, only the latter two are sensible)\n"
#endif
"(patch.ips is valid in all cases patch.bps is)\n"
"or flips [--create] [--exact] [--bps | etc] clean.smc hack.smc [patch.bps]\n"
"\n"
// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
"options:\n"
"-a --apply: apply patch (default if given two arguments)\n"
"-c --create: create patch (default if given three arguments)\n"
"-I --info: BPSes contain information about input and output roms, print it\n"
"-a --apply: apply IPS, BPS or UPS patch (default if given two arguments)\n"
"-c --create: create IPS or BPS patch (default if given three arguments)\n"
"-I --info: BPS files contain information about input and output roms, print it\n"
//" also estimates how much of the source file is retained\n"
//" anything under 400 is fine, anything over 600 should be treated with suspicion\n"
//(TODO: --info --verbose)
"-i --ips, -b -B --bps --bps-delta, --bps-linear, --bps-delta-moremem:\n"
"-i --ips, -b -B --bps --bps-delta, --bps-delta-moremem, --bps-linear:\n"
" create this patch format instead of guessing based on file extension\n"
" ignored when applying\n"
" bps formats:\n"
" delta is the recommended one; it's a good balance between creation time and\n"
" patch size\n"
" -b and -B both refer to this, for backwards compatibility reasons\n"
" delta-moremem is usually slightly faster than delta, but uses about twice\n"
" as much memory; it gives identical patches to delta\n"
" the shorter forms all refer to this, for backwards compatibility reasons\n"
" delta-moremem is usually slightly (~3%) faster than delta, but uses about\n"
" twice as much memory; it gives identical patches to delta\n"
" linear is the fastest, but tends to give pretty big patches\n"
"--exact: do not remove SMC headers when applying or creating a BPS patch\n"
" (ignored for IPS)\n"