mirror of
https://github.com/artegoser/pimi-launcher-core.git
synced 2024-11-22 04:06:21 +03:00
making docs more accurate
This commit is contained in:
parent
a7ea2803c4
commit
96cbd7c8d2
2 changed files with 8 additions and 8 deletions
14
README.md
14
README.md
|
@ -14,13 +14,13 @@ A script that launches Minecraft using NodeJS.
|
|||
|
||||
| Parameter | Type | Description | Required |
|
||||
|------------------|----------|-------------------------------------------------------------------------------------------|----------|
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `memory.max` | String | Max amount of memory being used by Minectaft | True |
|
||||
| `options.authorization` | Object | The result from `getAuth` function, allows the client to login in online or offline mode. | True |
|
||||
| `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 |
|
||||
|
||||
#### launcher.authenticator Functions
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "minecraft-launcher-core",
|
||||
"version": "1.0.4",
|
||||
"version": "1.0.5",
|
||||
"description": "Module that downloads Minecraft assets and runs Minecraft.",
|
||||
"main": "index.js",
|
||||
"dependencies": {
|
||||
|
|
Loading…
Add table
Reference in a new issue