Option to Toggle "Lock/Unlock Mouse Cursor"

[lilgec]

I'm sorry for making yet another thread, I know this is suggested from time to time already, but I was hopeful that we'd get the option in the Homesteading update. Seeing as my hopes and dreams have been crushed yet again, I'm creating a thread. Sorry!

Can we please get an option to toggle the Lock/Unlock mouse cursor option? It's not the biggest deal because I can find a few workarounds (opening chat locks the cursor, but you cannot change the mode of whatever tool is being used; opening inventory and moving it nearly off screen works but does obscure portions of the screen, etc) but they feel janky as hell to use, especially when there's literally an option to make my mouse not an aneurism to use while smithing - it's just that this option requires dexterity IRL since I'm lefty. It just feels bad to have to use such janky workarounds when there *is* an option to avoid having to do such things lmao

please add toggle mouse cursor option 

 

Edited October 3, 2021 by lilgec

[Streetwind]

In what scenarios do you need your mouse cursor unlocked that the game doesn't automatically unlock it for you?

[lilgec]

Smithing/Knapping/Clayforming. You know, a pretty large part of the game? lol
I do mention smithing directly in my post.

Edited October 6, 2021 by lilgec

[Kolyenka]

isn't that just what immersive mouse mode does? i know it's not a perfect system (having to hold alt to do stuff in your inventory is annoying as hell), but it unlocks the mouse in all situations, and then introduces the use of alt as a toggle to turn it off.

[RogueRaiden]

What I was going to start a new thread for: simply a toggle option just like the Toggle Sprint option for when you press the "lock/unlock" cursor button. So you can have BOTH the options to press and hold a button to keep your mouse unlocked OR press it once and its unlocked then press again to lock.
 

It would help out immensely in Immersive Mouse mode, especially when I'm looking to clear my inventory with 9 chests open I wont have to hold the cursor unlock button for 5 straight minutes or longer

Edited November 19, 2021 by RogueRaiden

[gibbelblonk]

This is really needed, my joints are exploding at this point from holding down alt for hours.

[Maelstrom]

29 minutes ago, gibbelblonk said:

This is really needed, my joints are exploding at this point from holding down alt for hours.

Open the inventory or character sub-screen when knapping, clay forming or forging as an alternative to mashing the alt key.

[gibbelblonk]

1 hour ago, Maelstrom said:

Open the inventory or character sub-screen when knapping, clay forming or forging as an alternative to mashing the alt key.

What?

[Maelstrom]

When you are knapping a stone tool, forming a clay item or working an ingot on an anvil, press c (the character stats screen) and it will lock the screen the same as holding down the alt key.

[gibbelblonk]

11 hours ago, Maelstrom said:

When you are knapping a stone tool, forming a clay item or working an ingot on an anvil, press c (the character stats screen) and it will lock the screen the same as holding down the alt key.

Not in immersive mouse mode...

[Maelstrom]

Works in non-immersive mouse mode which many people play in (and seems to be default playstyle).

[Quarg]

Also throwing my hat in here to say that I would *really* like an extra couple options for this.

Having an option for the mouse mode toggle, and perhaps an option to make opening your inventory auto-toggle it while in immersive mouse mode would make this feature a lot more usable, at least for me personally.

Googling for it and looking for mods I've seen people ask for the option for it to be a toggle multiple times.

[Xiarno]

I would also like for this to be added.

[Thorfinn]

I'm trying to understand what exactly is being asked for here. Does it boil down to, "I want to use immersive mouse except when I'm doing voxel stuff"? (Presumably to include chiseling?) 

I wouldn't swear to it, but it's probably something that can be done with a macro. The setting, 

    "immersiveMouseMode": true,

is in the clientsettings.json, and updates when you change it in settings in game, so there pretty much has to be some command that does it that can be mapped.

[EDIT]

Maybe I'm just not understanding what immersive mouse is supposed to do. I thought the point was to make mlook work even with other windows open. In other words, disable the lock that normal mode does. Is it something more than that? What features of "immersiveMouseMode" do you want to have in normal mode, or vice versa?

Edited November 15, 2024 by Thorfinn

[Xiarno]

1 hour ago, Thorfinn said:

I'm trying to understand what exactly is being asked for here. Does it boil down to, "I want to use immersive mouse except when I'm doing voxel stuff"? (Presumably to include chiseling?) 

