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

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

1.33    ! thfr        1: .Dd $Mdocdate: August 6 2020 $
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
1.19      thfr       29: All games require additional libraries from ports, like SDL2. Some of
                     30: them can be found in fnaify-extralibs package, like libatomstb or
                     31: libfmod_SDL.
                     32: .Pp
1.1       thfr       33: The arguments are as follows:
                     34: .Bl -tag -width Ds
                     35: .It Fl i | y
                     36: The mode determines how
                     37: .Nm
                     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.3       thfr       42: .Fl i ,
1.1       thfr       43: .Nm
                     44: runs in interactive mode, meaning the user will be prompted in every
                     45: case.
                     46: With
1.3       thfr       47: .Fl y ,
1.1       thfr       48: .Nm
1.3       thfr       49: runs in permissive mode
                     50: .Po
1.1       thfr       51: .Fl y
                     52: for
1.3       thfr       53: .Dq yes
                     54: to all
                     55: .Pc .
                     56: This means that any suggested drop-in DLLs will be installed,
1.1       thfr       57: and if different options are possible (like picking among several .exe
                     58: files for the launch script), the first one will be selected
                     59: automatically.
                     60: If neither
                     61: .Fl i
                     62: nor
                     63: .Fl y
                     64: is specified,
                     65: .Nm
                     66: runs in restrictive mode, that is no drop-in DLLs will be installed.
1.7       thfr       67: .It Fl c Ar configfile
                     68: Optional. Use
                     69: .Ar configfile
                     70: for the configuration of
                     71: .Xr mono 1 .
                     72: This sets up dllmap/dllentry settings to use the correct libraries. See
                     73: .Xr mono-config 5
                     74: for details. If this option is omitted,
                     75: .Nm
                     76: looks first for
1.9       thfr       77: .Pa ~/.config/fnaify/fnaify.dllmap.config
1.7       thfr       78: and then for
1.9       thfr       79: .Pa /usr/local/share/fnaify/fnaify.dllmap.config .
1.7       thfr       80: If neither one is found,
                     81: .Nm
                     82: creates
                     83: .Pa ~/.config/fnaify/fnaify.dllmap.config
                     84: with default settings.
1.1       thfr       85: .It Fl d Ar depdir
                     86: Add
                     87: .Ar depdir
1.3       thfr       88: to the directories to search for native library dependencies.
                     89: A directory specified this way will be searched
1.1       thfr       90: .Em before
1.3       thfr       91: the default locations
                     92: .Pq Pa /usr/local/lib No etc. .
1.1       thfr       93: .It Fl m Ar monopath
                     94: Add
                     95: .Ar monopath
1.3       thfr       96: to the directories the
                     97: .Xr mono 1
                     98: runtime will search for DLLs.
1.1       thfr       99: .It Fl h
                    100: Prints help text.
                    101: .It Fl v
                    102: Verbose mode.
                    103: .It Ar gamedir
1.3       thfr      104: Optional.
                    105: Path to the game directory to process.
                    106: If not specified, the current working directory will be used.
1.1       thfr      107: .El
                    108: .Sh SUPPORTED GAMES
1.3       thfr      109: .Bl -item -compact
                    110: .It
1.1       thfr      111: The Adventures of Shuggy
1.3       thfr      112: .It
1.6       thfr      113: Akane the Kunoichi
                    114: .It
                    115: Amazing Princess Sarah
                    116: .It
1.1       thfr      117: Apotheon
1.3       thfr      118: .It
1.6       thfr      119: Apple Jack 1&2
                    120: .It
1.19      thfr      121: Atom Zombie Smasher
                    122: .It
1.25      thfr      123: Before the Echo [!]
1.24      thfr      124: .It
1.1       thfr      125: Bleed
1.3       thfr      126: .It
1.1       thfr      127: Bleed 2
1.3       thfr      128: .It
1.1       thfr      129: Breath of Death VII
1.3       thfr      130: .It
1.1       thfr      131: Brushwood Buddies
1.3       thfr      132: .It
1.1       thfr      133: Capsized
1.3       thfr      134: .It
1.21      thfr      135: Celeste (no audio) [!]
1.19      thfr      136: .It
1.1       thfr      137: Chaos Heart
1.3       thfr      138: .It
1.1       thfr      139: Charlie Murder
1.3       thfr      140: .It
1.1       thfr      141: Chasm
1.3       thfr      142: .It
1.1       thfr      143: CometStriker
1.3       thfr      144: .It
1.1       thfr      145: Cryptark
1.3       thfr      146: .It
1.23      thfr      147: Cthulhu Saves the World
1.3       thfr      148: .It
1.1       thfr      149: Curse of the Crescent Isle DX
1.3       thfr      150: .It
1.1       thfr      151: Dad Quest
1.3       thfr      152: .It
1.22      thfr      153: Dead Pixels [!]
1.6       thfr      154: .It
1.22      thfr      155: Dead Pixels II [!]
1.3       thfr      156: .It
1.1       thfr      157: The Dishwasher: Vampire Smile
1.3       thfr      158: .It
1.6       thfr      159: Draw a Stickman: EPIC
                    160: .It
