Files
djhackersdev_bemanitools/src/main/launcher/options.c
T
icex2andShiz 215a4bdb15 refactor(launcher): Major re-work of launcher
Kudos to Shiz for providing the groundwork for this.

Fundamentally re-think how launcher operates and
bootstrapping the games is managed and configured.

This brings it significantly closer to how the original
bootstrap is doing the job: launcher now utilizes the
data (structures) provided by the bootstrap.xml configuration
file. This creates compatibility with vanilla data dumps
and original stock images. Note that bemanitools does not
include any code or means to run DRM'd data, only decrypted.

But, this allows users to keep decrypted dumps as stock as
possible which means:

* No copying around of property files anymore
* Keep the modules/ folder with the binaries
* Have bemanitools binaries separate in the data
* No need to edit/customize the original configuration files

A list of key features of the "new" launcher:

* Boostrap games by following the configuration provided by
  stock game's bootstrap.xml files
* Custom launcher.xml configuration file that adds further
  launcher configurable features, composability of
  bootstrap.xml configuration(s) as well as configuration
  overriding/stacking of selected types of configurations,
  e.g. eamuse config, avs-config. The latter eliminates
  the need for modifying stock config files in the prop/
  folder
* Unified logging system: launcher and AVS logging uses
  the same logger, all output can now be in a single file
* Original features such as various hook types still
  available

Due to the significant architectural changes, this also
breaks with any backwards compatibility to existing
launcher setups. Thus, users need to migrate by re-applying
the new configuration format and migrating their config
parameters accordingly.

Further migration instructions and updated documentation
will be provided upon release.

Co-authored-by: Shiz <hi@shiz.me>
2024-02-25 09:07:54 +01:00

241 lines
6.8 KiB
C

#define LOG_MODULE "options"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "imports/avs.h"
#include "launcher/options.h"
#include "util/mem.h"
#include "util/str.h"
void options_init(struct options *options)
{
memset(options, 0, sizeof(struct options));
array_init(&options->hook.hook_dlls);
array_init(&options->hook.before_hook_dlls);
array_init(&options->hook.iat_hook_dlls);
}
bool options_read_cmdline(struct options *options, int argc, const char **argv)
{
bool got_launcher_config;
got_launcher_config = false;
for (int i = 1; i < argc; i++) {
if (argv[i][0] == '-') {
switch (argv[i][1]) {
case 'T':
if (i + 1 >= argc) {
return false;
}
options->bootstrap.config_path = argv[++i];
break;
case 'Z':
if (i + 1 >= argc) {
return false;
}
options->bootstrap.selector = argv[++i];
break;
case 'P':
if (i + 1 >= argc) {
return false;
}
options->eamuse.pcbid = argv[++i];
break;
case 'R':
if (i + 1 >= argc) {
return false;
}
options->eamuse.softid = argv[++i];
break;
case 'H':
if (i + 1 >= argc) {
return false;
}
*array_append(const char *, &options->hook.hook_dlls) =
argv[++i];
break;
case 'B':
if (i + 1 >= argc) {
return false;
}
*array_append(
const char *, &options->hook.before_hook_dlls) =
argv[++i];
break;
case 'I': {
if (i + 1 >= argc) {
return false;
}
const char *dll = argv[++i];
log_assert(strstr(dll, "=") != NULL);
*array_append(const char *, &options->hook.iat_hook_dlls) =
dll;
break;
}
case 'L':
if (i + 1 >= argc) {
return false;
}
long tmp = strtol(argv[++i], NULL, 0);
if (tmp < CORE_LOG_BT_LOG_LEVEL_OFF ||
tmp > CORE_LOG_BT_LOG_LEVEL_MISC) {
return false;
}
options->log.level =
xmalloc(sizeof(enum core_log_bt_log_level));
*(options->log.level) = (enum core_log_bt_log_level) tmp;
break;
case 'Y':
if (i + 1 >= argc) {
return false;
}
options->log.file_path = argv[++i];
break;
case 'C':
options->debug.log_property_configs = true;
break;
case 'S':
if (i + 1 >= argc) {
return false;
}
options->eamuse.service_url = argv[++i];
break;
case 'U':
if (i + 1 >= argc) {
return false;
}
options->eamuse.urlslash = xmalloc(sizeof(bool));
const char *urlslash_value = argv[++i];
*(options->eamuse.urlslash) = false;
if (_stricmp(urlslash_value, "1") == 0) {
*(options->eamuse.urlslash) = true;
}
if (_stricmp(urlslash_value, "true") == 0) {
*(options->eamuse.urlslash) = true;
}
break;
case 'D':
options->debug.remote_debugger = true;
break;
default:
break;
}
} else {
if (!got_launcher_config) {
options->launcher.config_path = argv[i];
got_launcher_config = true;
}
}
}
return got_launcher_config;
}
void options_print_usage(void)
{
fprintf(
stderr,
"Usage:\n"
" launcher.exe [launcher options as overrides...] <path launcher.xml> "
"[further options, e.g. for hook libraries to pick up...]\n"
"\n"
" The following options can be specified before the launcher.xml "
"configuration file:\n"
"\n"
" Bootstrap\n"
" -T [filename] Bootstrap configuration file\n"
" -Z [selector] Bootstrap selector used in configuration\n"
"\n"
" Eamuse\n"
" -P [pcbid] Specify PCBID\n"
" -R [softid] Specify Soft ID\n"
" -S [url] Specify service url\n"
" -U [0/1] Specify url_slash enabled/disabled\n"
"\n"
" Hook\n"
" -H [filename] Load hook DLL (can be specified multiple "
"times)\n"
" -B [filename] Load pre-hook DLL loaded before avs boot "
"(can be specified multiple times)\n"
" -I [filename] Load pre-hook DLL that overrides IAT reference "
"before execution (can be specified multiple times)\n"
"\n"
" Logging\n"
" -L [0/1/2/3] Log level for both console and file with "
"increasing verbosity (0 = fatal, 1 = warn, 2 = info, 3 = misc)\n"
" -Y [filename] Log to a file in addition to the console\n"
"\n"
" Debug\n"
" -D Halt the launcher before bootstrapping AVS "
"until a remote debugger is attached\n"
" -C Log all loaded and final (property) "
"configuration that launcher uses for bootstrapping. IMPORTANT: DO NOT "
"ENABLE unless you know what you are doing. This prints sensitive data "
"and credentials to the console and logfile. BE CAUTIOUS not to share "
"this information before redaction.");
}
void options_fini(struct options *options)
{
array_fini(&options->hook.hook_dlls);
array_fini(&options->hook.before_hook_dlls);
array_fini(&options->hook.iat_hook_dlls);
if (options->log.level) {
free(options->log.level);
}
if (options->eamuse.urlslash) {
free(options->eamuse.urlslash);
}
}