I wouldn't swear to it, but it's probably something that can be done with a macro. The setting, 

    "immersiveMouseMode": true,

is in the clientsettings.json, and updates when you change it in settings in game, so there pretty much has to be some command that does it that can be mapped.

[EDIT]

Maybe I'm just not understanding what immersive mouse is supposed to do. I thought the point was to make mlook work even with other windows open. In other words, disable the lock that normal mode does. Is it something more than that? What features of "immersiveMouseMode" do you want to have in normal mode, or vice versa?

If I understand correctly, immersive mode make it so when you have an inventory open or any menu, it does not "unlock" the cursor like it would usually do.

For example:

- Immersive mouse OFF: I open my inventory. The cursor get unlocked and I can move it and use my inventory.
- Immersive mouse ON: I open my inventory. The inventory is on the screen but my mouse cursor still control my character and I have to press and hold the "Lock/Unlock Mouse Cursor" to be able to use my inventory.

It is that holding to move the cursor that we'd like an option to toggle. I personally love immersive mouse, but I absolutely do not want to hold it all the time while I move stuff in my inventory. I'd much rather have a toggle.

So what we want is an option to enable toggle of "Lock/Unlock Mouse Cursor" similar to the option to enable toggle of sprinting.

EDIT: That said, if you say that it could possibly be done with a macro, it'd be helpful if you could write how we could do it. Never touched the macro function but I would be interested in knowing.

Edited November 15, 2024 by Xiarno

[Thorfinn]

I'm not following. Why would you open inventory if you didn't want to be able to use it? The only thing I can think of right off-hand is if you wanted to use the 9 spaces in the crafting grid as inventory spaces.

Maybe it's just that I'm not following what's immersive about having to look around an inventory screen while walking around. That it's just a bad name for what it does.

[EDIT]

Oh, sorry, just noticed. Welcome to the forums, @Xiarno

Edited November 15, 2024 by Thorfinn

[Xiarno]

Just now, Thorfinn said:

I'm not following. Why would you open inventory if you didn't want to be able to use it? The only thing I can think of right off-hand is if you wanted to use the 9 spaces in the crafting grid as inventory spaces.

Maybe it's just that I'm not following what's immersive about having to look around an inventory screen while walking around. That it's just a bad name for what it does.

The inventory was just an example. It does that with any menu and container, anything that you can open. Makes it cool/useful in some situation. Maybe it's just a novelty, but I like it. And I'd appreciate it if there was an option to add a toggle, like this suggestion is.

[Thorfinn]

It also does it with smithing, knapping, etc.

Like I said, it's probably something that can be done with a macro. You just have to go through the command handbook (.chb) to figure out what the command is. If there were a lot of people who wanted that feature, it would probably already be a mod.

[ThornHorn]

This is needed feature and it hurts to see it being ignored for so long. ._.

My suggestion for implementing it will be either separate optional key-bind as "Toggle Lock/Unlock Mouse Cursor" or option in accessibility settings similar to "Toggle sprint" one. Devs, please make this happen.

[Tagswell]

Finding this recently as I was hopping to find a mod, command, or an explanation for a macro that would resolve this as well.
A bit surprised to see that most of this forum thread is just confused as to what the issue actually is.

I recorded a short unlisted Youtube video demonstrating why people are suggesting this feature for those confused.
Beyond that, I just wanted to add my voice to those who would love to have it added.

If the devs don't see this or get around to it, that's okay, but it would be nice.
I don't imagine it would take all too much development time to set up.
Or if someone could make a mod or demonstrate their own fix for it, that would be nice too. = )

Also,
I think it's important to keep in mind when it comes to accessibility and making accommodations,
very few of the people who run into this issue will bother to investigate, go on forums, or make a mod for it.
They will likely just deal with the frustration, or stop playing.

So if you ever see any threads at all requesting small changes like this anywhere online,
it's generally safe to assume there are many more who would benefit from the change who you'd never know about.
I'm always a little disappointed to see request for accommodations met with dismissal or interrogation = /
(Not saying that anyone here is guilty of that, just something I see a lot. It's okay to be curious!)

[Xiarno]

5 hours ago, Tagswell said:

Finding this recently as I was hopping to find a mod, command, or an explanation for a macro that would resolve this as well.
A bit surprised to see that most of this forum thread is just confused as to what the issue actually is.

I recorded a short unlisted Youtube video demonstrating why people are suggesting this feature for those confused.
Beyond that, I just wanted to add my voice to those who would love to have it added.

If the devs don't see this or get around to it, that's okay, but it would be nice.
I don't imagine it would take all too much development time to set up.
Or if someone could make a mod or demonstrate their own fix for it, that would be nice too. = )

