[BACK]Return to README.md CVS log [TXT][DIR] Up to [local] / projects / fnaify

Annotation of projects/fnaify/README.md, Revision 1.26

1.17      thfr        1: FNAIFY(1) - General Commands Manual
1.1       thfr        2:
1.17      thfr        3: # NAME
1.1       thfr        4:
1.20      thfr        5: **fnaify** - run FNA/XNA games on OpenBSD
1.1       thfr        6:
1.17      thfr        7: # SYNOPSIS
                      8:
                      9: **fnaify**
                     10: \[**-i** | **-y**]
                     11: \[**-hv**]
1.21      thfr       12: \[**-c** *configfile*]
1.17      thfr       13: \[**-d** *depdir*]
                     14: \[**-m** *monopath*]
                     15: \[*gamedir*]
                     16:
                     17: # DESCRIPTION
                     18:
                     19: **fnaify**
                     20: sets up games based on the FNA engine to operate with OpenBSD-native
1.18      thfr       21: libraries and its
                     22: mono(1)
                     23: runtime.
1.17      thfr       24:
                     25: As of version 2.0,
                     26: **fnaify**
                     27: has been extended to attempt configuring XNA games as well.
                     28: **fnaify**
1.18      thfr       29: can be run in 3 basic modes regarding the addition of missing libraries:
                     30: restrictive, interactive, and permissive.
1.17      thfr       31:
                     32: The arguments are as follows:
                     33:
                     34: **-i** | **-y**
                     35:
                     36: > The mode determines how
                     37: > **fnaify**
                     38: > handles situations where compatibility problems are identified that can
                     39: > be addressed with drop-in DLL replacements, or where an option needs to
                     40: > be selected.
                     41: > With
1.18      thfr       42: > **-i**,
1.17      thfr       43: > **fnaify**
                     44: > runs in interactive mode, meaning the user will be prompted in every
                     45: > case.
                     46: > With
1.18      thfr       47: > **-y**,
1.17      thfr       48: > **fnaify**
1.18      thfr       49: > runs in permissive mode
                     50: > (**-y**
1.17      thfr       51: > for
                     52: > "yes"
1.18      thfr       53: > to all)
                     54: > .
                     55: > This means that any suggested drop-in DLLs will be installed,
1.17      thfr       56: > and if different options are possible (like picking among several .exe
                     57: > files for the launch script), the first one will be selected
                     58: > automatically.
                     59: > If neither
                     60: > **-i**
                     61: > nor
                     62: > **-y**
                     63: > is specified,
                     64: > **fnaify**
                     65: > runs in restrictive mode, that is no drop-in DLLs will be installed.
                     66:
1.21      thfr       67: **-c** *configfile*
                     68:
                     69: > Optional. Use
                     70: > *configfile*
                     71: > for the configuration of
                     72: > mono(1).
                     73: > This sets up dllmap/dllentry settings to use the correct libraries. See
                     74: > mono-config(5)
                     75: > for details. If this option is omitted,
                     76: > **fnaify**
                     77: > looks first for
1.23      thfr       78: > *~/.config/fnaify/fnaify.dllmap.config*
1.21      thfr       79: > and then for
1.23      thfr       80: > */usr/local/share/fnaify/fnaify.dllmap.config*.
1.21      thfr       81: > If neither one is found,
                     82: > **fnaify**
                     83: > creates
                     84: > *~/.config/fnaify/fnaify.dllmap.config*
                     85: > with default settings.
                     86:
1.17      thfr       87: **-d** *depdir*
                     88:
                     89: > Add
                     90: > *depdir*
1.18      thfr       91: > to the directories to search for native library dependencies.
                     92: > A directory specified this way will be searched
1.17      thfr       93: > *before*
1.18      thfr       94: > the default locations
                     95: > (*/usr/local/lib* etc.).
1.17      thfr       96:
                     97: **-m** *monopath*
                     98:
                     99: > Add
                    100: > *monopath*
1.18      thfr      101: > to the directories the
                    102: > mono(1)
                    103: > runtime will search for DLLs.
1.17      thfr      104:
                    105: **-h**
                    106:
                    107: > Prints help text.
                    108:
                    109: **-v**
                    110:
                    111: > Verbose mode.
                    112:
                    113: *gamedir*
                    114:
1.18      thfr      115: > Optional.
                    116: > Path to the game directory to process.
                    117: > If not specified, the current working directory will be used.
1.17      thfr      118:
                    119: # SUPPORTED GAMES
                    120:
                    121: The Adventures of Shuggy
1.20      thfr      122: Akane the Kunoichi
                    123: Amazing Princess Sarah
1.17      thfr      124: Apotheon
1.20      thfr      125: Apple Jack 1&2
1.17      thfr      126: Bleed
                    127: Bleed 2
                    128: Breath of Death VII
                    129: Brushwood Buddies
                    130: Capsized
                    131: Chaos Heart
                    132: Charlie Murder
                    133: Chasm
                    134: CometStriker
                    135: Cryptark
                    136: Cthulhu Saves the World
                    137: Curse of the Crescent Isle DX
                    138: Dad Quest
