Further documentation for using and configuring?

[Juansecu]

You guys definitely should add more documentation on how to use and configuring ffrunner.

For example, if you want to run a Flash (which seems possible according to the README.md file), how to do it? Is it extrictly necessary to use C/C++ for using or configuring it?

[yungcomputerchair]

We specify in the README that the -m option is used to pick which file to load. It needs to be an NPAPI plugin specifically.
As for configuration, everything is done through command line options:

puts("Usage: ffrunner.exe [OPTION...]");
puts("  -m, --main=STR          The main URL to load");
puts("  -l, --log=STR           The path to the log file");
puts("  -v, --verbose           Enable verbose logging");
puts("  -a, --address=STR       The address of the server");
puts("      --asseturl=STR      The URL of the CDN for assets");
puts("  -e, --endpoint=STR      The OFAPI endpoint URL");
puts("  -u, --username=STR      Username for auto-login");
puts("  -t, --token=STR         Password or token for auto-login");
puts("      --width=INT         The width of the window");
puts("      --height=INT        The height of the window");
puts("      --loader-images     Use loading screen images from endpoint");
puts("      --force-vulkan      Force Vulkan renderer");
puts("      --force-opengl      Force OpenGL renderer");
puts("  -h, --help              Display this help menu");

We could properly document these, but most of them are only useful for FusionFall (specifically, our patched Unity DLLs)

[Juansecu]

We specify in the README that the -m option is used to pick which file to load. It needs to be an NPAPI plugin specifically. As for configuration, everything is done through command line options:

puts("Usage: ffrunner.exe [OPTION...]");
puts("  -m, --main=STR          The main URL to load");
puts("  -l, --log=STR           The path to the log file");
puts("  -v, --verbose           Enable verbose logging");
puts("  -a, --address=STR       The address of the server");
puts("      --asseturl=STR      The URL of the CDN for assets");
puts("  -e, --endpoint=STR      The OFAPI endpoint URL");
puts("  -u, --username=STR      Username for auto-login");
puts("  -t, --token=STR         Password or token for auto-login");
puts("      --width=INT         The width of the window");
puts("      --height=INT        The height of the window");
puts("      --loader-images     Use loading screen images from endpoint");
puts("      --force-vulkan      Force Vulkan renderer");
puts("      --force-opengl      Force OpenGL renderer");
puts("  -h, --help              Display this help menu");

We could properly document these, but most of them are only useful for FusionFall (specifically, our patched Unity DLLs)

So isn't it possible to load PepperFlashPlayer, for example?

I mean this one:

libpepflashplayer.zip

I'm curious, because you're using Tauri, which uses WebView to load the launcher interface, and I would like to use a similar approach, but using Go.

It actually works well using Electron, but I would like to use a lighter way to create a Desktop Launcher for my own project.

[clicktodev]

this might be relevant regarding better docs OpenFusionProject/OpenFusionLauncher#29

[Juansecu]

this might be relevant regarding better docs OpenFusionProject/OpenFusionLauncher#29

I mean yeah, but I also mean for this repo, because that issue applies only to the OpenFusionLauncher repo, as I understand.

[yungcomputerchair]

Pepper uses PPAPI, which is not NPAPI. PPAPI plugins almost certainly use a completely different API surface which ffrunner does not implement.

If you think our docs should do a better job clarifying this, we are open to suggestions.

[Juansecu]

Pepper uses PPAPI, which is not NPAPI. PPAPI plugins almost certainly use a completely different API surface which ffrunner does not implement.

If you think our docs should do a better job clarifying this, we are open to suggestions.

I mean you could give further details on the purpose of this repo, what will do for you, what not and how to use it properly, instead of just waiting other people to read the source code to know how to use it.

[yungcomputerchair]

We are very clear in the README that ffrunner implements a subset of NPAPI APIs used by Unity Web Player, and that it can be "adapted to run any generic NPAPI plugin."

Just like any other codebase, you need to at least have a basic understanding of the underlying technology (in this case, NPAPI) in order to use it.

If you have any examples of how to update our docs, we will consider those, but saying "the docs aren't good enough" is not enough to keep this issue open.