Also,
I think it's important to keep in mind when it comes to accessibility and making accommodations,
very few of the people who run into this issue will bother to investigate, go on forums, or make a mod for it.
They will likely just deal with the frustration, or stop playing.

So if you ever see any threads at all requesting small changes like this anywhere online,
it's generally safe to assume there are many more who would benefit from the change who you'd never know about.
I'm always a little disappointed to see request for accommodations met with dismissal or interrogation = /
(Not saying that anyone here is guilty of that, just something I see a lot. It's okay to be curious!)

Thanks for the video! This basically show exactly the issue and why we'd love a way toggle for that. The argument could be the same as the reason for the toggle on sneaking/sprinting. For some people, it's uncomfortable holding it.

[Tagswell]

2 hours ago, Xiarno said:

Thanks for the video! This basically show exactly the issue and why we'd love a way toggle for that. The argument could be the same as the reason for the toggle on sneaking/sprinting. For some people, it's uncomfortable holding it.

I'm glad to hear that you appreciated the demonstration!
I'm even more glad to report that I managed to find a pretty decent fix that works for me, using the in-game macros.

I recorded another video demonstrating the fix in action and some of it's quirks.
But I'll also just write out the fix here for those who don't want to watch it.

The solution I'm using is setting up a macro in game to toggle Immersive Mouse Mode on and off with a command.
Here's how to do it yourself:

1. Press Ctrl + M while in game to open the macro editor menu.
2. Type ".cf immersivemousemode toggle" into the commands section (without the quotes).
3. Bind the hotkey to whatever button you want to use to toggle mouse lock.
4. Name the macro whatever you want, and save the macro.
5. Enjoy!

And it works surprisingly well. A few quirks, as shown in the video, but almost perfect for me.
An actual toggle would still be more ideal, and allow for much more seamless use of IMM,
but I hope this fix helps others as much as it helped me! = )

^This is on Version 1.20.3 (Stable). In case the commands are different in earlier/later versions.

Edited February 2, 2025 by Tagswell
Format mistake = P

[Xiarno]

17 minutes ago, Tagswell said:

I'm glad to hear that you appreciated the demonstration!
I'm even more glad to report that I managed to find a pretty decent fix that works for me, using the in-game macros.

I recorded another video demonstrating the fix in action and some of it's quirks.
But I'll also just write out the fix here for those who don't want to watch it.

The solution I'm using is setting up a macro in game to toggle Immersive Mouse Mode on and off with a command.
Here's how to do it yourself:

1. Press Ctrl + M while in game to open the macro editor menu.
2. Type ".cf immersivemousemode toggle" into the commands section (without the quotes).
3. Bind the hotkey to whatever button you want to use to toggle mouse lock.
4. Name the macro whatever you want, and save the macro.
5. Enjoy!

And it works surprisingly well. A few quirks, as shown in the video, but almost perfect for me.
An actual toggle would still be more ideal, and allow for much more seamless use of IMM,
but I hope this fix helps others as much as it helped me! = )

^This is on Version 1.20.3 (Stable). In case the commands are different in earlier/later versions.

Yeah, that's what I also did. I'd still much more prefer a toggle functionality though.

[nomorestars]

I can understand a certain level of misunderstanding in this thread, however toggling immersive mouse mode does nothing to alleviate all use-cases where a simple toggle of free-mouse mode would work best such as in the case of chiseling.

[Nikita Vovchenko]

@Tagswell thanks for solution, really helpful. Where did you find documentation re ".cf immersivemousemode toggle"? I've searched through wiki and there's nothing related to immersive mode https://wiki.vintagestory.at/List_of_client_commands

I want to try few macros with inventory and can't find a good api documentation

Others see %appdata%/vintagesotrydata/clientconfig.json

It's limited and doesn't allow to manipulate inventory (ordering, etc) so if you search for something more than "bind an item from settings to a key" better search for a mod.

Also there's a mod now for toggle everyone was asking in this topic https://mods.vintagestory.at/unlockmousetoggle  Not working for Immersive Mode

Edited November 14, 2025 by Nikita Vovchenko