1.20      thfr      139: Dead Pixels
1.17      thfr      140: Dead Pixels II
                    141: The Dishwasher: Vampire Smile
1.20      thfr      142: Draw a Stickman: EPIC
1.17      thfr      143: Dust: An Elysian Tail
                    144: Escape Goat
                    145: Escape Goat 2
1.20      thfr      146: Explosionade
1.17      thfr      147: FEZ
                    148: Fist Puncher
                    149: Flinthook
                    150: Flotilla
1.20      thfr      151: Game Type
1.17      thfr      152: Gateways
1.20      thfr      153: Grand Class Melee 2
1.17      thfr      154: Growing Pains
                    155: HackNet
                    156: Hive
                    157: Hyphen
                    158: Jon Shafer's At the Gates
                    159: LaserCat
                    160: Mercenary Kings
1.19      thfr      161: Mount Your Friends
1.17      thfr      162: Ninja Warrior
                    163: One Finger Death Punch
                    164: Overdriven Reloaded
                    165: Owlboy
                    166: Paladin
                    167: Penny Arcade's On the Rain-Slick Precipice of Darkness 3
                    168: Penny Arcade's On the Rain-Slick Precipice of Darkness 4
1.20      thfr      169: Phoenix Force
1.17      thfr      170: Press X to Not Die
                    171: Rex Rocket
                    172: Rogue Legacy
                    173: Salt and Sanctuary
                    174: Shipwreck
                    175: Skulls of the Shogun
                    176: Soulcaster 1 & 2
                    177: SpeedRunners
                    178: Stardew Valley
                    179: Sumico
                    180: Super Amazing Wagon Adventure
1.19      thfr      181: Super Blood Hockey
1.17      thfr      182: Super Rad Raygun
1.19      thfr      183: Sword of the Stars: The Pit
1.25      thfr      184: Terraria
1.17      thfr      185: Timespinner
                    186: TowerFall: Ascension
                    187: Unexplored
                    188: Unholy Heights (no audio)
                    189: The Useful Dead
1.20      thfr      190: Weapon of Choice
1.17      thfr      191: Wizorb
                    192: Wyv and Keep
                    193:
                    194: # FILES
                    195:
1.24      thfr      196: */usr/local/share/fnaify/fnaify.dllmap.config*
1.21      thfr      197:
1.24      thfr      198: > Default configuration file to map DLLs to native libraries.
1.21      thfr      199:
1.24      thfr      200: *~/.config/fnaify/fnaify.dllmap.config*
1.17      thfr      201:
1.24      thfr      202: > User directory configuration file. Takes precedence if it exists.
1.17      thfr      203:
                    204: # EXIT STATUS
                    205:
                    206: **fnaify**
                    207: returns 1 if an error occurred with the arguments of files provided,
                    208: otherwise 0.
                    209:
                    210: # EXAMPLES
                    211:
                    212: Run in permissive mode, suitable to set up most supported games
                    213: automatically.
                    214:
                    215:        $ fnaify -y path/to/game/directory
                    216:
                    217: Run in interactive mode.
                    218: **fnaify**
                    219: will prompt the user if any additional DLLs are recommended, or if a
                    220: file needs to be selected for the launch script.
                    221:
                    222:        $ fnaify -i path/to/game/directory
                    223:
                    224: # SEE ALSO
                    225:
1.21      thfr      226: mono(1),
                    227: mono-config(5)
1.17      thfr      228:
                    229: # HISTORY
                    230:
                    231: The
                    232: **fnaify**
                    233: utility was originally created in December 2017 by
1.21      thfr      234: Thomas Frohwein <[thfr@openbsd.org](mailto:thfr@openbsd.org)>.
1.17      thfr      235:
                    236: # RELEASE HISTORY
                    237:
1.22      thfr      238: 2\.1
                    239:
1.26    ! thfr      240: > Support for additional XNA games. Add MONO\_FORCE\_COMPAT quirk.
1.22      thfr      241:
1.17      thfr      242: 2\.0
                    243:
1.18      thfr      244: > Add support for XNA games.
                    245: > Introduce modes
1.17      thfr      246: > **-i** | **-y**
                    247: > to facilitate adding in needed assemblies/libraries.
                    248:
                    249: 1\.3
                    250:
1.18      thfr      251: > Add prompt to download and replace
                    252: > *FNA.dll*
                    253: > if incompatible version is found.
                    254: > Detect steamstubs directory and use Steamworks stubs if present.
1.17      thfr      255:
                    256: 1\.2
                    257:
                    258: > FreeBSD portability fixes, account for more special cases (MidBoss,
                    259: > Adventures of Shuggy, Atom Zombie Smasher), add directory path to plug
                    260: > in additional libraries.
                    261:
                    262: 1\.1
                    263:
                    264: > Fix bug selecting .exe by separating input variables.
                    265:
                    266: 1\.0
                    267:
                    268: > Initial release.
                    269:
                    270: # AUTHORS
                    271:
                    272: Thomas Frohwein <[thfr@openbsd.org](mailto:thfr@openbsd.org)>
                    273:
1.26    ! thfr      274: OpenBSD 6.6 - November 11, 2019

Contact: <mail@mail.thfr.info>