artegoser/pimi-launcher-core
1
0
Fork 0
mirror of https://github.com/artegoser/pimi-launcher-core.git synced 2024-11-22 12:16:21 +03:00
Code Issues Projects Releases Packages Wiki Activity

making docs more accurate

Browse source
This commit is contained in:
Pierce 2018-12-30 20:47:22 -05:00
parent a7ea2803c4
commit 96cbd7c8d2
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -14,13 +14,13 @@ A script that launches Minecraft using NodeJS.
| Parameter | Type | Description | Required | | Parameter | Type | Description | Required |
|------------------|----------|-------------------------------------------------------------------------------------------|----------| |------------------|----------|-------------------------------------------------------------------------------------------|----------|
| `authorization` | Object | The result from `getAuth` function, allows the client to login in online or offline mode. | True | | `options.authorization` | Object | The result from `getAuth` function, allows the client to login in online or offline mode. | True |
| `clientPackage` | String | Path to the client package zip file. | False | | `options.clientPackage` | String | Path to the client package zip file. | False |
| `root` | String | Path where you want the launcher to work in. like `C:/Users/user/AppData/Roaming/.mc` | True | | `options.root` | String | Path where you want the launcher to work in. like `C:/Users/user/AppData/Roaming/.mc` | True |
| `os` | String | windows, osx or linux | True | | `options.os` | String | windows, osx or linux | True |
| `version.number` | String | Minecraft version that is going to be launched. | True | | `options.version.number` | String | Minecraft version that is going to be launched. | True |
| `version.type` | String | Any string. The actual Minecraft launcher uses `release` and `snapshot`. | True | | `options.version.type` | String | Any string. The actual Minecraft launcher uses `release` and `snapshot`. | True |
| `memory.max` | String | Max amount of memory being used by Minectaft | True | | `options.memory.max` | String | Max amount of memory being used by Minectaft | True |
#### launcher.authenticator Functions #### launcher.authenticator Functions

2
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "minecraft-launcher-core", "name": "minecraft-launcher-core",
"version": "1.0.4", "version": "1.0.5",
"description": "Module that downloads Minecraft assets and runs Minecraft.", "description": "Module that downloads Minecraft assets and runs Minecraft.",
"main": "index.js", "main": "index.js",
"dependencies": { "dependencies": {