├── SingleBoostr.IdlingProcess ├── libs │ └── Steam4NET.dll ├── App.config ├── ErrorCodes.cs ├── Properties │ └── AssemblyInfo.cs ├── SingleBoostr.IdlingProcess.csproj └── Program.cs ├── SingleBoostr.Client ├── packages.config ├── App.config ├── ErrorCodes.cs ├── Properties │ └── AssemblyInfo.cs ├── SingleBoostr.Client.csproj ├── ConfigHandler.cs └── Program.cs ├── .gitmodules ├── .gitattributes ├── README.md ├── SingleBoostr.sln ├── .gitignore └── LICENSE /SingleBoostr.IdlingProcess/libs/Steam4NET.dll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hanzbadua/SingleBoostr/HEAD/SingleBoostr.IdlingProcess/libs/Steam4NET.dll -------------------------------------------------------------------------------- /SingleBoostr.Client/packages.config: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "Steam4NET"] 2 | path = Steam4NET 3 | url = https://github.com/SteamRE/Steam4NET 4 | [submodule "ini-parser"] 5 | path = ini-parser 6 | url = https://github.com/rickyah/ini-parser 7 | -------------------------------------------------------------------------------- /SingleBoostr.Client/App.config: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /SingleBoostr.IdlingProcess/App.config: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /SingleBoostr.Client/ErrorCodes.cs: -------------------------------------------------------------------------------- 1 | namespace SingleBoostr.Client 2 | { 3 | internal enum ErrorCodes : byte 4 | { 5 | Success = 0, // Success 6 | SteamworksFail = 1, // Steam client is NOT open 7 | ClientFail = 2, // Unknown 8 | PipeFail = 3, // Related to SteamworksFail, needs more testing 9 | UserFail = 4, // User doesn't own the app/appId 10 | AppsFail = 5, // Unknown 11 | InvalidArguments = 10, // Process called with invalid arguments - should only be returned when user tries to open background exe without the client exe 12 | InvalidParentProcessId = 11 // Should never return under normal circumstances 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /SingleBoostr.IdlingProcess/ErrorCodes.cs: -------------------------------------------------------------------------------- 1 | namespace SingleBoostr.IdlingProcess 2 | { 3 | internal enum ErrorCodes : byte 4 | { 5 | Success = 0, // Success 6 | SteamworksFail = 1, // Steam client is NOT open 7 | ClientFail = 2, // Unknown 8 | PipeFail = 3, // Related to SteamworksFail, needs more testing 9 | UserFail = 4, // User doesn't own the app/appId 10 | AppsFail = 5, // Unknown 11 | InvalidArguments = 10, // Process called with invalid arguments - should only be returned when user tries to open background exe without the client exe 12 | InvalidParentProcessId = 11 // Should never return under normal circumstances 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [Outdated workaround, please use this working fork instead now.](https://github.com/Ni1kko/HourBoostr) 2 | 3 | ---- 4 | 5 | ## This is a fork of SingleBoostr found in HourBoostr - you can find the original author's repository [here](https://github.com/Ezzpify/HourBoostr) and latest fork binary downloads [here](https://github.com/hanzbadua/SingleBoostr/releases) 6 | ### This fork aims for simplicity (console-only interface, hopefully low RAM usage) 7 | ### If you have any problems with this fork, make an issue in this repository, NOT the original repository. 8 | #### Libraries used: INIParser and Steam4NET 9 | #### The only source code used from the original repository is [this file](https://github.com/Ezzpify/HourBoostr/blob/master/SingleBoostr/SingleBoostrGame/SingleBoostrGame/Program.cs) and has been incorporated [here](https://github.com/hanzbadua/SingleBoostr/blob/master/SingleBoostr.IdlingProcess/Program.cs) 10 | #### Furthermore, this fork is licensed under the same license as the original repository: [GNU GPL-v3.0](https://github.com/hanzbadua/SingleBoostr/blob/master/LICENSE) 11 | ---- 12 | Build instructions: 13 | (Optional) Build the Steam4NET library, and add as a reference to `SingleBoostr.IdlingProcess` - this is optional as this repository already comes with a compiled version of Steam4NET with optimizations 14 | 15 | Compile with Visual Studio 2019 (NET Framework 4.8 required) 16 | 17 | Afterwards, copy the compiled `SingleBoostr.IdlingProcess` binaries and put it in the same folder/directory with the `SingleBoostr.Client` binaries 18 | 19 | And that's it! 20 | -------------------------------------------------------------------------------- /SingleBoostr.Client/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.CompilerServices; 3 | using System.Runtime.InteropServices; 4 | 5 | // General Information about an assembly is controlled through the following 6 | // set of attributes. Change these attribute values to modify the information 7 | // associated with an assembly. 8 | [assembly: AssemblyTitle("SingleBoostr.Client")] 9 | [assembly: AssemblyDescription("Idle Steam game hours and cards - main/client exe")] 10 | [assembly: AssemblyConfiguration("Release")] 11 | [assembly: AssemblyCompany("")] 12 | [assembly: AssemblyProduct("SingleBoostr.Client")] 13 | [assembly: AssemblyCopyright("Copyright © Hxxzii 2021")] 14 | [assembly: AssemblyTrademark("")] 15 | [assembly: AssemblyCulture("")] 16 | 17 | // Setting ComVisible to false makes the types in this assembly not visible 18 | // to COM components. If you need to access a type in this assembly from 19 | // COM, set the ComVisible attribute to true on that type. 20 | [assembly: ComVisible(false)] 21 | 22 | // The following GUID is for the ID of the typelib if this project is exposed to COM 23 | [assembly: Guid("406d46a4-e87f-44c4-99f9-f894eab22660")] 24 | 25 | // Version information for an assembly consists of the following four values: 26 | // 27 | // Major Version 28 | // Minor Version 29 | // Build Number 30 | // Revision 31 | // 32 | // You can specify all the values or you can default the Build and Revision Numbers 33 | // by using the '*' as shown below: 34 | // [assembly: AssemblyVersion("1.0.*")] 35 | [assembly: AssemblyVersion("4.0.3.5")] 36 | [assembly: AssemblyFileVersion("4.0.3.5")] 37 | -------------------------------------------------------------------------------- /SingleBoostr.IdlingProcess/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.CompilerServices; 3 | using System.Runtime.InteropServices; 4 | 5 | // General Information about an assembly is controlled through the following 6 | // set of attributes. Change these attribute values to modify the information 7 | // associated with an assembly. 8 | [assembly: AssemblyTitle("SingleBoostr.IdlingProcess")] 9 | [assembly: AssemblyDescription("Idle Steam game hours and cards - helper exe")] 10 | [assembly: AssemblyConfiguration("Release")] 11 | [assembly: AssemblyCompany("")] 12 | [assembly: AssemblyProduct("SingleBoostr.IdlingProcess")] 13 | [assembly: AssemblyCopyright("Copyright © Ezzpify 2017 (original), Hxxzii 2021 (fork)")] 14 | [assembly: AssemblyTrademark("")] 15 | [assembly: AssemblyCulture("")] 16 | 17 | // Setting ComVisible to false makes the types in this assembly not visible 18 | // to COM components. If you need to access a type in this assembly from 19 | // COM, set the ComVisible attribute to true on that type. 20 | [assembly: ComVisible(false)] 21 | 22 | // The following GUID is for the ID of the typelib if this project is exposed to COM 23 | [assembly: Guid("6fc02d30-663b-4262-b094-bc81c0a09b6e")] 24 | 25 | // Version information for an assembly consists of the following four values: 26 | // 27 | // Major Version 28 | // Minor Version 29 | // Build Number 30 | // Revision 31 | // 32 | // You can specify all the values or you can default the Build and Revision Numbers 33 | // by using the '*' as shown below: 34 | // [assembly: AssemblyVersion("1.0.*")] 35 | [assembly: AssemblyVersion("4.0.3.5")] 36 | [assembly: AssemblyFileVersion("4.0.3.5")] 37 | -------------------------------------------------------------------------------- /SingleBoostr.Client/SingleBoostr.Client.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | AnyCPU 7 | {406D46A4-E87F-44C4-99F9-F894EAB22660} 8 | Exe 9 | SingleBoostr.Client 10 | SingleBoostr.Client 11 | v4.8 12 | 512 13 | true 14 | true 15 | 16 | 17 | AnyCPU 18 | true 19 | full 20 | false 21 | bin\Debug\ 22 | DEBUG;TRACE 23 | prompt 24 | 4 25 | true 26 | 27 | 28 | x86 29 | pdbonly 30 | true 31 | bin\Release\ 32 | TRACE 33 | prompt 34 | 4 35 | false 36 | Off 37 | 38 | 39 | 40 | ..\packages\ini-parser.2.5.2\lib\net20\INIFileParser.dll 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /SingleBoostr.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.30804.86 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SingleBoostr.Client", "SingleBoostr.Client\SingleBoostr.Client.csproj", "{406D46A4-E87F-44C4-99F9-F894EAB22660}" 7 | EndProject 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SingleBoostr.IdlingProcess", "SingleBoostr.IdlingProcess\SingleBoostr.IdlingProcess.csproj", "{6FC02D30-663B-4262-B094-BC81C0A09B6E}" 9 | EndProject 10 | Global 11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 12 | Debug|Any CPU = Debug|Any CPU 13 | Debug|x64 = Debug|x64 14 | Debug|x86 = Debug|x86 15 | Release|Any CPU = Release|Any CPU 16 | Release|x64 = Release|x64 17 | Release|x86 = Release|x86 18 | EndGlobalSection 19 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 20 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 21 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Debug|Any CPU.Build.0 = Debug|Any CPU 22 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Debug|x64.ActiveCfg = Debug|Any CPU 23 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Debug|x64.Build.0 = Debug|Any CPU 24 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Debug|x86.ActiveCfg = Debug|Any CPU 25 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Debug|x86.Build.0 = Debug|Any CPU 26 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Release|Any CPU.ActiveCfg = Release|Any CPU 27 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Release|Any CPU.Build.0 = Release|Any CPU 28 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Release|x64.ActiveCfg = Release|Any CPU 29 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Release|x64.Build.0 = Release|Any CPU 30 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Release|x86.ActiveCfg = Release|Any CPU 31 | {406D46A4-E87F-44C4-99F9-F894EAB22660}.Release|x86.Build.0 = Release|Any CPU 32 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 33 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Debug|Any CPU.Build.0 = Debug|Any CPU 34 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Debug|x64.ActiveCfg = Debug|Any CPU 35 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Debug|x86.ActiveCfg = Debug|Any CPU 36 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Release|Any CPU.ActiveCfg = Release|Any CPU 37 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Release|Any CPU.Build.0 = Release|Any CPU 38 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Release|x64.ActiveCfg = Release|Any CPU 39 | {6FC02D30-663B-4262-B094-BC81C0A09B6E}.Release|x86.ActiveCfg = Release|Any CPU 40 | EndGlobalSection 41 | GlobalSection(SolutionProperties) = preSolution 42 | HideSolutionNode = FALSE 43 | EndGlobalSection 44 | GlobalSection(ExtensibilityGlobals) = postSolution 45 | SolutionGuid = {4A736EA0-92C4-431A-A2EB-10D66A228EB8} 46 | EndGlobalSection 47 | EndGlobal 48 | -------------------------------------------------------------------------------- /SingleBoostr.IdlingProcess/SingleBoostr.IdlingProcess.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | AnyCPU 7 | {6FC02D30-663B-4262-B094-BC81C0A09B6E} 8 | WinExe 9 | Properties 10 | SingleBoostr.IdlingProcess 11 | SingleBoostr.IdlingProcess 12 | v4.8 13 | 512 14 | true 15 | 16 | 17 | 18 | x86 19 | true 20 | full 21 | false 22 | bin\Debug\ 23 | DEBUG;TRACE 24 | prompt 25 | 4 26 | 27 | 28 | x86 29 | pdbonly 30 | true 31 | bin\Release\ 32 | TRACE 33 | prompt 34 | 4 35 | false 36 | Off 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | libs\Steam4NET.dll 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 67 | -------------------------------------------------------------------------------- /SingleBoostr.Client/ConfigHandler.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using IniParser; 4 | using IniParser.Model; 5 | 6 | namespace SingleBoostr.Client 7 | { 8 | public class ConfigHandler 9 | { 10 | internal static string ConfigPath { get; } = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "config.ini"); 11 | private FileIniDataParser Parser { get; set; } 12 | private IniData Data { get; set; } 13 | 14 | public ConfigHandler() 15 | { 16 | if (File.Exists(ConfigPath) && new FileInfo(ConfigPath).Length != 0) return; 17 | 18 | Program.SetConsoleTextColor(ConsoleColor.Red); 19 | File.CreateText(ConfigPath).Dispose(); 20 | Console.WriteLine("ERROR: Config doesn't exist (config.ini), or it is empty"); 21 | Console.WriteLine("Config file has been created/regenerated, please adjust accordingly"); 22 | 23 | FreshConfig(); 24 | 25 | Console.WriteLine("(exit this program, then edit the config file)"); 26 | while (true) Console.ReadKey(); 27 | } 28 | 29 | public void FreshConfig() 30 | { 31 | Parser = new FileIniDataParser(); 32 | Data = new IniData(); 33 | Data.Sections.AddSection("Config"); 34 | Data["Config"].AddKey("SecondsUntilRestart", "3600"); 35 | Data["Config"].AddKey("InputAppIdsDuringRuntime", "false"); 36 | Parser.WriteFile(ConfigPath, Data); 37 | } 38 | 39 | public void InitializeData() 40 | { 41 | Parser = new FileIniDataParser(); 42 | Data = Parser.ReadFile(ConfigPath); 43 | } 44 | 45 | public string GetValue(string name) 46 | { 47 | CheckForUninitializedConfig(); 48 | return Data["Config"][name]; 49 | } 50 | 51 | public void SetValue(string name, string value) 52 | { 53 | CheckForUninitializedConfig(); 54 | Data["Config"][name] = value; 55 | } 56 | 57 | public void SaveData() 58 | { 59 | CheckForUninitializedConfig(); 60 | Parser.WriteFile(ConfigPath, Data); 61 | } 62 | 63 | // Will override and replace currently loaded INI data 64 | public void ReadData() 65 | { 66 | CheckForUninitializedConfig(); 67 | Data = Parser.ReadFile(ConfigPath); 68 | } 69 | 70 | private void CheckForUninitializedConfig() 71 | { 72 | if (Data is null || Parser is null) 73 | { 74 | Program.SetConsoleTextColor(ConsoleColor.Red); 75 | Console.WriteLine("INI config was attempted to be accessed whilst the config was uninitialized"); 76 | Console.WriteLine("You shouldn't be getting this error, please create a GitHub issue if you do"); 77 | Console.WriteLine("(please exit now)"); 78 | while (true) 79 | { 80 | Console.ReadKey(); 81 | } 82 | } 83 | } 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /SingleBoostr.IdlingProcess/Program.cs: -------------------------------------------------------------------------------- 1 | // TODO: Find out how to replicate every error code 2 | // NOTE: This helper/background program is called with two arguments 3 | // The first argument is the AppId of the game/app we want to idle 4 | // The second argument is the process id of the "parent/master" exe 5 | // This program closes itself whenever the process id of the "parent/master" exe is no longer a valid process (aka "parent/master" exe exited) 6 | // This program will insta-close if any arguments are invalid/nonexistent 7 | using System; 8 | using System.ComponentModel; 9 | using System.Diagnostics; 10 | using System.Linq; 11 | using System.Threading.Tasks; 12 | using Steam4NET; 13 | 14 | namespace SingleBoostr.IdlingProcess 15 | { 16 | public class Program 17 | { 18 | private static ISteamClient017 _steamClient; 19 | private static ISteamApps006 _steamApp; 20 | private static BackgroundWorker _bwg; 21 | 22 | private static ErrorCodes ConnectToSteam() 23 | { 24 | if (!Steamworks.Load(true)) 25 | { 26 | return ErrorCodes.SteamworksFail; 27 | } 28 | 29 | _steamClient = Steamworks.CreateInterface(); 30 | if (_steamClient == null) 31 | { 32 | return ErrorCodes.ClientFail; 33 | } 34 | 35 | var pipe = _steamClient.CreateSteamPipe(); 36 | if (pipe == 0) 37 | { 38 | return ErrorCodes.PipeFail; 39 | } 40 | 41 | var user = _steamClient.ConnectToGlobalUser(pipe); 42 | if (user == 0) 43 | { 44 | return ErrorCodes.UserFail; 45 | } 46 | 47 | _steamApp = _steamClient.GetISteamApps(user, pipe); 48 | return _steamApp == null ? ErrorCodes.AppsFail : ErrorCodes.Success; 49 | } 50 | 51 | private static async Task Main(string[] args) 52 | { 53 | if (args.Length == 0 || args[0] is null || args[1] is null || 54 | !uint.TryParse(args[0], out _) || !int.TryParse(args[1], out var parentProcessId) && parentProcessId >= 0) 55 | { 56 | return (byte) ErrorCodes.InvalidArguments; 57 | } 58 | 59 | var appId = args[0]; 60 | 61 | _bwg = new BackgroundWorker { WorkerSupportsCancellation = true }; 62 | _bwg.DoWork += async (sender, e) => 63 | { 64 | var processList = Process.GetProcesses(); 65 | var parentProcess = processList.FirstOrDefault(o => o.Id == (int) e.Argument); 66 | 67 | if (parentProcess == null) 68 | { 69 | Environment.Exit((byte) ErrorCodes.InvalidParentProcessId); 70 | } 71 | else 72 | { 73 | while (!_bwg.CancellationPending) 74 | { 75 | await Task.Delay(10000); 76 | 77 | if (!parentProcess.HasExited) continue; 78 | 79 | _bwg.CancelAsync(); 80 | Environment.Exit(0); 81 | } 82 | } 83 | }; 84 | 85 | Environment.SetEnvironmentVariable("SteamAppId", appId); 86 | 87 | var tryConnectSteam = ConnectToSteam(); 88 | 89 | if (tryConnectSteam == ErrorCodes.Success) 90 | { 91 | _bwg.RunWorkerAsync(parentProcessId); 92 | await Task.Delay(-1); 93 | } 94 | else 95 | { 96 | return (byte) tryConnectSteam; 97 | } 98 | 99 | return 0; 100 | } 101 | } 102 | } 103 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | 3 | ##### 4 | 5 | ## Ignore Visual Studio temporary files, build results, and 6 | ## files generated by popular Visual Studio add-ons. 7 | ## 8 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 9 | 10 | # User-specific files 11 | *.rsuser 12 | *.suo 13 | *.user 14 | *.userosscache 15 | *.sln.docstates 16 | 17 | # User-specific files (MonoDevelop/Xamarin Studio) 18 | *.userprefs 19 | 20 | # Mono auto generated files 21 | mono_crash.* 22 | 23 | # Build results 24 | [Dd]ebug/ 25 | [Dd]ebugPublic/ 26 | [Rr]elease/ 27 | [Rr]eleases/ 28 | x64/ 29 | x86/ 30 | [Ww][Ii][Nn]32/ 31 | [Aa][Rr][Mm]/ 32 | [Aa][Rr][Mm]64/ 33 | bld/ 34 | [Bb]in/ 35 | [Oo]bj/ 36 | [Ll]og/ 37 | [Ll]ogs/ 38 | 39 | # Visual Studio 2015/2017 cache/options directory 40 | .vs/ 41 | # Uncomment if you have tasks that create the project's static files in wwwroot 42 | #wwwroot/ 43 | 44 | # Visual Studio 2017 auto generated files 45 | Generated\ Files/ 46 | 47 | # MSTest test Results 48 | [Tt]est[Rr]esult*/ 49 | [Bb]uild[Ll]og.* 50 | 51 | # NUnit 52 | *.VisualState.xml 53 | TestResult.xml 54 | nunit-*.xml 55 | 56 | # Build Results of an ATL Project 57 | [Dd]ebugPS/ 58 | [Rr]eleasePS/ 59 | dlldata.c 60 | 61 | # Benchmark Results 62 | BenchmarkDotNet.Artifacts/ 63 | 64 | # .NET Core 65 | project.lock.json 66 | project.fragment.lock.json 67 | artifacts/ 68 | 69 | # ASP.NET Scaffolding 70 | ScaffoldingReadMe.txt 71 | 72 | # StyleCop 73 | StyleCopReport.xml 74 | 75 | # Files built by Visual Studio 76 | *_i.c 77 | *_p.c 78 | *_h.h 79 | *.ilk 80 | *.meta 81 | *.obj 82 | *.iobj 83 | *.pch 84 | *.pdb 85 | *.ipdb 86 | *.pgc 87 | *.pgd 88 | *.rsp 89 | *.sbr 90 | *.tlb 91 | *.tli 92 | *.tlh 93 | *.tmp 94 | *.tmp_proj 95 | *_wpftmp.csproj 96 | *.log 97 | *.vspscc 98 | *.vssscc 99 | .builds 100 | *.pidb 101 | *.svclog 102 | *.scc 103 | 104 | # Chutzpah Test files 105 | _Chutzpah* 106 | 107 | # Visual C++ cache files 108 | ipch/ 109 | *.aps 110 | *.ncb 111 | *.opendb 112 | *.opensdf 113 | *.sdf 114 | *.cachefile 115 | *.VC.db 116 | *.VC.VC.opendb 117 | 118 | # Visual Studio profiler 119 | *.psess 120 | *.vsp 121 | *.vspx 122 | *.sap 123 | 124 | # Visual Studio Trace Files 125 | *.e2e 126 | 127 | # TFS 2012 Local Workspace 128 | $tf/ 129 | 130 | # Guidance Automation Toolkit 131 | *.gpState 132 | 133 | # ReSharper is a .NET coding add-in 134 | _ReSharper*/ 135 | *.[Rr]e[Ss]harper 136 | *.DotSettings.user 137 | 138 | # TeamCity is a build add-in 139 | _TeamCity* 140 | 141 | # DotCover is a Code Coverage Tool 142 | *.dotCover 143 | 144 | # AxoCover is a Code Coverage Tool 145 | .axoCover/* 146 | !.axoCover/settings.json 147 | 148 | # Coverlet is a free, cross platform Code Coverage Tool 149 | coverage*.json 150 | coverage*.xml 151 | coverage*.info 152 | 153 | # Visual Studio code coverage results 154 | *.coverage 155 | *.coveragexml 156 | 157 | # NCrunch 158 | _NCrunch_* 159 | .*crunch*.local.xml 160 | nCrunchTemp_* 161 | 162 | # MightyMoose 163 | *.mm.* 164 | AutoTest.Net/ 165 | 166 | # Web workbench (sass) 167 | .sass-cache/ 168 | 169 | # Installshield output folder 170 | [Ee]xpress/ 171 | 172 | # DocProject is a documentation generator add-in 173 | DocProject/buildhelp/ 174 | DocProject/Help/*.HxT 175 | DocProject/Help/*.HxC 176 | DocProject/Help/*.hhc 177 | DocProject/Help/*.hhk 178 | DocProject/Help/*.hhp 179 | DocProject/Help/Html2 180 | DocProject/Help/html 181 | 182 | # Click-Once directory 183 | publish/ 184 | 185 | # Publish Web Output 186 | *.[Pp]ublish.xml 187 | *.azurePubxml 188 | # Note: Comment the next line if you want to checkin your web deploy settings, 189 | # but database connection strings (with potential passwords) will be unencrypted 190 | *.pubxml 191 | *.publishproj 192 | 193 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 194 | # checkin your Azure Web App publish settings, but sensitive information contained 195 | # in these scripts will be unencrypted 196 | PublishScripts/ 197 | 198 | # NuGet Packages 199 | *.nupkg 200 | # NuGet Symbol Packages 201 | *.snupkg 202 | # The packages folder can be ignored because of Package Restore 203 | **/[Pp]ackages/* 204 | # except build/, which is used as an MSBuild target. 205 | !**/[Pp]ackages/build/ 206 | # Uncomment if necessary however generally it will be regenerated when needed 207 | #!**/[Pp]ackages/repositories.config 208 | # NuGet v3's project.json files produces more ignorable files 209 | *.nuget.props 210 | *.nuget.targets 211 | 212 | # Microsoft Azure Build Output 213 | csx/ 214 | *.build.csdef 215 | 216 | # Microsoft Azure Emulator 217 | ecf/ 218 | rcf/ 219 | 220 | # Windows Store app package directories and files 221 | AppPackages/ 222 | BundleArtifacts/ 223 | Package.StoreAssociation.xml 224 | _pkginfo.txt 225 | *.appx 226 | *.appxbundle 227 | *.appxupload 228 | 229 | # Visual Studio cache files 230 | # files ending in .cache can be ignored 231 | *.[Cc]ache 232 | # but keep track of directories ending in .cache 233 | !?*.[Cc]ache/ 234 | 235 | # Others 236 | ClientBin/ 237 | ~$* 238 | *~ 239 | *.dbmdl 240 | *.dbproj.schemaview 241 | *.jfm 242 | *.pfx 243 | *.publishsettings 244 | orleans.codegen.cs 245 | 246 | # Including strong name files can present a security risk 247 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 248 | #*.snk 249 | 250 | # Since there are multiple workflows, uncomment next line to ignore bower_components 251 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 252 | #bower_components/ 253 | 254 | # RIA/Silverlight projects 255 | Generated_Code/ 256 | 257 | # Backup & report files from converting an old project file 258 | # to a newer Visual Studio version. Backup files are not needed, 259 | # because we have git ;-) 260 | _UpgradeReport_Files/ 261 | Backup*/ 262 | UpgradeLog*.XML 263 | UpgradeLog*.htm 264 | ServiceFabricBackup/ 265 | *.rptproj.bak 266 | 267 | # SQL Server files 268 | *.mdf 269 | *.ldf 270 | *.ndf 271 | 272 | # Business Intelligence projects 273 | *.rdl.data 274 | *.bim.layout 275 | *.bim_*.settings 276 | *.rptproj.rsuser 277 | *- [Bb]ackup.rdl 278 | *- [Bb]ackup ([0-9]).rdl 279 | *- [Bb]ackup ([0-9][0-9]).rdl 280 | 281 | # Microsoft Fakes 282 | FakesAssemblies/ 283 | 284 | # GhostDoc plugin setting file 285 | *.GhostDoc.xml 286 | 287 | # Node.js Tools for Visual Studio 288 | .ntvs_analysis.dat 289 | node_modules/ 290 | 291 | # Visual Studio 6 build log 292 | *.plg 293 | 294 | # Visual Studio 6 workspace options file 295 | *.opt 296 | 297 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 298 | *.vbw 299 | 300 | # Visual Studio LightSwitch build output 301 | **/*.HTMLClient/GeneratedArtifacts 302 | **/*.DesktopClient/GeneratedArtifacts 303 | **/*.DesktopClient/ModelManifest.xml 304 | **/*.Server/GeneratedArtifacts 305 | **/*.Server/ModelManifest.xml 306 | _Pvt_Extensions 307 | 308 | # Paket dependency manager 309 | .paket/paket.exe 310 | paket-files/ 311 | 312 | # FAKE - F# Make 313 | .fake/ 314 | 315 | # CodeRush personal settings 316 | .cr/personal 317 | 318 | # Python Tools for Visual Studio (PTVS) 319 | __pycache__/ 320 | *.pyc 321 | 322 | # Cake - Uncomment if you are using it 323 | # tools/** 324 | # !tools/packages.config 325 | 326 | # Tabs Studio 327 | *.tss 328 | 329 | # Telerik's JustMock configuration file 330 | *.jmconfig 331 | 332 | # BizTalk build output 333 | *.btp.cs 334 | *.btm.cs 335 | *.odx.cs 336 | *.xsd.cs 337 | 338 | # OpenCover UI analysis results 339 | OpenCover/ 340 | 341 | # Azure Stream Analytics local run output 342 | ASALocalRun/ 343 | 344 | # MSBuild Binary and Structured Log 345 | *.binlog 346 | 347 | # NVidia Nsight GPU debugger configuration file 348 | *.nvuser 349 | 350 | # MFractors (Xamarin productivity tool) working folder 351 | .mfractor/ 352 | 353 | # Local History for Visual Studio 354 | .localhistory/ 355 | 356 | # BeatPulse healthcheck temp database 357 | healthchecksdb 358 | 359 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 360 | MigrationBackup/ 361 | 362 | # Ionide (cross platform F# VS Code tools) working folder 363 | .ionide/ 364 | 365 | # Fody - auto-generated XML schema 366 | FodyWeavers.xsd 367 | -------------------------------------------------------------------------------- /SingleBoostr.Client/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Diagnostics; 4 | using System.IO; 5 | using System.Linq; 6 | using System.Text.RegularExpressions; 7 | using System.Threading.Tasks; 8 | 9 | namespace SingleBoostr.Client 10 | { 11 | public class Program 12 | { 13 | private static async Task Main() 14 | { 15 | var applist = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "applist.txt"); 16 | var exe = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SingleBoostr.IdlingProcess.exe"); 17 | 18 | SetConsoleTextColor(ConsoleColor.Red); 19 | 20 | if (!File.Exists(exe)) 21 | { 22 | Console.WriteLine("ERROR: Helper exe not located (SingleBoostr.IdlingProcess.exe)"); 23 | Console.WriteLine("Please put this program beside the helper exe or reinstall this program"); 24 | await Task.Delay(-1); 25 | return 1; 26 | } 27 | 28 | var config = new ConfigHandler(); 29 | 30 | config.InitializeData(); 31 | 32 | if (bool.TryParse(config.GetValue("InputAppIdsDuringRuntime"), out var inputDuringRuntime) 33 | && !inputDuringRuntime && !File.Exists(applist)) 34 | { 35 | File.CreateText(applist).Dispose(); 36 | Console.WriteLine("ERROR: App list doesn't exist (applist.txt)"); 37 | Console.WriteLine("App list file has been created, please add your appids that you want to idle in the config file"); 38 | Console.WriteLine("(exit this program, then edit the config file)"); 39 | Console.WriteLine("(OR in config.ini, set InputAppIdsDuringRuntime = true and you can input your appIds via input during runtime)"); 40 | await Task.Delay(-1); 41 | return 1; 42 | } 43 | 44 | SetConsoleTextColor(ConsoleColor.Yellow); 45 | 46 | if (int.TryParse(config.GetValue("SecondsUntilRestart"), out var seconds)) 47 | { 48 | if (seconds <= 0) 49 | { 50 | Console.WriteLine("WARNING: SecondsUntilRestart is zero or a negative number - defaulting to 3600 seconds (1 hour)"); 51 | seconds = 3600; 52 | } 53 | } 54 | else 55 | { 56 | Console.WriteLine("WARNING: SecondsUntilRestart value is not a number - defaulting to 3600 seconds (1 hour)"); 57 | seconds = 3600; 58 | } 59 | 60 | SetConsoleTextColor(ConsoleColor.White); 61 | Console.WriteLine($"Idling processes will restart every {seconds} seconds"); 62 | 63 | var listOfApps = new List(); 64 | 65 | if (inputDuringRuntime) 66 | { 67 | SetConsoleTextColor(ConsoleColor.Cyan); 68 | Console.WriteLine(); 69 | Console.WriteLine("InputAppIdsDuringRuntime is set to true - ignoring applist.txt and receiving appIds via input now"); 70 | Console.WriteLine("Please input one appId at a time, then press enter"); 71 | Console.WriteLine("Do this for each individual appId that you want to input"); 72 | Console.WriteLine("When you are done inputting appIds and you're ready to start idling, input anything that isn't a number (ex: done)"); 73 | 74 | SetConsoleTextColor(ConsoleColor.Green); 75 | 76 | var whitespaceRegex = new Regex(@"\s+"); 77 | 78 | while (true) 79 | { 80 | var inputtedAppId = whitespaceRegex.Replace(Console.ReadLine() ?? string.Empty, string.Empty); 81 | if (string.IsNullOrWhiteSpace(inputtedAppId) || !inputtedAppId.All(char.IsDigit)) 82 | { 83 | SetConsoleTextColor(ConsoleColor.White); 84 | Console.WriteLine("Detected non-numeric input, proceeding to idle games now"); 85 | break; 86 | } 87 | 88 | listOfApps.Add(inputtedAppId); 89 | Console.WriteLine($"AppId {inputtedAppId} successfully added"); 90 | } 91 | 92 | if (!listOfApps.Any()) 93 | { 94 | SetConsoleTextColor(ConsoleColor.Red); 95 | Console.WriteLine("ERROR: you inputted no valid appIds"); 96 | Console.WriteLine("(please restart the app and input valid appIds)"); 97 | Console.WriteLine("(OR in config.ini, set InputAppIdsDuringRuntime = false and put your appIds in applist.txt, one appId per line)"); 98 | await Task.Delay(-1); 99 | } 100 | } 101 | else 102 | { 103 | listOfApps = File.ReadAllLines(applist).ToList(); 104 | if (!listOfApps.Any()) 105 | { 106 | SetConsoleTextColor(ConsoleColor.Red); 107 | Console.WriteLine("ERROR: applist.txt is empty - therefore no apps will get idled"); 108 | Console.WriteLine("(please exit the app and edit your applist.txt file to contain appids)"); 109 | Console.WriteLine("(OR in config.ini, set InputAppIdsDuringRuntime = true and you can input your appIds via input during runtime)"); 110 | await Task.Delay(-1); 111 | } 112 | } 113 | 114 | if (listOfApps.Count > 33) 115 | { 116 | SetConsoleTextColor(ConsoleColor.Yellow); 117 | Console.WriteLine("WARNING: More than 33 appIds detected"); 118 | Console.WriteLine("Trying to idle more than 33 appIds may result in Steam not idling some of your apps at all!"); 119 | } 120 | 121 | // i is the AppId 122 | foreach (var i in listOfApps) 123 | { 124 | if (!uint.TryParse(i, out var id) || string.IsNullOrWhiteSpace(i)) 125 | { 126 | SetConsoleTextColor(ConsoleColor.Yellow); 127 | Console.WriteLine($"WARNING: AppId {i} is an invalid AppId, skipping"); 128 | continue; 129 | } 130 | 131 | var currentProcessId = Process.GetCurrentProcess().Id; 132 | 133 | var startInfo = new ProcessStartInfo(exe) 134 | { 135 | UseShellExecute = false, 136 | WindowStyle = ProcessWindowStyle.Normal, 137 | CreateNoWindow = true, 138 | //RedirectStandardInput = true, 139 | //RedirectStandardOutput = true, 140 | //RedirectStandardError = true, 141 | Arguments = $"{i} {currentProcessId}" 142 | }; 143 | 144 | ActiveIdlingApps.Add(i, Process.Start(startInfo)); 145 | 146 | var justAdded = ActiveIdlingApps.Last().Value; 147 | await Task.Delay(256); 148 | 149 | ErrorCodes exitCode; 150 | try 151 | { 152 | exitCode = (ErrorCodes) justAdded.ExitCode; 153 | } 154 | // An InvalidOperationException will be raised if we try accessing the exit code of a process which hasn't exited 155 | // Process hasn't exited yet within the 256ms window, meaning it hasn't crashed/raised an exception which means success 156 | catch (InvalidOperationException) 157 | { 158 | exitCode = ErrorCodes.Success; 159 | } 160 | 161 | SetConsoleTextColor(ConsoleColor.DarkRed); 162 | switch (exitCode) 163 | { 164 | case ErrorCodes.AppsFail: 165 | case ErrorCodes.ClientFail: 166 | case ErrorCodes.InvalidArguments: 167 | case ErrorCodes.InvalidParentProcessId: 168 | Console.WriteLine($"FATAL ERROR: Trying to idle appId {i} returned error {Enum.GetName(typeof(ErrorCodes), exitCode)}"); 169 | Console.WriteLine("(exit the app and please make a GitHub issue with the specified error if you get this error)"); 170 | await Task.Delay(-1); 171 | break; 172 | case ErrorCodes.UserFail: 173 | Console.WriteLine($"FATAL ERROR: you tried to idle appId {i}, which you apparently don't own (?)"); 174 | Console.WriteLine("(please exit the app & try again with only appIds that you actually own)"); 175 | await Task.Delay(-1); 176 | break; 177 | case ErrorCodes.SteamworksFail: 178 | case ErrorCodes.PipeFail: 179 | Console.WriteLine("FATAL ERROR: you tried to idle without the Steam client open - the Steam client must be open"); 180 | Console.WriteLine("(please exit the app & try again with the Steam client open)"); 181 | await Task.Delay(-1); 182 | break; 183 | case ErrorCodes.Success: 184 | default: 185 | break; 186 | } 187 | SetConsoleTextColor(ConsoleColor.Green); 188 | Console.WriteLine($"AppId {i} is now boosting!"); 189 | } 190 | 191 | SetConsoleTextColor(ConsoleColor.Yellow); 192 | while (true) 193 | { 194 | await Task.Delay(seconds * 1000); 195 | 196 | var toRestart = ActiveIdlingApps.ElementAt(new Random().Next(ActiveIdlingApps.Count)); 197 | 198 | toRestart.Value.Kill(); 199 | toRestart.Value.WaitForExit(); 200 | toRestart.Value.Start(); 201 | 202 | Console.WriteLine($"Idling process for AppId {toRestart.Key} has been restarted"); 203 | } 204 | } 205 | 206 | internal static void SetConsoleTextColor(ConsoleColor color) 207 | { 208 | Console.ForegroundColor = color; 209 | } 210 | 211 | // Key: AppId, Value: Process 212 | private static readonly Dictionary ActiveIdlingApps = new Dictionary(); 213 | } 214 | } 215 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------