=================================================================== RCS file: /anoncvsroot/anoncvs/cvs/projects/fnaify/fnaify.1,v retrieving revision 1.8 retrieving revision 1.49 diff -u -r1.8 -r1.49 --- projects/fnaify/fnaify.1 2019/10/04 18:52:33 1.8 +++ projects/fnaify/fnaify.1 2020/10/07 20:31:26 1.49 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: October 4 2019 $ +.Dd $Mdocdate: October 7 2020 $ .Dt FNAIFY 1 .Os .Sh NAME @@ -7,14 +7,16 @@ .Sh SYNOPSIS .Nm .Op Fl i | y -.Op Fl hv +.Op Fl hsv .Op Fl c Ar configfile -.Op Fl d Ar depdir +.Op Fl D Ar depdir +.Op Fl d Ar gamedir +.Op Fl f Ar frameworkfile | Fl F Ar frameworkversion .Op Fl m Ar monopath -.Op Ar gamedir +.Op Ar userflags .Sh DESCRIPTION .Nm -sets up games based on the FNA engine to operate with OpenBSD-native +runs games based on the FNA engine with OpenBSD-native libraries and its .Xr mono 1 runtime. @@ -24,8 +26,20 @@ has been extended to attempt configuring XNA games as well. .Nm can be run in 3 basic modes regarding the addition of missing libraries: -restrictive, interactive, and permissive. +restrictive +.Po +default +.Pc +, interactive, and permissive. .Pp +As of version 3.0, +.Nm +unifies both setup and launch of supported games in one command. +.Pp +All games require additional libraries from ports, like SDL2. Some of +them can be found in the fnaify-extralibs package, like libatomstb or +libfmod_SDL. +.Pp The arguments are as follows: .Bl -tag -width Ds .It Fl i | y @@ -70,15 +84,15 @@ for details. If this option is omitted, .Nm looks first for -.Pa /usr/local/share/fnaify/fnaify.dllmap.config +.Pa ~/.config/fnaify/fnaify.dllmap.config and then for -.Pa ~/.config/fnaify/fnaify.dllmap.config . +.Pa /usr/local/share/fnaify/fnaify.dllmap.config . If neither one is found, .Nm creates .Pa ~/.config/fnaify/fnaify.dllmap.config with default settings. -.It Fl d Ar depdir +.It Fl D Ar depdir Add .Ar depdir to the directories to search for native library dependencies. @@ -86,20 +100,36 @@ .Em before the default locations .Pq Pa /usr/local/lib No etc. . +.It Fl d Ar gamedir +Path to the game's directory +.Pq defaults to the current working directory . +.It Fl F Ar frameworkversion +Choose a specific framework version to use. +.It Fl f Ar frameworkfile +Framework file to use. Typically +.Pa FNA.dll +or +.Pa MonoGame.Framework.dll . +By default will automatically identify the bundled file in the +game's directory. +.It Fl h +Prints help text. .It Fl m Ar monopath Add .Ar monopath to the directories the .Xr mono 1 runtime will search for DLLs. -.It Fl h -Prints help text. +.It Fl s +Force (re-)running setup. +.It Fl V +Display version of +.Nm . .It Fl v Verbose mode. -.It Ar gamedir +.It Ar userflags Optional. -Path to the game directory to process. -If not specified, the current working directory will be used. +Flags that are passed to the game as arguments .El .Sh SUPPORTED GAMES .Bl -item -compact @@ -114,6 +144,14 @@ .It Apple Jack 1&2 .It +Atom Zombie Smasher +.It +A Virus Named TOM [!] +.It +Before the Echo [!] +.It +Bird Assassin +.It Bleed .It Bleed 2 @@ -122,8 +160,12 @@ .It Brushwood Buddies .It +Camera Obscura +.It Capsized .It +Celeste (no audio) +.It Chaos Heart .It Charlie Murder @@ -140,9 +182,9 @@ .It Dad Quest .It -Dead Pixels +Dead Pixels [!] .It -Dead Pixels II +Dead Pixels II [!] .It The Dishwasher: Vampire Smile .It @@ -150,11 +192,15 @@ .It Dust: An Elysian Tail .It +Eagle Island +.It +Eliza +.It Escape Goat .It Escape Goat 2 .It -Explosionade +EXAPUNKS .It FEZ .It @@ -164,16 +210,16 @@ .It Flotilla .It -Game Type -.It Gateways .It -Grand Class Melee 2 +Grand Class Melee 2 [!] .It Growing Pains .It HackNet .It +Hidden in Plain Sight +.It Hive .It Hyphen @@ -182,14 +228,24 @@ .It LaserCat .It +Little Racers STREET +.It Mercenary Kings .It -Mount Your Friends +MidBoss .It +Molek-Syntez +.It +Mount Your Friends [!] +.It +NeuroVoider +.It Ninja Warrior .It One Finger Death Punch .It +Opus Magnum +.It Overdriven Reloaded .It Owlboy @@ -202,45 +258,61 @@ .It Phoenix Force .It +PlanetFriend +.It Press X to Not Die .It Rex Rocket .It Rogue Legacy .It +Ruggnar +.It Salt and Sanctuary .It +Session Seven +.It +Shenzhen I/O +.It Shipwreck .It +Signs of Life +.It Skulls of the Shogun .It Soulcaster 1 & 2 .It +SpaceChem [!] +.It SpeedRunners .It Stardew Valley .It Sumico .It -Super Amazing Wagon Adventure +Super Amazing Wagon Adventure [!] .It Super Blood Hockey .It Super Rad Raygun .It -Sword of the Stars: The Pit +Sword of the Stars: The Pit [!] .It +Terraria +.It Timespinner .It TowerFall: Ascension .It +Ultra Hat Dimension +.It Unexplored .It Unholy Heights (no audio) .It The Useful Dead .It -Weapon of Choice +Weapon of Choice [!] .It Wizorb .It @@ -251,24 +323,24 @@ .It Pa /usr/local/share/fnaify/fnaify.dllmap.config Default configuration file to map DLLs to native libraries. .It Pa ~/.config/fnaify/fnaify.dllmap.config -Alternative configuration file. +User directory configuration file. Takes precedence if it exists. +Make sure to keep it up-to-date! .El .Sh EXIT STATUS .Nm -returns 1 if an error occurred with the arguments of files provided, -otherwise 0. +returns 1 if an error occurred, otherwise 0. .Sh EXAMPLES Run in permissive mode, suitable to set up most supported games automatically. .Pp -.Dl $ fnaify -y path/to/game/directory +.Dl $ fnaify -y -d path/to/game/directory .Pp Run in interactive mode. .Nm will prompt the user if any additional DLLs are recommended, or if a file needs to be selected for the launch script. .Pp -.Dl $ fnaify -i path/to/game/directory +.Dl $ fnaify -i .Sh SEE ALSO .Xr mono 1 , .Xr mono-config 5 @@ -279,11 +351,19 @@ .An Thomas Frohwein Aq Mt thfr@openbsd.org . .Sh RELEASE HISTORY .Bl -tag -width Ds +.It 3.0 +Stop creating launch script. Instead use fnaify for both +setup and launch. +Support for several Zachtronics games. Add libstubborn use to dllmap. +Symlinking for MonoGame, e.g. NeuroVoider. +Preferential use of installed FNA.dll over bundled one. +.It 2.2 +Fix config for mono 6. Add support for libcestub. .It 2.1 -Support for additional XNA games. +Support for additional XNA games. Add MONO_FORCE_COMPAT quirk. .It 2.0 Add support for XNA games. -Introduce modes +Introduce interactivity flags .Fl i | y to facilitate adding in needed assemblies/libraries. .It 1.3 @@ -303,3 +383,4 @@ .Sh AUTHORS .An -nosplit .An Thomas Frohwein Aq Mt thfr@openbsd.org +.An Mariusz Zaborski