Annotation of projects/fnaify/fnaify.1, Revision 1.1
1.1 ! thfr 1: .Dd $Mdocdate: September 21 2019 $
! 2: .Dt FNAIFY 1
! 3: .Os
! 4: .Sh NAME
! 5: .Nm fnaify
! 6: .Nd script to get FNA-based games ready to run on OpenBSD
! 7: .Sh SYNOPSIS
! 8: .Nm
! 9: .Op Fl i | y
! 10: .Op Fl hv
! 11: .Op Fl d Ar depdir
! 12: .Op Fl m Ar monopath
! 13: .Op Ar gamedir
! 14: .Sh DESCRIPTION
! 15: .Nm
! 16: sets up games based on the FNA engine to operate with OpenBSD-native
! 17: libraries and its mono(1) runtime.
! 18: .Pp
! 19: As of version 2.0,
! 20: .Nm
! 21: has been extended to attempt configuring XNA games as well.
! 22: .Nm
! 23: can be run in 3 basic modes regarding the addition of missing libraries
! 24: - restrictive, interactive, and permissive.
! 25: .Pp
! 26: The arguments are as follows:
! 27: .Bl -tag -width Ds
! 28: .It Fl i | y
! 29: The mode determines how
! 30: .Nm
! 31: handles situations where compatibility problems are identified that can
! 32: be addressed with drop-in DLL replacements, or where an option needs to
! 33: be selected.
! 34: With
! 35: .Fl i
! 36: ,
! 37: .Nm
! 38: runs in interactive mode, meaning the user will be prompted in every
! 39: case.
! 40: With
! 41: .Fl y
! 42: ,
! 43: .Nm
! 44: runs in permissive mode (
! 45: .Fl y
! 46: for
! 47: .Qq yes
! 48: to all). This means that any suggested drop-in DLLs will be installed,
! 49: and if different options are possible (like picking among several .exe
! 50: files for the launch script), the first one will be selected
! 51: automatically.
! 52: If neither
! 53: .Fl i
! 54: nor
! 55: .Fl y
! 56: is specified,
! 57: .Nm
! 58: runs in restrictive mode, that is no drop-in DLLs will be installed.
! 59: .It Fl d Ar depdir
! 60: Add
! 61: .Ar depdir
! 62: to the directories to search for native library dependencies. A
! 63: directory specified this way will be searched
! 64: .Em before
! 65: the default locations (
! 66: .Pa /usr/local/lib
! 67: etc.).
! 68: .It Fl m Ar monopath
! 69: Add
! 70: .Ar monopath
! 71: to the directories the mono(1) runtime will search for DLLs.
! 72: .It Fl h
! 73: Prints help text.
! 74: .It Fl v
! 75: Verbose mode.
! 76: .It Ar gamedir
! 77: Optional. Path to the game directory to process. If not specified, the current working directory will be used.
! 78: .El
! 79: .Sh SUPPORTED GAMES
! 80: The Adventures of Shuggy
! 81: .br
! 82: Apotheon
! 83: .br
! 84: Bleed
! 85: .br
! 86: Bleed 2
! 87: .br
! 88: Breath of Death VII
! 89: .br
! 90: Brushwood Buddies
! 91: .br
! 92: Capsized
! 93: .br
! 94: Chaos Heart
! 95: .br
! 96: Charlie Murder
! 97: .br
! 98: Chasm
! 99: .br
! 100: CometStriker
! 101: .br
! 102: Cryptark
! 103: .br
! 104: Cthulhu Saves the World
! 105: .br
! 106: Curse of the Crescent Isle DX
! 107: .br
! 108: Dad Quest
! 109: .br
! 110: Dead Pixels II
! 111: .br
! 112: The Dishwasher: Vampire Smile
! 113: .br
! 114: Dust: An Elysian Tail
! 115: .br
! 116: Escape Goat
! 117: .br
! 118: Escape Goat 2
! 119: .br
! 120: FEZ
! 121: .br
! 122: Fist Puncher
! 123: .br
! 124: Flinthook
! 125: .br
! 126: Flotilla
! 127: .br
! 128: Gateways
! 129: .br
! 130: Growing Pains
! 131: .br
! 132: HackNet
! 133: .br
! 134: Hive
! 135: .br
! 136: Hyphen
! 137: .br
! 138: Jon Shafer's At the Gates
! 139: .br
! 140: LaserCat
! 141: .br
! 142: Mercenary Kings
! 143: .br
! 144: Ninja Warrior
! 145: .br
! 146: One Finger Death Punch
! 147: .br
! 148: Overdriven Reloaded
! 149: .br
! 150: Owlboy
! 151: .br
! 152: Paladin
! 153: .br
! 154: Penny Arcade's On the Rain-Slick Precipice of Darkness 3
! 155: .br
! 156: Penny Arcade's On the Rain-Slick Precipice of Darkness 4
! 157: .br
! 158: Press X to Not Die
! 159: .br
! 160: Rex Rocket
! 161: .br
! 162: Rogue Legacy
! 163: .br
! 164: Salt and Sanctuary
! 165: .br
! 166: Shipwreck
! 167: .br
! 168: Skulls of the Shogun
! 169: .br
! 170: Soulcaster 1 & 2
! 171: .br
! 172: SpeedRunners
! 173: .br
! 174: Stardew Valley
! 175: .br
! 176: Sumico
! 177: .br
! 178: Super Amazing Wagon Adventure
! 179: .br
! 180: Super Rad Raygun
! 181: .br
! 182: Timespinner
! 183: .br
! 184: TowerFall: Ascension
! 185: .br
! 186: Unexplored
! 187: .br
! 188: Unholy Heights (no audio)
! 189: .br
! 190: The Useful Dead
! 191: .br
! 192: Wizorb
! 193: .br
! 194: Wyv and Keep
! 195: .Sh FILES
! 196: .Bl -tag -width Ds
! 197: .It Pa ~/.config/fnaify/fnaify.dllmap.config
! 198: Configuration file to map DLLs to native libraries, based on OpenBSD
! 199: library naming.
! 200: .El
! 201: .Sh EXIT STATUS
! 202: .Nm
! 203: returns 1 if an error occurred with the arguments of files provided,
! 204: otherwise 0.
! 205: .Sh EXAMPLES
! 206: Run in permissive mode, suitable to set up most supported games
! 207: automatically.
! 208: .Pp
! 209: .Dl $ fnaify -y path/to/game/directory
! 210: .Pp
! 211: Run in interactive mode.
! 212: .Nm
! 213: will prompt the user if any additional DLLs are recommended, or if a
! 214: file needs to be selected for the launch script.
! 215: .Pp
! 216: .Dl $ fnaify -i path/to/game/directory
! 217: .Sh SEE ALSO
! 218: .Xr mono 1
! 219: .Sh HISTORY
! 220: The
! 221: .Nm
! 222: utility was originally created in December 2017 by
! 223: .An Thomas Frohwein Aq Mt thfr@openbsd.org
! 224: .Sh AUTHORS
! 225: .An -nosplit
! 226: .An Thomas Frohwein Aq Mt thfr@openbsd.org
Contact: <mail@mail.thfr.info>
![[BACK]](/cvswebicons/icons/back.gif){kind=icon}
Return to fnaify.1 CVS log ![[TXT]](/cvswebicons/icons/text.gif){kind=icon}
![[DIR]](/cvswebicons/icons/dir.gif){kind=icon}
Up to [local] / projects / fnaify