artegoser/pimi-launcher-core
1
0
Fork 0
mirror of https://github.com/artegoser/pimi-launcher-core.git synced 2024-10-05 14:46:00 +03:00
Code Issues Projects Releases Packages Wiki Activity
pimi-launcher-core/README.md

136 lines
8.4 KiB
Markdown
Raw Normal View History

logo
2019-04-28 04:36:18 +03:00
![logo](https://pierce.is-serious.business/44U1xXh.png)
messing around on dev
2019-05-23 03:24:53 +03:00
##### This project is near complete.
[![Build Status](https://travis-ci.com/Pierce01/MinecraftLauncher-core.svg?branch=master)](https://travis-ci.com/Pierce01/MinecraftLauncher-core)
Init
2018-10-30 01:13:58 +03:00
Fixed downloads causing crashes. Better Docs
2019-02-11 05:21:14 +03:00
MCLC is a NodeJS solution for launching modded and vanilla Minecraft without having to download and format everything yourself.
Basically a core for your Electron or script based launchers.
Init
2018-10-30 01:13:58 +03:00
Adding discord server, bumping to npm aswell
2019-04-19 00:56:36 +03:00
### Getting support
Since people seem to use this, I've created a Discord server for anyone who needs to get in contact with me or get help!
https://discord.gg/8uYVbXP
Better documentation
2018-12-31 02:35:47 +03:00
### Installing
fixed an issue with NPM
2018-12-10 02:17:20 +03:00
`npm i minecraft-launcher-core`
Added Proxy and Server launch options. Reformted stuff
2019-03-11 03:18:49 +03:00
### Standard Example
```javascript
rewrite
2019-05-23 01:28:48 +03:00
const { Client, Authenticator } = require('minecraft-launcher-core');
let opts = {
clientPackage: null,
root: "./minecraft",
os: "windows",
version: {
number: "1.14",
type: "release"
,
2019-05-23 01:32:45 +03:00
},
rewrite
2019-05-23 01:28:48 +03:00
memory: {
max: "6000",
min: "4000"
}
}
const launcher = new Client(opts);
Change how authentication gets passed I was making a launcher of my own, and I found it very hard to juggle with having the auth in the options since I needed to set the client events before I actaully had the users login. This will fix the issue i was running into!
2019-05-24 03:40:44 +03:00
launcher.launch(Authenticator.getAuth(username, password));
rewrite
2019-05-23 01:28:48 +03:00
launcher.on('debug', (e) => console.log(e));
launcher.on('data', (e) => console.log(e));
launcher.on('error', (e) => console.log(e));
Added Proxy and Server launch options. Reformted stuff
2019-03-11 03:18:49 +03:00
```
Better documentation
2018-12-31 02:35:47 +03:00
### Usage
Init
2018-10-30 01:13:58 +03:00
rewrite
2019-05-23 01:28:48 +03:00
##### Client Options
| Parameter | Type | Description | Required |
|--------------------------|----------|-------------------------------------------------------------------------------------------|----------|
| `options.clientPackage` | String | Path to the client package zip file. | False |
| `options.root` | String | Path where you want the launcher to work in. like `C:/Users/user/AppData/Roaming/.mc`, | True |
| `options.os` | String | windows, osx or linux, | True |
| `options.version.number` | String | Minecraft version that is going to be launched. | True |
| `options.version.type` | String | Any string. The actual Minecraft launcher uses `release` and `snapshot`. | True |
| `options.memory.max` | String | Max amount of memory being used by Minectaft. | True |
Fixed dev bugs and old docs. Added restart and close functions
2019-05-24 02:40:34 +03:00
| `options.memory.min` | String | Min amount of memory being used by Minectaft. | True |
| `options.forge` | String | Path to Universal Forge Jar. | False |
rewrite
2019-05-23 01:28:48 +03:00
| `options.server.host` | String | Host url to the server, don't include the port. | False |
| `options.server.port` | String | Port of the host url, will default to `25565` if not entered. | False |
| `options.proxy.host` | String | Host url to the proxy, don't include the port. | False |
| `options.proxy.port` | String | Port of the host proxy, will default to `8080` if not entered. | False |
| `options.proxy.username` | String | Username for the proxy. | False |
| `options.proxy.password` | String | Password for the proxy. | False |
Fixed improper version json, added ability to set width and height
2019-05-26 23:42:23 +03:00
| `options.timeout` | Integer | Timeout on download requests. | False |
| `options.window.width` | String | Width of the Minecraft Client | False |
| `options.window.height` | String | Height of the Minecraft Client. | False |
Adds in support for custom jars like optifine
2019-04-06 04:15:12 +03:00
##### Note
Download custom resources if url is provided. Mainly made for Fabric
2019-05-11 05:10:38 +03:00
If you are loading up a client outside of vanilla Minecraft or Forge (Optifine and for an example), you'll need to download the needed files yourself
if you don't provide downloads url downloads like Forge and Fabric. Still need to provide the version jar.
Adds in support for custom jars like optifine
2019-04-06 04:15:12 +03:00
Fixed dev bugs and old docs. Added restart and close functions
2019-05-24 02:40:34 +03:00
#### Client Functions
| Function | Type | Description |
|----------|---------|-----------------------------------------------------------------------------------------|
| `launch` | Promise | Launches the client with the specified `options` |
| `close` | Promise | Closes current client |
| `restart`| Promise | Restarts by closing the current client then relaunching it with the specified `options` |
Change how authentication gets passed I was making a launcher of my own, and I found it very hard to juggle with having the auth in the options since I needed to set the client events before I actaully had the users login. This will fix the issue i was running into!
2019-05-24 03:40:44 +03:00
##### launch
| Parameter | Type | Description | Required |
|-----------|--------|--------------------------------------------------------------|----------|
| `authentication` | Object | Result from `getAuth` or the getAuth function itself. | True |
rewrite
2019-05-23 01:28:48 +03:00
#### Authenticator Functions
Better documentation
2018-12-31 02:35:47 +03:00
##### getAuth
| Parameter | Type | Description | Required |
|-----------|--------|--------------------------------------------------------------|----------|
Fixed dev bugs and old docs. Added restart and close functions
2019-05-24 02:40:34 +03:00
| `username`| String | Email or username | True |
| `password`| String | Password for the Mojang account being used if online mode. | False |
Better documentation
2018-12-31 02:35:47 +03:00
##### validate
| Parameter | Type | Description | Required |
|--------------|--------|-------------------------------------------------------------------|----------|
| `access_token` | String | Token being checked if it can be used to login with (online mode). | True |
##### refreshAuth
| Parameter | Type | Description | Required |
|--------------------|--------|-------------------------------------------------------------------------------------|----------|
| `access_token` | String | Token being checked if it can be used to login with (online mode). | True |
| `client_token` | String | Token being checked if it's the same client that the access_token was created from. | True |
| `selected_profile` | Object | Json Object that was returned from Mojangs auth api. | True |
rewrite
2019-05-23 01:28:48 +03:00
##### invalidate
| Parameter | Type | Description | Required |
|--------------|--------|-------------------------------------------------------------------|----------|
| `access_token` | String | Token being checked if it can be used to login with (online mode). | True |
| `client_token` | String | Token being checked if it's the same client that the access_token was created from. | True |
##### signOut
| Parameter | Type | Description | Required |
|--------------|--------|--------------------------------------|----------|
| `username` | String | Username used to login with | True |
| `password` | String | Password used to login with | True |
Updated documentation.
2019-02-08 22:02:42 +03:00
#### Events
Fixed downloads causing crashes. Better Docs
2019-02-11 05:21:14 +03:00
| Event Name | Type | Description |
|-------------------|---------|---------------------------------------------------------------------------------------|
Change required args from 9 to 5. New event Event allows you to see the launch arguments for debugging.
2019-04-26 20:03:39 +03:00
| `arguments` | Object | Emitted when launch arguments are set for the Minecraft Jar. |
Fixed downloads causing crashes. Better Docs
2019-02-11 05:21:14 +03:00
| `data` | Buffer | Emitted when information is returned from the Minecraft Process |
| `close` | Integer | Code number that is returned by the Minecraft Process |
| `error` | String | Emitted when the Minecraft Process errors |
| `package-extract` | null | Emitted when `clientPackage` finishes being extracted |
| `download` | String | Emitted when a file successfully downloads |
| `download-status` | Object | Emitted when data is received while downloading |
Fix EPERM error, debug event
2019-04-29 00:52:37 +03:00
| `debug` | String | Emitted when functions occur, made to help debug if errors occur |
Updated documentation.
2019-02-08 22:02:42 +03:00
Update README.md
2018-12-01 22:30:58 +03:00
gif
2018-10-30 01:40:52 +03:00
#### What should it look like running from console?
![gif](https://pierce.is-serious.business/7d91a7.gif)
Reference in a new issue Copy permalink