Skip to content

Commit aa99daa

Browse files
rom1504extremeheat
rom1504
and
extremeheat
authored
Support 1.20.4 (#3310)
* Support 1.20.4 * Update package.json * fix externalTest hang on op message waiting * add more context to to errors * replace nodejs once() usage with mineflayer once() with a default 20s timeout * fix path * fix ChatMessages to use .fromNotch * Update chat.js add debug * add more debug * internalTest: fix chat * fix nbt.string wrap * update prismarine-windows dep * fix * add logging * replace grass -> mycelium for test * remove debug console.log in chat.js * Update package.json * Update package.json --------- Co-authored-by: extremeheat <[email protected]>
1 parent b9491ae commit aa99daa

32 files changed

+224
-208
lines changed

‎lib/bossbar.js

+92-95
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,98 @@
1-
let ChatMessage
21
const colors = ['pink', 'blue', 'red', 'green', 'yellow', 'purple', 'white']
32
const divisions = [0, 6, 10, 12, 20]
43

5-
module.exports = loader
6-
74
function loader (registry) {
8-
ChatMessage = require('prismarine-chat')(registry)
9-
return BossBar
10-
}
11-
12-
class BossBar {
13-
constructor (uuid, title, health, dividers, color, flags) {
14-
this._entityUUID = uuid
15-
this._title = new ChatMessage(JSON.parse(title))
16-
this._health = health
17-
this._dividers = divisions[dividers]
18-
this._color = colors[color]
19-
this._shouldDarkenSky = flags & 0x1
20-
this._isDragonBar = flags & 0x2
21-
this._createFog = flags & 0x4
22-
}
23-
24-
set entityUUID (uuid) {
25-
this._entityUUID = uuid
26-
}
27-
28-
set title (title) {
29-
this._title = new ChatMessage(JSON.parse(title))
30-
}
31-
32-
set health (health) {
33-
this._health = health
34-
}
35-
36-
set dividers (dividers) {
37-
this._dividers = divisions[dividers]
38-
}
39-
40-
set color (color) {
41-
this._color = colors[color]
42-
}
43-
44-
set flags (flags) {
45-
this._shouldDarkenSky = flags & 0x1
46-
this._isDragonBar = flags & 0x2
47-
this._createFog = flags & 0x4
48-
}
49-
50-
get flags () {
51-
return (this._shouldDarkenSky) | (this._isDragonBar << 1) | (this._createFog << 2)
52-
}
53-
54-
set shouldDarkenSky (darkenSky) {
55-
this._shouldDarkenSky = darkenSky
56-
}
57-
58-
set isDragonBar (dragonBar) {
59-
this._isDragonBar = dragonBar
60-
}
61-
62-
get createFog () {
63-
return this._createFog
64-
}
65-
66-
set createFog (createFog) {
67-
this._createFog = createFog
68-
}
69-
70-
get entityUUID () {
71-
return this._entityUUID
72-
}
73-
74-
get title () {
75-
return this._title
76-
}
77-
78-
get health () {
79-
return this._health
80-
}
81-
82-
get dividers () {
83-
return this._dividers
84-
}
85-
86-
get color () {
87-
return this._color
88-
}
89-
90-
get shouldDarkenSky () {
91-
return this._shouldDarkenSky
92-
}
93-
94-
get isDragonBar () {
95-
return this._isDragonBar
96-
}
97-
98-
get shouldCreateFog () {
99-
return this._createFog
5+
const ChatMessage = require('prismarine-chat')(registry)
6+
return class BossBar {
7+
constructor (uuid, title, health, dividers, color, flags) {
8+
this._entityUUID = uuid
9+
this._title = ChatMessage.fromNotch(title)
10+
this._health = health
11+
this._dividers = divisions[dividers]
12+
this._color = colors[color]
13+
this._shouldDarkenSky = flags & 0x1
14+
this._isDragonBar = flags & 0x2
15+
this._createFog = flags & 0x4
16+
}
17+
18+
set entityUUID (uuid) {
19+
this._entityUUID = uuid
20+
}
21+
22+
set title (title) {
23+
this._title = ChatMessage.fromNotch(title)
24+
}
25+
26+
set health (health) {
27+
this._health = health
28+
}
29+
30+
set dividers (dividers) {
31+
this._dividers = divisions[dividers]
32+
}
33+
34+
set color (color) {
35+
this._color = colors[color]
36+
}
37+
38+
set flags (flags) {
39+
this._shouldDarkenSky = flags & 0x1
40+
this._isDragonBar = flags & 0x2
41+
this._createFog = flags & 0x4
42+
}
43+
44+
get flags () {
45+
return (this._shouldDarkenSky) | (this._isDragonBar << 1) | (this._createFog << 2)
46+
}
47+
48+
set shouldDarkenSky (darkenSky) {
49+
this._shouldDarkenSky = darkenSky
50+
}
51+
52+
set isDragonBar (dragonBar) {
53+
this._isDragonBar = dragonBar
54+
}
55+
56+
get createFog () {
57+
return this._createFog
58+
}
59+
60+
set createFog (createFog) {
61+
this._createFog = createFog
62+
}
63+
64+
get entityUUID () {
65+
return this._entityUUID
66+
}
67+
68+
get title () {
69+
return this._title
70+
}
71+
72+
get health () {
73+
return this._health
74+
}
75+
76+
get dividers () {
77+
return this._dividers
78+
}
79+
80+
get color () {
81+
return this._color
82+
}
83+
84+
get shouldDarkenSky () {
85+
return this._shouldDarkenSky
86+
}
87+
88+
get isDragonBar () {
89+
return this._isDragonBar
90+
}
91+
92+
get shouldCreateFog () {
93+
return this._createFog
94+
}
10095
}
10196
}
97+
98+
module.exports = loader

‎lib/plugins/anvil.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const assert = require('assert')
22
const { sleep } = require('../promise_utils')
3-
const { once } = require('events')
3+
const { once } = require('../promise_utils')
44

55
module.exports = inject
66

@@ -12,7 +12,7 @@ function inject (bot) {
1212
async function openAnvil (anvilBlock) {
1313
const anvil = await bot.openBlock(anvilBlock)
1414
if (!matchWindowType(anvil)) {
15-
throw new Error('This is not a anvil-like window')
15+
throw new Error('Not a anvil-like window: ' + JSON.stringify(anvil))
1616
}
1717

1818
function err (name) {

‎lib/plugins/book.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const assert = require('assert')
2-
const { once } = require('events')
2+
const { once } = require('../promise_utils')
33

44
module.exports = inject
55

‎lib/plugins/chat.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ function inject (bot, options) {
144144
function chatWithHeader (header, message) {
145145
if (typeof message === 'number') message = message.toString()
146146
if (typeof message !== 'string') {
147-
throw new Error('Incorrect type! Should be a string or number.')
147+
throw new Error('Chat message type must be a string or number: ' + typeof message)
148148
}
149149

150150
if (!header && message.startsWith('/')) {

‎lib/plugins/chest.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ function inject (bot) {
2323
throw new Error('containerToOpen is neither a block nor an entity')
2424
}
2525

26-
if (!matchWindowType(chest)) { throw new Error('Non-container window used as a container') }
26+
if (!matchWindowType(chest)) { throw new Error('Non-container window used as a container: ' + JSON.stringify(chest)) }
2727
return chest
2828
}
2929

‎lib/plugins/craft.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const assert = require('assert')
2-
const { once } = require('events')
2+
const { once } = require('../promise_utils')
33

44
module.exports = inject
55

@@ -12,7 +12,7 @@ function inject (bot) {
1212
assert.ok(recipe)
1313
count = parseInt(count ?? 1, 10)
1414
if (recipe.requiresTable && !craftingTable) {
15-
throw new Error('recipe requires craftingTable')
15+
throw new Error('Recipe requires craftingTable, but one was not supplied: ' + JSON.stringify(recipe))
1616
}
1717

1818
try {
@@ -41,7 +41,7 @@ function inject (bot) {
4141
windowCraftingTable = window
4242
}
4343
if (!windowCraftingTable.type.startsWith('minecraft:crafting')) {
44-
throw new Error('crafting: non craftingTable used as craftingTable')
44+
throw new Error('crafting: non craftingTable used as craftingTable: ' + windowCraftingTable.type)
4545
}
4646
await startClicking(windowCraftingTable, 3, 3)
4747
} else {

‎lib/plugins/creative.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const assert = require('assert')
22
const { Vec3 } = require('vec3')
33
const { sleep, onceWithCleanup } = require('../promise_utils')
4-
const { once } = require('events')
4+
const { once } = require('../promise_utils')
55

66
module.exports = inject
77

@@ -70,7 +70,7 @@ function inject (bot) {
7070

7171
// last step
7272
bot.entity.position = destination
73-
await once(bot, 'move')
73+
await once(bot, 'move', /* no timeout */ 0)
7474
}
7575

7676
function startFlying () {

‎lib/plugins/enchantment_table.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const assert = require('assert')
2-
const { once } = require('events')
2+
const { once } = require('../promise_utils')
33

44
module.exports = inject
55

@@ -9,7 +9,7 @@ function inject (bot) {
99
let ready = false
1010
const enchantmentTable = await bot.openBlock(enchantmentTableBlock)
1111
if (!enchantmentTable.type.startsWith('minecraft:enchant')) {
12-
throw new Error('This is not an enchantment table')
12+
throw new Error('Expected minecraft:enchant when opening table but got ' + enchantmentTable.type)
1313
}
1414

1515
resetEnchantmentOptions()

‎lib/plugins/entities.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ function inject (bot) {
597597
}
598598

599599
if (item.displayName) {
600-
obj.displayName = new ChatMessage(JSON.parse(item.displayName))
600+
obj.displayName = ChatMessage.fromNotch(item.displayName)
601601
} else if (packet.action & 32) obj.displayName = new ChatMessage({ text: '', extra: [{ text: player.username || obj.username }] })
602602

603603
if (newPlayer) {
@@ -660,7 +660,7 @@ function inject (bot) {
660660
}
661661

662662
if (item.displayName) {
663-
player.displayName = new ChatMessage(JSON.parse(item.displayName))
663+
player.displayName = ChatMessage.fromNotch(item.displayName)
664664
}
665665

666666
const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === item.name)
@@ -681,7 +681,7 @@ function inject (bot) {
681681
} else if (packet.action === 3 && !item.displayName) {
682682
player.displayName = new ChatMessage({ text: '', extra: [{ text: player.username }] })
683683
} else if (packet.action === 3 && item.displayName) {
684-
player.displayName = new ChatMessage(JSON.parse(item.displayName))
684+
player.displayName = ChatMessage.fromNotch(item.displayName)
685685
} else if (packet.action === 4) {
686686
if (player.entity === bot.entity) continue
687687

‎lib/plugins/inventory.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
const assert = require('assert')
22
const { Vec3 } = require('vec3')
3-
const { once } = require('events')
4-
const { sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
3+
const { once, sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
54

65
module.exports = inject
76

‎lib/plugins/tablist.js

+12-7
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,19 @@ function inject (bot) {
1313
}
1414

1515
bot._client.on('playerlist_header', (packet) => {
16-
if (packet.header) {
17-
const header = escapeValueNewlines(packet.header)
18-
bot.tablist.header = new ChatMessage(JSON.parse(header))
19-
}
16+
if (bot.supportFeature('chatPacketsUseNbtComponents')) { // 1.20.3+
17+
bot.tablist.header = ChatMessage.fromNotch(packet.header)
18+
bot.tablist.footer = ChatMessage.fromNotch(packet.footer)
19+
} else {
20+
if (packet.header) {
21+
const header = escapeValueNewlines(packet.header)
22+
bot.tablist.header = ChatMessage.fromNotch(header)
23+
}
2024

21-
if (packet.footer) {
22-
const footer = escapeValueNewlines(packet.footer)
23-
bot.tablist.footer = new ChatMessage(JSON.parse(footer))
25+
if (packet.footer) {
26+
const footer = escapeValueNewlines(packet.footer)
27+
bot.tablist.footer = ChatMessage.fromNotch(footer)
28+
}
2429
}
2530
})
2631
}

‎lib/plugins/villager.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const assert = require('assert')
2-
const { once } = require('events')
2+
const { once } = require('../promise_utils')
33

44
module.exports = inject
55

@@ -78,7 +78,7 @@ function inject (bot, { version }) {
7878
bot._client.on(tradeListPacket, gotTrades)
7979
const villager = await villagerPromise
8080
if (villager.type !== 'minecraft:villager' && villager.type !== 'minecraft:merchant') {
81-
throw new Error('This is not a villager')
81+
throw new Error('Expected minecraft:villager or minecraft:mechant type, but got ' + villager.type)
8282
}
8383

8484
villager.trades = null

‎lib/promise_utils.js

+5
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ function onceWithCleanup (emitter, event, { timeout = 0, checkCondition = undefi
7272
return task.promise
7373
}
7474

75+
function once (emitter, event, timeout = 20000) {
76+
return onceWithCleanup(emitter, event, { timeout })
77+
}
78+
7579
function withTimeout (promise, timeout) {
7680
return Promise.race([
7781
promise,
@@ -82,6 +86,7 @@ function withTimeout (promise, timeout) {
8286
}
8387

8488
module.exports = {
89+
once,
8590
sleep,
8691
createTask,
8792
createDoneTask,

0 commit comments

Comments
 (0)