1.1       thfr      161: Dust: An Elysian Tail
1.3       thfr      162: .It
1.15      thfr      163: Eliza
                    164: .It
1.1       thfr      165: Escape Goat
1.3       thfr      166: .It
1.1       thfr      167: Escape Goat 2
1.3       thfr      168: .It
1.15      thfr      169: EXAPUNKS
                    170: .It
1.22      thfr      171: Explosionade [!]
1.6       thfr      172: .It
1.1       thfr      173: FEZ
1.3       thfr      174: .It
1.1       thfr      175: Fist Puncher
1.3       thfr      176: .It
1.1       thfr      177: Flinthook
1.3       thfr      178: .It
1.1       thfr      179: Flotilla
1.3       thfr      180: .It
1.22      thfr      181: Game Type [!]
1.6       thfr      182: .It
1.1       thfr      183: Gateways
1.3       thfr      184: .It
1.22      thfr      185: Grand Class Melee 2 [!]
1.6       thfr      186: .It
1.1       thfr      187: Growing Pains
1.3       thfr      188: .It
1.24      thfr      189: HackNet
1.3       thfr      190: .It
1.32      thfr      191: Hidden in Plain Sight
                    192: .It
1.22      thfr      193: Hive [!] - sometimes doesn't start up
1.3       thfr      194: .It
1.1       thfr      195: Hyphen
1.3       thfr      196: .It
1.1       thfr      197: Jon Shafer's At the Gates
1.3       thfr      198: .It
1.26      thfr      199: LaserCat
1.3       thfr      200: .It
1.13      thfr      201: Little Racers STREET
                    202: .It
1.1       thfr      203: Mercenary Kings
1.19      thfr      204: .It
                    205: MidBoss
1.3       thfr      206: .It
1.15      thfr      207: Molek-Syntez
                    208: .It
1.32      thfr      209: Mount Your Friends [!]
1.16      thfr      210: .It
                    211: NeuroVoider
1.4       thfr      212: .It
1.1       thfr      213: Ninja Warrior
1.3       thfr      214: .It
1.28      thfr      215: One Finger Death Punch
1.3       thfr      216: .It
1.29      thfr      217: Opus Magnum
1.15      thfr      218: .It
1.1       thfr      219: Overdriven Reloaded
1.3       thfr      220: .It
1.1       thfr      221: Owlboy
1.3       thfr      222: .It
1.1       thfr      223: Paladin
1.3       thfr      224: .It
1.1       thfr      225: Penny Arcade's On the Rain-Slick Precipice of Darkness 3
1.3       thfr      226: .It
1.1       thfr      227: Penny Arcade's On the Rain-Slick Precipice of Darkness 4
1.6       thfr      228: .It
1.30      thfr      229: Phoenix Force
1.3       thfr      230: .It
1.32      thfr      231: PlanetFriend
                    232: .It
1.31      thfr      233: Press X to Not Die
1.3       thfr      234: .It
1.1       thfr      235: Rex Rocket
1.3       thfr      236: .It
1.1       thfr      237: Rogue Legacy
1.3       thfr      238: .It
1.32      thfr      239: Ruggnar
                    240: .It
1.1       thfr      241: Salt and Sanctuary
1.3       thfr      242: .It
1.32      thfr      243: Session Seven
                    244: .It
1.18      thfr      245: Shenzhen I/O
                    246: .It
1.1       thfr      247: Shipwreck
1.3       thfr      248: .It
1.1       thfr      249: Skulls of the Shogun
1.3       thfr      250: .It
1.1       thfr      251: Soulcaster 1 & 2
1.3       thfr      252: .It
1.32      thfr      253: SpaceChem [!]
1.20      thfr      254: .It
1.1       thfr      255: SpeedRunners
1.3       thfr      256: .It
1.1       thfr      257: Stardew Valley
1.3       thfr      258: .It
1.1       thfr      259: Sumico
1.3       thfr      260: .It
1.32      thfr      261: Super Amazing Wagon Adventure [!]
1.3       thfr      262: .It
1.4       thfr      263: Super Blood Hockey
                    264: .It
