using BepInEx.Configuration; using BepInEx.Logging; using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; using System.Reflection; using System.Text; using System.Text.RegularExpressions; using UnityEngine; using UnityInjector.ConsoleUtil; using Logger = BepInEx.Logging.Logger; namespace BepInEx.Bootstrap { /// /// The manager and loader for all plugins, and the entry point for BepInEx plugin system. /// public static class Chainloader { /// /// The loaded and initialized list of plugins. /// public static List Plugins { get; private set; } = new List(); /// /// The GameObject that all plugins are attached to as components. /// public static GameObject ManagerObject { get; private set; } private static bool _loaded = false; private static bool _initialized = false; /// /// Initializes BepInEx to be able to start the chainloader. /// public static void Initialize(string containerExePath, bool startConsole = true) { if (_initialized) return; //Set vitals Paths.SetExecutablePath(containerExePath); Paths.SetPluginPath(ConfigPluginsDirectory.Value); //Start logging if (ConsoleWindow.ConfigConsoleEnabled.Value && startConsole) { ConsoleWindow.Attach(); Logger.Listeners.Add(new ConsoleLogListener()); } //Fix for standard output getting overwritten by UnityLogger if (ConsoleWindow.StandardOut != null) { Console.SetOut(ConsoleWindow.StandardOut); var encoding = ConsoleWindow.ConfigConsoleShiftJis.Value ? 932 : (uint)Encoding.UTF8.CodePage; ConsoleEncoding.ConsoleCodePage = encoding; Console.OutputEncoding = ConsoleEncoding.GetEncoding(encoding); } Logger.Listeners.Add(new UnityLogListener()); Logger.Listeners.Add(new DiskLogListener()); if (!TraceLogSource.IsListening) Logger.Sources.Add(TraceLogSource.CreateSource()); if (ConfigUnityLogging.Value) Logger.Sources.Add(new UnityLogSource()); Logger.LogMessage("Chainloader ready"); _initialized = true; } private static Regex allowedGuidRegex { get; } = new Regex(@"^[a-zA-Z0-9\._]+$"); /// /// The entrypoint for the BepInEx plugin system. /// public static void Start() { if (_loaded) return; if (!_initialized) throw new InvalidOperationException("BepInEx has not been initialized. Please call Chainloader.Initialize prior to starting the chainloader instance."); if (!Directory.Exists(Paths.PluginPath)) Directory.CreateDirectory(Paths.PluginPath); if (!Directory.Exists(Paths.PatcherPluginPath)) Directory.CreateDirectory(Paths.PatcherPluginPath); try { var productNameProp = typeof(Application).GetProperty("productName", BindingFlags.Public | BindingFlags.Static); if (productNameProp != null) ConsoleWindow.Title = $"BepInEx {Assembly.GetExecutingAssembly().GetName().Version} - {productNameProp.GetValue(null, null)}"; Logger.LogMessage("Chainloader started"); ManagerObject = new GameObject("BepInEx_Manager"); UnityEngine.Object.DontDestroyOnLoad(ManagerObject); string currentProcess = Process.GetCurrentProcess().ProcessName.ToLower(); var globalPluginTypes = TypeLoader.LoadTypes(Paths.PluginPath).ToList(); Dictionary selectedPluginTypes = new Dictionary(globalPluginTypes.Count); foreach (var pluginType in globalPluginTypes) { //Ensure metadata exists var metadata = MetadataHelper.GetMetadata(pluginType); if (metadata == null) { Logger.LogWarning($"Skipping type [{pluginType.FullName}] as no metadata attribute is specified"); continue; } if (string.IsNullOrEmpty(metadata.GUID) || !allowedGuidRegex.IsMatch(metadata.GUID)) { Logger.LogWarning($"Skipping type [{pluginType.FullName}] because its GUID [{metadata.GUID}] is of an illegal format."); continue; } if (selectedPluginTypes.Any(x => x.Value.GUID.Equals(metadata.GUID, StringComparison.OrdinalIgnoreCase))) { Logger.LogWarning($"Skipping type [{pluginType.FullName}] because its GUID [{metadata.GUID}] is already used by another plugin."); continue; } if (metadata.Version == null) { Logger.LogWarning($"Skipping type [{pluginType.FullName}] because its version is invalid."); continue; } if (metadata.Name == null) { Logger.LogWarning($"Skipping type [{pluginType.FullName}] because its name is null."); continue; } //Perform a filter for currently running process var filters = MetadataHelper.GetAttributes(pluginType); if (filters.Length != 0) { var result = filters.Any(x => x.ProcessName.ToLower().Replace(".exe", "") == currentProcess); if (!result) { Logger.LogInfo($"Skipping over plugin [{metadata.GUID}] due to process filter"); continue; } } selectedPluginTypes.Add(pluginType, metadata); } Logger.LogInfo($"{selectedPluginTypes.Count} / {globalPluginTypes.Count} plugins to load"); var dependencyDict = new Dictionary>(); var pluginsByGUID = new Dictionary(); foreach (var kv in selectedPluginTypes) { var dependencies = MetadataHelper.GetDependencies(kv.Key, selectedPluginTypes.Keys); dependencyDict[kv.Value.GUID] = dependencies.Select(d => d.DependencyGUID); pluginsByGUID[kv.Value.GUID] = kv.Key; } var emptyDependencies = new string[0]; // Sort plugins by their dependencies. // Give missing dependencies no dependencies of its own, which will cause missing plugins to be first in the resulting list. var sortedPlugins = Utility.TopologicalSort(dependencyDict.Keys, x => dependencyDict.TryGetValue(x, out var deps) ? deps : emptyDependencies).ToList(); var invalidPlugins = new HashSet(); var processedPlugins = new HashSet(); foreach (var pluginGUID in sortedPlugins) { // If the plugin is missing, don't process it if (!pluginsByGUID.TryGetValue(pluginGUID, out var pluginType)) continue; var metadata = MetadataHelper.GetMetadata(pluginType); var dependencies = MetadataHelper.GetDependencies(pluginType, selectedPluginTypes.Keys); var dependsOnInvalidPlugin = false; var missingDependencies = new List(); foreach (var dependency in dependencies) { // If the depenency wasn't already processed, it's missing altogether if (!processedPlugins.Contains(dependency.DependencyGUID)) { // If the dependency is hard, collect it into a list to show if ((dependency.Flags & BepInDependency.DependencyFlags.HardDependency) != 0) missingDependencies.Add(dependency.DependencyGUID); continue; } // If the dependency is invalid (e.g. has missing depedencies), report that to the user if (invalidPlugins.Contains(dependency.DependencyGUID)) { dependsOnInvalidPlugin = true; break; } } processedPlugins.Add(pluginGUID); if (dependsOnInvalidPlugin) { Logger.LogWarning($"Skipping [{metadata.Name}] because it has a dependency that was not loaded. See above errors for details."); continue; } if (missingDependencies.Count != 0) { Logger.LogError($@"Missing the following dependencies for [{metadata.Name}]: {"\r\n"}{ string.Join("\r\n", missingDependencies.Select(s => $"- {s}").ToArray()) }{"\r\n"}Loading will be skipped; expect further errors and unstabilities."); invalidPlugins.Add(pluginGUID); continue; } try { Logger.LogInfo($"Loading [{metadata.Name} {metadata.Version}]"); Plugins.Add((BaseUnityPlugin)ManagerObject.AddComponent(pluginType)); } catch (Exception ex) { invalidPlugins.Add(pluginGUID); Logger.LogError($"Error loading [{metadata.Name}] : {ex.Message}"); Logger.LogDebug(ex); } } } catch (Exception ex) { ConsoleWindow.Attach(); Console.WriteLine("Error occurred starting the game"); Console.WriteLine(ex.ToString()); } Logger.LogMessage("Chainloader startup complete"); _loaded = true; } #region Config private static readonly ConfigWrapper ConfigPluginsDirectory = ConfigFile.CoreConfig.Wrap( "Paths", "PluginsDirectory", "The relative directory to the BepInEx folder where plugins are loaded.", "plugins"); private static readonly ConfigWrapper ConfigUnityLogging = ConfigFile.CoreConfig.Wrap( "Logging", "UnityLogListening", "Enables showing unity log messages in the BepInEx logging system.", true); #endregion } }