Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinoahpx/modulelauncher.re
Cross-platform Minecraft Launcher library for .NET
https://github.com/sinoahpx/modulelauncher.re
bmclapi forge json launcher minecraft minecraft-launcher minecraft-launcher-core minecraft-launcher-library minecraft-versions
Last synced: about 6 hours ago
JSON representation
Cross-platform Minecraft Launcher library for .NET
- Host: GitHub
- URL: https://github.com/sinoahpx/modulelauncher.re
- Owner: SinoAHpx
- License: mit
- Created: 2020-08-01T18:25:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T11:36:16.000Z (26 days ago)
- Last Synced: 2024-11-06T10:56:08.190Z (10 days ago)
- Topics: bmclapi, forge, json, launcher, minecraft, minecraft-launcher, minecraft-launcher-core, minecraft-launcher-library, minecraft-versions
- Language: C#
- Homepage: https://sinoahpx.github.io/ModuleLauncher.NET.Documentation
- Size: 2.07 MB
- Stars: 49
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Your on-the-fly Minecraft launcher core.
[](https://nuget.org/packages/modulelauncher.re)
[](https://github.com/SinoAHpx/ModuleLauncher.Re/blob/main/LICENSE)
[](https://github.com/SinoAHpx/ModuleLauncher.Re/stargazers/)
[](https://t.me/axenhaxor)
English / [简体中文](README_ZH.md)
## Glance
- Based on .NET 6.
- Multi-platform supported.
- Launch every version of Minecraft, from very old to very new, plus Forge, OptiFine, Liteload and Fabric.
- Flexible, lightweight and extensible.
- Customizable OAuth client id & redirect url for Microsoft authorization shceme.
- Multiple resources download source (especially for Chinese users).
- Fully documented (almost).
- Waiting for you to explore more.
But you should know
- MoudleLauncher don't and won't support automatically install Forge, OptiFine, Liteload, Fabric or other loaders.
- It's not hard to implement an in-built downloader, but we didn't do it, because it will literally against the flexibility and extensiblity we promised.
## Getting started
We don't talk about very basic facts here, if you have got confused, go to [documentation](https://sinoahpx.github.io/ModuleLauncher.NET.Documentation/#/).
### Install
+ Install ModuleLauncher.Re via Nuget:
+ **IDE interface**
+ Nuget Package Manger: ```Install-Package ModuleLauncher.Re```
+ .NET CLI: ```dotnet add package ModuleLauncher.Re```
+ Or clone the repo and compile it to dynamic link library
### Launch
Assuming you must have an existing `.minecraft`. By the way, don't be afraid of these lines of codes, actually real codes are within 10 lines.
```cs
// version you want to launch
var version = "";
// initialize a MinecraftResolver instance by path of .minecraft
var minecraftResolver = new MinecraftResolver(rootPath);
// get MinecraftEntry by Minecraft id (version)
// it's very IMPORTANT
var minecraft = minecraftResolver.GetMinecraft(version);
// launch in method-chain way
// essentially only two value needed to launch Minecraft besides Minecraft version
// player: username of an offline player
// (notice that here string has been implicitly converted to AuthenticateResult)
// java: path of java executable file
var process = await minecraft.WithAuthentication("")
.WithJava(@"")
.LaunchAsync();
```
The launch method `LaunchAsync` returns an instance of `Process`, you can manipulate it as you wish.
```cs
// read and write Minecraft output
// ReadOutputLine and IsNullOrEmpty here is extension methods provided by library Manganese
while (!process.ReadOutputLine().IsNullOrEmpty())
{
Console.WriteLine(process.ReadOutputLine());
}
```
## Contribute
### Code contribution
- You can fork this repo and open a pull request to `new` branch. Noticibly you can't open a pull request directly to the `main` branch.
- Open an [issue](https://github.com/SinoAHpx/ModuleLauncher.Re/issues).
### Documentation contribution
If you didn't satified with the current document, you can:
- Open PR to [documentation repo](https://github.com/SinoAHpx/ModuleLauncher.NET.Documentation).
- Open an [issue](https://github.com/SinoAHpx/ModuleLauncher.NET.Documentation/issues) in documentation repo.
- Provice translations.
## Credits
- [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json): very powerful JSON manipulation.
- [Flurl.Http](https://github.com/tmenier/Flurl): such a fluent HTTP library.
- [Manganese](https://github.com/SinoAHpx/Manganese): good one, useful.
- [JetBrains](https://www.jetbrains.com/): provided free IDEs.
- [Google](https://google.com) and [Stack Overflow](https://stackoverflow.com).