1.1       thfr      265: Super Rad Raygun
1.4       thfr      266: .It
1.32      thfr      267: Sword of the Stars: The Pit [!]
1.3       thfr      268: .It
1.11      thfr      269: Terraria
                    270: .It
1.1       thfr      271: Timespinner
1.3       thfr      272: .It
1.1       thfr      273: TowerFall: Ascension
1.3       thfr      274: .It
1.32      thfr      275: Ultra Hat Dimension
                    276: .It
1.1       thfr      277: Unexplored
1.3       thfr      278: .It
1.1       thfr      279: Unholy Heights (no audio)
1.3       thfr      280: .It
1.1       thfr      281: The Useful Dead
1.3       thfr      282: .It
1.32      thfr      283: Weapon of Choice [!]
1.3       thfr      284: .It
1.1       thfr      285: Wyv and Keep
1.3       thfr      286: .El
1.1       thfr      287: .Sh FILES
                    288: .Bl -tag -width Ds
1.10      thfr      289: .It Pa /usr/local/share/fnaify/fnaify.dllmap.config
                    290: Default configuration file to map DLLs to native libraries.
1.9       thfr      291: .It Pa ~/.config/fnaify/fnaify.dllmap.config
1.10      thfr      292: User directory configuration file. Takes precedence if it exists.
1.15      thfr      293: Make sure to keep it up-to-date!
1.1       thfr      294: .El
                    295: .Sh EXIT STATUS
                    296: .Nm
                    297: returns 1 if an error occurred with the arguments of files provided,
                    298: otherwise 0.
                    299: .Sh EXAMPLES
                    300: Run in permissive mode, suitable to set up most supported games
                    301: automatically.
                    302: .Pp
                    303: .Dl $ fnaify -y path/to/game/directory
                    304: .Pp
                    305: Run in interactive mode.
                    306: .Nm
                    307: will prompt the user if any additional DLLs are recommended, or if a
                    308: file needs to be selected for the launch script.
                    309: .Pp
                    310: .Dl $ fnaify -i path/to/game/directory
                    311: .Sh SEE ALSO
1.7       thfr      312: .Xr mono 1 ,
                    313: .Xr mono-config 5
1.1       thfr      314: .Sh HISTORY
                    315: The
                    316: .Nm
                    317: utility was originally created in December 2017 by
1.7       thfr      318: .An Thomas Frohwein Aq Mt thfr@openbsd.org .
1.2       thfr      319: .Sh RELEASE HISTORY
                    320: .Bl -tag -width Ds
1.33    ! thfr      321: .It 3.0
        !           322: Enable modes (`setup`, `run`).
1.17      thfr      323: Support for several Zachtronics games. Add libstubborn use to dllmap.
                    324: Symlinking for MonoGame, e.g. NeuroVoider.
1.14      thfr      325: .It 2.2
                    326: Fix config for mono 6. Add support for libcestub.
1.8       thfr      327: .It 2.1
1.12      thfr      328: Support for additional XNA games. Add MONO_FORCE_COMPAT quirk.
1.2       thfr      329: .It 2.0
1.3       thfr      330: Add support for XNA games.
                    331: Introduce modes
1.2       thfr      332: .Fl i | y
                    333: to facilitate adding in needed assemblies/libraries.
                    334: .It 1.3
1.3       thfr      335: Add prompt to download and replace
                    336: .Pa FNA.dll
                    337: if incompatible version is found.
                    338: Detect steamstubs directory and use Steamworks stubs if present.
1.2       thfr      339: .It 1.2
                    340: FreeBSD portability fixes, account for more special cases (MidBoss,
                    341: Adventures of Shuggy, Atom Zombie Smasher), add directory path to plug
                    342: in additional libraries.
                    343: .It 1.1
                    344: Fix bug selecting .exe by separating input variables.
                    345: .It 1.0
                    346: Initial release.
                    347: .El
1.1       thfr      348: .Sh AUTHORS
                    349: .An -nosplit
                    350: .An Thomas Frohwein Aq Mt thfr@openbsd.org

Contact: <mail@mail.thfr.info>