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

Annotation of projects/fnaify/fnaify.1, Revision 1.7

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

Contact: <mail@mail.thfr.info>