Open GUI on right click

[DevStark22]

Hello,
I'm fairly new to the KubeJS community, I'm having a little problem, I was wondering if it's possible to open a GUI when right clicking the block, I'm trying to reuse the Extended Crafting GUI to create another kind of crafting table.
Hope you understood.

Thank you

[ChiefArug]

It is possible to open GUIs like that, however keeping them open is much more difficult.
Most GUIs that are attached to blocks include checks to make sure the block is still in range and hasn't been destroyed. Of course if there's no such valid block in the first place, the check fails immediately and the GUI never opens.

That said, here is an example from the Discord for opening a GUi (it is on world login, but swapping it for block right click would be easy enough). Note that the classpath
(here its com.wildfire.gui.screen.WildfirePlayerListScreen) needs to be set to the classpath of the screen you want to open. Have a look at the mods source for that. The Screen constructor (the new WildFireScreen bit) also requires different parameters depending on the mod. These can be tricky to get sometimes, and occasionally near impossible. The example below is incredibly simple though, as its purely a client side screen with no info from the server.

A server + client script that opens a gui on first login. (In this case its wildfires gender selection screen)
Server script:

onEvent('player.logged_in', event => {
    if (event.player.persistentData.firstLogin == null) {
        event.server.scheduleInTicks(50, callback => {
            event.player.sendData('first_login', {message: "Welcome!"})
            event.player.persistentData.firstLogin = 10
        })
    }
}) 

This handles the logic of the player logging in, waiting 2.5 secs for them to finish logging in, sending them a packet to tell them to open the gui, and finally setting the players data so it doesnt happen again for that world.

In client scripts:

const WildfireScreen = java('com.wildfire.gui.screen.WildfirePlayerListScreen')
                            
onEvent('player.data_from_server.first_login', event => {
    event.player.tell(event.data.message)
    Client.setCurrentScreen(new WildfireScreen(
        Client.minecraft
    ))
}) 

This 'imports' the mods screen, then waits for the packet from the server. When it gets it it sets the players screen to the one from the mod.

You also need to set disableClassFilter to true in kubejs/config/common.properties on the client, so that KubeJS doesnt block the screen class.

[DevStark22]

Really complete answer, I'll try that, thank you !