本教學部分內容參考了wiki.vg。
本教學介紹如何製作Java版啟動器,並假定你已掌握任何一門編程語言。
基本原理
因為Minecraft製作時採用了「啟動器+遊戲檔案」的模式:
- 將遊戲檔案單獨儲存,而透過啟動器調用JVM(Java Virtual Machine,Java虛擬機)執行遊戲主檔案並傳入一些遊戲參數來啟動Minecraft。
- 遊戲依賴庫檔案以及遊戲資源檔案由啟動器補全。
- 玩家登入認證由啟動器完成。
這使得我們能透過編寫第三方啟動器來接管遊戲檔案管理和登入認證。
準備
要編寫一個啟動器,你需要:
- 一門編程語言其開發環境。
- Java執行時環境(Java Runtime Environment,JRE),可於Java官網下載。
並擁有支援下列功能的庫:
- 解析JSON文件(得到啟動參數的關鍵)。
- 解壓檔案(解壓natives檔案,也可使用連結外部程式替代)。
- 網路庫(正版驗證、外觀管理等)。
啟動參數
啟動參數將傳入java.exe或javaw.exe,使JVM透過傳入的主類正確地啟動遊戲。
啟動參數分為JVM參數和Minecraft參數兩部分。
這對debug很有幫助,另外參考官方啟動器的方法能得到更優良的參數。
JVM參數
-X、-XX參數
配置JVM,如GC等:
-Xmx1024m最大堆大小為1024MB。-Xmn128m新生代堆大小為128MB。-XX:+UseG1GC開啟G1。-XX:-UseAdaptiveSizePolicy自動選擇年輕代區大小和相應的Survivor區比例。-XX:-OmitStackTraceInFastThrow省略異常棧資訊從而快速拋出。
-D參數
配置JVM系統屬性,格式為-D<name>=<value>。
-Dos.name=Windows 10 -Dos.version=10.0目前系統名稱及版本。-Dminecraft.launcher.brand=minecraft-launcher -Dminecraft.launcher.version=2.1.3674目前啟動器名稱及版本。-Dlog4j.configurationFile=<文件路径>\client-1.12.xml遊戲日誌組態檔。-Djava.library.path=<natives文件夹路径>目前系統下遊戲執行所需的動態連結庫。
-cp參數
全稱為-classpath,後為所有目前版本Minecraft的普通庫檔案路徑及遊戲主檔案,中間在Windows下用;隔開,其它系統下用:隔開。
Minecraft參數
以主類名開頭,通常為net.minecraft.client.main.Main,若安裝Mod載入器則一般為net.minecraft.launchwrapper.Launch
參數通常有:
--username後接使用者名稱。--version後接遊戲版本。--gameDir後接遊戲路徑。--assetsDir後接資源檔案路徑。--assetIndex後接資源索引版本。--uuid後接用户UUID。--accessToken後接登入令牌。--userType後接用户類型。--versionType後接版本類型,會顯示在遊戲主界面右下角。--width後接窗口寬度。--height後接窗口高度。--server後接伺服器地址,遊戲進入時將直接連入伺服器--port後接伺服器的端口號- 等等,可能因版本而異,具體應參考目前版本json檔案內提供的資訊。
取得參數
執行此命令可取得目前執行的Minecraft進程的參數:
wmic process where caption="javaw.exe" get commandline /value>args.txt wmic process where caption="java.exe" get commandline /value>args_java.txt
此時args.txt或args_java.txt中大致有這樣的檔案內容:
CommandLine="<javaw或java路径>" -XX:HeapDumpPath=MojangTricksIntelDriversForPerformance_javaw.exe_minecraft.exe.heapdump "-Dos.name=Windows 10" -Dos.version=10.0 -Xss1M -Djava.library.path=<natives文件夹路径> -Dminecraft.launcher.brand=minecraft-launcher -Dminecraft.launcher.version=2.1.3674 -cp <一大串用;分开的文件路径> -Xmx2G -XX:+UnlockExperimentalVMOptions -XX:+UseG1GC -XX:G1NewSizePercent=20 -XX:G1ReservePercent=20 -XX:MaxGCPauseMillis=50 -XX:G1HeapRegionSize=32M -Dlog4j.configurationFile=<log4j配置文件路径> net.minecraft.client.main.Main --username <用户名> --version <游戏版本号> --gameDir <游戏路径> --assetsDir <资源文件路径> --assetIndex <资源索引版本> --uuid <用户uuid> --accessToken <登录令牌> --userType mojang --versionType release --width <窗口宽度> --height <窗口高度>
僅保留CommandLine=後的內容,然後將該檔案後綴改為Shell可識別的,如:.bat,用cmd命令即可啟動Minecraft。
執行前注意檔案編碼。並注意官方啟動器的解壓出的natives庫檔案儲存在臨時資料夾下,可能因刪除導致無法啟動。
遊戲檔案
| 列表 |
|---|
|
JSON檔案
Minecraft大多數資訊使用JSON文件儲存管理,使用這些JSON檔案可以取得下載、管理及啟動所需的大部分資訊。
版本清單檔案
該檔案可以在mojang官方伺服器下載:
https://launchermeta.mojang.com/mc/game/version_manifest.json
{
"latest": {
"release": "1.19",
"snapshot": "22w24a"
},
"versions": [
{
"id": "22w24a",
"type": "snapshot",
"url": "https://piston-meta.mojang.com/v1/packages/b74d6df246b9b60e39855076ef171aa7071276f7/22w24a.json",
"time": "2022-06-15T16:26:14+00:00",
"releaseTime": "2022-06-15T16:21:49+00:00"
},
{
"id": "1.19",
"type": "release",
"url": "https://piston-meta.mojang.com/v1/packages/b03af5eb291163f7acc042d1553f2d212b220ecc/1.19.json",
"time": "2022-06-15T16:13:27+00:00",
"releaseTime": "2022-06-07T09:42:18+00:00"
},
...
]
}
其中,latest中為目前最新版本,分為發佈版和快照版。versions後為所有可下載的遊戲版本,url後為該版本的json檔案下載地址。
版本json檔案
該檔案一般下載後儲存在.minecraft/versions資料夾下,有如下內容:
{
"arguments": {
"game": [
"--username",
"${auth_player_name}",
"--version",
"${version_name}",
...
{
"rules": [
{
"action": "allow",
"features": {
"is_demo_user": true
}
}
],
"value": "--demo"
},
...
],
"jvm": [
{
"rules": [
{
"action": "allow",
"os": {
"name": "osx"
}
}
],
"value": [
"-XstartOnFirstThread"
]
},
...
]
},
"assetIndex": {
"id": "1.19",
"sha1": "d45eb5e0c20e5d753468de3d68b05c45a946f49b",
"size": 385416,
"totalSize": 553754183,
"url": "https://piston-meta.mojang.com/v1/packages/d45eb5e0c20e5d753468de3d68b05c45a946f49b/1.19.json"
},
"assets": "1.19",
"complianceLevel": 1,
"downloads": {
"client": {
"sha1": "dc26b29eb345cbb60e3939af0b7c78fa52a60daa",
"size": 21550637,
"url": "https://piston-data.mojang.com/v1/objects/dc26b29eb345cbb60e3939af0b7c78fa52a60daa/client.jar"
},
"client_mappings": {
"sha1": "e30571a5d3b123b42dcf141570ed0737434e8c4c",
"size": 7176338,
"url": "https://piston-data.mojang.com/v1/objects/e30571a5d3b123b42dcf141570ed0737434e8c4c/client.txt"
},
"server": {
"sha1": "fdad42550c3f0bcdc52680dcebd5b712d32bc5d7",
"size": 45557085,
"url": "https://piston-data.mojang.com/v1/objects/fdad42550c3f0bcdc52680dcebd5b712d32bc5d7/server.jar"
},
"server_mappings": {
"sha1": "f31da192de018cbd3b449881f8778f5fcec6f56b",
"size": 5556366,
"url": "https://piston-data.mojang.com/v1/objects/f31da192de018cbd3b449881f8778f5fcec6f56b/server.txt"
}
},
"id": "22w24a",
"javaVersion": {
"component": "java-runtime-gamma",
"majorVersion": 17
},
"libraries": [
{
"downloads": {
"artifact": {
"path": "com/mojang/logging/1.0.0/logging-1.0.0.jar",
"sha1": "f6ca3b2eee0b80b384e8ed93d368faecb82dfb9b",
"size": 15343,
"url": "https://libraries.minecraft.net/com/mojang/logging/1.0.0/logging-1.0.0.jar"
}
},
"name": "com.mojang:logging:1.0.0"
},
...
],
"logging": {
"client": {
"argument": "-Dlog4j.configurationFile=${path}",
"file": {
"id": "client-1.12.xml",
"sha1": "bd65e7d2e3c237be76cfbef4c2405033d7f91521",
"size": 888,
"url": "https://launcher.mojang.com/v1/objects/bd65e7d2e3c237be76cfbef4c2405033d7f91521/client-1.12.xml"
},
"type": "log4j2-xml"
}
},
"mainClass": "net.minecraft.client.main.Main",
"minimumLauncherVersion": 21,
"releaseTime": "2022-06-15T16:21:49+00:00",
"time": "2022-06-15T16:21:49+00:00",
"type": "snapshot"
}
rules
- 用於可選條目,使用
features判斷並應用其action。
arguments
- 1.13後新增鍵,舊版本為
gameArguments,且不提供JVM參數及rules規則。
${****}
- 字串模板,替換相應內容來使用。
assetIndex
- 目前版本的資源檔案索引,包含其下載地址等資訊。
downloads
- 遊戲主檔案,分為用戶端及伺服器端,包含其下載地址等資訊。
libraries
- 遊戲所有依賴庫,包含其下載地址等資訊。
downloads下均含有artifact鍵,有些含有classifiers鍵。- 只含有
artifact鍵的為-cp參數後所需拼接的路徑,注意path鍵中為不完整路徑,請補全為完整路徑。 - 含有
classifiers鍵的為natives庫,在遊戲啟動前將對應平台的含有jar檔案解壓至natives資料夾。
- 只含有
logging
- log4j組態檔,包含其下載地址等資訊。
mainClass
- 主類名。
資源索引檔案
一般儲存於.minecraft/assets/indexes路徑下,用於指示objects檔案的資訊及其下載地址。
該檔案的下載地址等資訊儲存在版本json檔案中,該檔案可能需要不定期更新。
內容如下:
{
"objects": {
"icons/icon_16x16.png": {
"hash": "bdf48ef6b5d0d23bbb02e17d04865216179f510a",
"size": 3665
},
...
}
}
objects檔案的下載地址為:
http://resources.download.minecraft.net/<hash的前兩位字元>/<hash>
儲存路徑為:
.minecraft/assets/objects/<hash的前两位字符>/<hash>
並在.minecraft/assets/virtual/legacy/留下一份拷貝。
啟動器組態檔
該檔案不是必須的,但它是官方啟動器的組態檔。所以可用於與官方啟動器數據互通,以及Forge安裝檢驗。
最簡單的組態檔為:
{
"profiles": {
"(Default)": {
"gameDir": "<游戏目录>",
"lastVersionId": "1.14.1",
"name": "(Default)"
}
},
"selectedProfileName": "(Default)",
}
profiles為啟動器中建立的所有組態檔。
遊戲主檔案
通常儲存於.minecraft/versions/<version>/<version>.jar,下載地址等資訊儲存在版本json檔案中,下載時注意將該檔案重新命名為對應版本號。
依賴庫檔案
通常儲存於.minecraft/libraries/路徑下,下載地址等資訊儲存在版本json檔案中。
普通庫檔案
在啟動前需拼接在啟動參數的-cp參數後。
natives庫檔案
在啟動前需解壓至natives路徑下。
資源檔案
通常儲存在.minecraft/assets/objects/,並在.minecraft/assets/virtual/legacy/有一份拷貝。
下載地址等資訊儲存在資源索引檔案中。
這些檔案可能在發佈後更新,留意更新資源索引檔案來更新他們。
正版驗證
Minecraft自1.6後使用了Yggdrasil驗證方法,驗證伺服器為:
https://authserver.mojang.com
驗證時需要:
- 為
POST請求 Content-Type設定為application/json- 負載以JSON編碼
若請求成功則返回狀態碼200及一個JSON文件。
若失敗則返回錯誤資訊:
{
"error": "错误简要描述",
"errorMessage": "向用户显示的长描述",
"cause": "错误原因" // 可选的
}
具體錯誤資訊可參考https://wiki.vg/ZH:Authentication#錯誤。
驗證賬號密碼
- 後綴:
/authenticate
- 負載:
{
"agent": {
"name": "Minecraft", // 默认为Minecraft,可选
"version": 1 // 未来可能会改(不会)
},
"username": "mojang用户名", // 可以是邮箱地址或旧版mojang用户名
"password": "密码",
"clientToken": "客户端标识符" // 可选的,用于复用该值
}
- 響應:
{
"accessToken": "随机令牌",
"clientToken": "客户端标识符",
"availableProfiles": [
{
"id": "profile identifier",
"name": "玩家名"
}
],
"selectedProfile": {
"id": "不含-的uuid",
"name": "玩家名"
}
}
(有刪節,參考https://wiki.vg/ZH:Authentication#Authentication)
你可以儲存這個clientToken,用來標識這個用戶端。
此處取得的uuid和accessToken即為啟動參數中所需的,傳入你剛剛獲得的值,啟動遊戲後便能發現已顯示正版外觀,即完成了正版登入。
檢驗令牌有效性
accessToken具有有效期,可能因為一些原因失效。你可以發送請求,驗證目前accessToken是否還是有效的.
- 後綴:
/validate
- 負載:
{
"accessToken": "valid accessToken",
"clientToken": "associated clientToken" //可选的
}
- 響應:
如果狀態碼為204 No Content則有效,而403 Forbidden為已失效。
刷新令牌
刷新一個accessToken,用於保持用户在遊戲對談之間登入。
- 後綴:
/refresh
- 負載:
{
"accessToken": "valid accessToken",
"clientToken": "associated clientToken" //可选的
}
- 響應:
{
"accessToken": "随机令牌",
"clientToken": "客户端标识符",
"availableProfiles": [
{
"id": "profile identifier",
"name": "玩家名"
}
],
"selectedProfile": {
"id": "不含-的uuid",
"name": "玩家名"
}
}
(有刪節,參考https://wiki.vg/ZH:Authentication#Refresh)
與「驗證賬號密碼」中相同。
啟動遊戲
- 首先必須保證啟動參數中出現的所有檔案及提供的資源索引檔案中的
object檔案都存在且未被損壞。 - 選定一個natives路徑,可以自由選定,也可像官方啟動器一樣使用臨時路徑。將natives庫檔案解壓至該路徑,並將該路徑使用
-Djava.library.path=傳入遊戲。 - 完成正版驗證,得到UUID及accessToken。
- 拼接啟動參數,建立遊戲進程。
- 處理遊戲輸出及遊戲錯誤。
支援forge等Mod載入器
執行forge等Mod載入器的安裝包後,可以發現:
- 啟動器組態檔中加入了一條新安裝的配置。
.minecraft/libraries/資料夾中多了一些檔案。.minecraft/versions/資料夾中多了一個版本json檔案(也可能會有jar檔案)。
額外的版本json檔案
該檔案相比原版的版本json檔案檔案多了inheritsFrom和jar鍵,而且其他鍵內容明顯是不完整的。
inheritsFrom- 該參數指定了目前版本所繼承的原版版本,意思為除此版本json檔案外,同時使用
inheritsFrom中指定的版本json檔案內容。即,-cp參數後同時包含兩個版本json檔案指定的普通庫檔案,且natives庫檔案也同時包含兩個版本json檔案指定的,且該版本json檔案優先於原版版本json檔案。
jar- 該參數指定了
-cp參數後的遊戲主檔案。
- 除此之外,版本json檔案中的
libraries鍵的格式也有些不一樣了,如:
{
"name": "org.ow2.asm:asm-all:5.0.3",
"serverreq": true
},
{
"name": "jline:jline:2.13",
"url": "http://files.minecraftforge.net/maven/",
"checksums": [
"2d9530d0a25daffaffda7c35037b046b627bb171"
],
"serverreq": true,
"clientreq": false
}
不再有downloads鍵了,只剩下name和url,檔案路徑及下載路徑需要根據一定規則拼接。
name鍵的格式為:
<package>:<name>:<version>
我們將它變形重組一下:
<package>/<name>/<version>/<name>-<version>.jar
前方接上.minecraft/libraries/即為檔案路徑,而接上url的內容即為下載地址。
serverreq和clientreq用於區分用戶端和伺服器端的需要。
最佳化下載
有時,在官方伺服器下載檔案會很緩慢,這時可以考慮使用第三方鏡像下載。
目前常用的第三方鏡像有:
另外,Minecraft的依賴庫檔案和資源索引檔案很多為小檔案,可以考慮使用多執行緒下載來最佳化速度。
外觀管理
外觀管理需要使用Mojang API:
api.mojang.com
取得外觀及披風
可透過發送GET請求獲得外觀及披風地址:
https://sessionserver.mojang.com/session/minecraft/profile/<uuid>
- 響應:
{
"id": "<配置标识符>",
"name": "<玩家名>",
"properties": [
{
"name": "textures",
"value": "<base64字符串>"
}
]
}
解碼該base64字串,可獲得另一JSON文件:
{
"timestamp": <java time in ms>,
"profileId": "<配置uuid>",
"profileName": "<玩家名>",
"textures": {
"SKIN": {
"url": "<玩家皮肤URL>"
},
"CAPE": {
"url": "<玩家披风URL>"
}
}
}
更換外觀
發送POST請求至:
https://api.mojang.com/user/profile/<uuid>/skin
- 頭:
Authorization: Bearer <access token>
- 負載:
model=<""/"slim">&url=<皮肤url>
空字串為Steve模型,「slim」為Alex模型。
上載外觀
發送PUT請求至:
https://api.mojang.com/user/profile/<uuid>/skin
- 頭:
Authorization: Bearer <access token>
- 負載:
由兩部分組成:
- model:人物模型,空字串為Steve模型,「slim」為Alex模型。
- file:原始圖像檔案數據。
重設外觀
發送DELETE請求至:
https://api.mojang.com/user/profile/<uuid>/skin
- 頭:
Authorization: Bearer <access token>
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||