https://github.com/corona-studio/projbobcat
The next generation Minecraft launcher core written in C# providing the freest, fastest and the most complete experience.
https://github.com/corona-studio/projbobcat
ahead-of-time cross-platform csharp dotnet dotnet-core launcher linux macos minecraft minecraft-launcher native-code nativeaot net8 windows
Last synced: 7 days ago
JSON representation
The next generation Minecraft launcher core written in C# providing the freest, fastest and the most complete experience.
- Host: GitHub
- URL: https://github.com/corona-studio/projbobcat
- Owner: Corona-Studio
- License: mit
- Created: 2020-02-06T08:51:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-25T03:44:02.000Z (3 months ago)
- Last Synced: 2026-01-25T17:41:24.233Z (3 months ago)
- Topics: ahead-of-time, cross-platform, csharp, dotnet, dotnet-core, launcher, linux, macos, minecraft, minecraft-launcher, native-code, nativeaot, net8, windows
- Language: C#
- Homepage: https://kb.corona.studio/zhCN/projbobcat/
- Size: 9.97 MB
- Stars: 246
- Watchers: 7
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# ProjBobcat [](https://github.com/Corona-Studio/ProjBobcat/actions/workflows/codeql-analysis.yml)
## [简体中文](https://github.com/Corona-Studio/ProjBobcat/blob/master/README_zh_cn.md)
The next-generation Minecraft launcher core written in C# provides the freest, fastest, and most complete experience.
Developed and maintained by Corona Studio.
## NativeAOT (ahead-of-time compilation) Support
ProjBobcat provides full support for [NativeAot](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/).
Native AOT apps start up very quickly and use less memory. Users of the application can run it on a machine that doesn't have the .NET runtime installed.
## Multi-Platform Support
Currently, we are working on the multi-platform support for ProjBobcat
| Platform | Status |
| -------- | ------------------ |
| Windows | :white_check_mark: |
| macOS | :white_check_mark: |
| Linux | :white_check_mark: |
## [Ad] An Awesome Typescript Launcher Core
[Repo Link](https://github.com/Voxelum/minecraft-launcher-core-node)
All you need for Minecraft launcher in typescript. https://voxelum.github.io/minecraft-launcher-core-node/
## Reminder before installation
+ Projbobcat now only supports the latest LTS .NET version 10.0.
+ Due to the limitation of the default number of connections in .NET, you need to manually override the number of connections to ensure that some methods in are executed typically. You can add the following code in App.xaml.cs or the entry point of the program to complete the modification (The maximum value should not exceed 1024)
```c#
using System.Net;
ServicePointManager.DefaultConnectionLimit = 512;
```
## Installation
There are two methods for the first step:
* Clone and copy ProjBobcat's source code to your solution folder, then add ProjBobcat's reference to your project.
* Directly install ProjBobcat via Nuget Package Manager or execute
```
Install-Package ProjBobcat
```
in Package Manager Console.
## Roadmap
| Function | Status |
| ------------------------------------------------------------- | ------------------ |
| Offline Auth Model | :white_check_mark: |
| Online Auth Model (Yggdrasil) | :white_check_mark: |
| Online Auth Model (Microsoft) | :white_check_mark: |
| Version Isolation | :white_check_mark: |
| launcher_profiles.json Analysis | :white_check_mark: |
| launcher_accounts.json Analysis | :white_check_mark: |
| Nuget Distribution | :white_check_mark: |
| Old Forge Installation Model | :white_check_mark: |
| New Forge Installation Model | :white_check_mark: |
| Optifine Installation Model | :white_check_mark: |
| Fabric Installation Model | :white_check_mark: |
| LiteLoader Installation Model | :white_check_mark: |
| Resource Auto Completion (Multi-thread downloader) | :white_check_mark: |
| Minecraft: Windows 10 Edition Support (Detector and launcher) | :white_check_mark: |
| Game log resolver | :white_check_mark: |
| Game crashing detector | :white_check_mark: |
## Instruction
Please note: ProjBobcat requires non-32-bit preferred compilation in your main project.
ProjBobcat provides 3 main components & a core to form the whole core framework.
| Class | Parent Interface | Parent Class | Function |
| ---------------------------- | ---------------------- | ------------------------- | -------------------------------------------------- |
| DefaultGameCore | IGameCore | NG | All Implementations of the Default Launch Core |
| DefaultLaunchArgumentParser | IArgumentParser | LaunchArgumentParserBase | The Default Argument Analysis Tool |
| DefaultLauncherProfileParser | ILauncherProfileParser | LauncherProfileParserBase | The Default launcher_profiles.json Analysis Module |
| DefaultVersionLocator | IVersionLocator | VersionLocatorBase | Game Version Locator |
Selective components:
| Class | Parent Interface | Parent Class | Function |
| ------------------------ | ------------------ | ------------ | ----------------------------------------------------- |
| DefaultResourceCompleter | IResourceCompleter | NG | All Implementations of the Default Resource Completer |
### Quick Startup
#### Java Detection
```csharp
var javaList = ProjBobcat.Class.Helper.SystemInfoHelper.FindJava(); // Returns a list of all Java installations found in the registry.
```
#### Core Initialization
```csharp
var core = new DefaultGameCore
{
ClientToken = clientToken,
RootPath = rootPath,
VersionLocator = new DefaultVersionLocator(rootPath, clientToken)
{
LauncherProfileParser = new DefaultLauncherProfileParser(rootPath, clientToken),
LauncherAccountParser = new DefaultLauncherAccountParser(rootPath, clientToken)
},
GameLogResolver = new DefaultGameLogResolver()
};
```
#### Game Scanning
```csharp
List gameList = core.VersionLocator.GetAllGames().ToList();
```
#### Resource Completion
```csharp
//Here we use mcbbs' download source, change the uri to meet your need.
var drc = new DefaultResourceCompleter
{
ResourceInfoResolvers = new List(2)
{
new AssetInfoResolver
{
AssetIndexUriRoot = "https://download.mcbbs.net/",
AssetUriRoot = "https://download.mcbbs.net/assets/",
BasePath = core.RootPath,
VersionInfo = gameList[0]
},
new LibraryInfoResolver
{
BasePath = core.RootPath,
LibraryUriRoot = "https://download.mcbbs.net/maven/",
VersionInfo = gameList[0]
}
}
};
await drc.CheckAndDownloadTaskAsync().ConfigureAwait(false);
```
Here are some events which you could bind to your program.
| Name | Method Signature | Refers to |
| ----------------------------- | --------------------------------------------------- | --------------------------------- |
| GameResourceInfoResolveStatus | (object sender, GameResourceInfoResolveEventArgs e) | Resolver status |
| DownloadFileChangedEvent | (object sender, DownloadFileChangedEventArgs e) | All files download status changed |
| DownloadFileCompletedEvent | (object sender, DownloadFileCompletedEventArgs e) | Single file download completed |
#### Launch Configuration
```csharp
var launchSettings = new LaunchSettings
{
FallBackGameArguments = new GameArguments // Default game arguments for all games in .minecraft/ as the fallback of specific game launch.
{
GcType = GcType.G1Gc, // GC type
JavaExecutable = javaPath, //The path of Java executable
Resolution = new ResolutionModel // Game Window's Resolution
{
Height = 600, // Height
Width = 800 // Width
},
MinMemory = 512, // Minimal Memory
MaxMemory = 1024 // Maximum Memory
},
Version = versionId, // The version ID of the game to launch, such as 1.7.10 or 1.15.2
VersionInsulation = false // Version Isolation
GameResourcePath = Core.RootPath, // Root path of the game resource(.minecraft/)
GamePath = path, // Root path of the game (.minecraft/versions/)
VersionLocator = Core.VersionLocator // Game's version locator
};
launchSettings.GameArguments = new GameArguments // (Optional) The arguments of specific game launch, the undefined settings here will be redirected to the fallback settings mentioned previously.
{
AdvanceArguments = specificArguments , // Advanced launch arguments
JavaExecutable = specificJavaExecutable, // JAVA's path
Resolution = specificResolution, // The window's size
MinMemory = specificMinMemory, // Minimum Memory
MaxMemory = specificMaxMemory // Maximum Memory
};
```
Here are some events which you could bind to your program.
| Name | Method Signature | Refers to |
| ---------------------- | ------------------------------------- | --------- |
| GameExitEventDelegate | (object sender, GameExitEventArgs e) | Game Exit |
| GameLogEventDelegate | (object sender, GameLogEventArgs e) | Game Log |
| LaunchLogEventDelegate | (object sender, LaunchLogEventArgs e) | Core Log |
#### Define Auth Model
Offline:
```csharp
launchSettings.Authenticator = new OfflineAuthenticator
{
Username = "Username"
LauncherAccountParser = core.VersionLocator.LauncherAccountParser // launcher_profiles.json parser
},
```
Online:
```csharp
launchSettings.Authenticator = new YggdrasilAuthenticator
{
LauncherAccountParser = core.VersionLocator.LauncherAccountParser
Email = "example@example.com", // Registered E-mail address on Mojang authentication server.
Password = "password"
};
```
#### Launch!
```csharp
var result = await Core.LaunchTaskAsync(launchSettings).ConfigureAwait(true); // Returns the launch result
```
## Stats
## License
MIT. This means that you can modify or use our code for any purpose, however copyright notice and permission notice shall be included in all copies or substantial portions of your software.
## Disclaimer
ProjBobcat is not affiliated with Mojang or any part of its software.
## Hall of Shame
Here we'll list all programs using our code without obeying MIT License.