Page MenuHomeWildfire Games

Clarify the use of the macmouse config option
Changes PlannedPublic

Authored by Imarok on Apr 26 2019, 2:11 AM.

Details

Reviewers
None
Summary

As stated in rP16380 macmouse emulates rightclick by ctrl+click. That interferes with some session hotkeys. That should be stated in default.cfg so that anyone using that option is aware of that issue.

Test Plan

Agree

Diff Detail

Repository
rP 0 A.D. Public Repository
Branch
/ps/trunk
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 7311
Build 11904: Vulcan BuildJenkins
Build 11903: arc lint + arc unit

Event Timeline

Imarok created this revision.Apr 26 2019, 2:11 AM

Successful build - Chance fights ever on the side of the prudent.

Link to build: https://jenkins.wildfiregames.com/job/differential/1290/display/redirect

elexis added a subscriber: elexis.Apr 26 2019, 10:55 AM

Which two other places are traditionally kept in sync with this file?
Also, how many mac players will look at default.cfg?

In D1849#76307, @elexis wrote:

Which two other places are traditionally kept in sync with this file?
Also, how many mac players will look at default.cfg?

To my knowledge this is the only place where macmouse is mentioned. It's neither in the manual nor on the hotkeys wikipage as it is no hotkey.

Stan added a subscriber: Stan.Apr 26 2019, 5:27 PM

What about also adding an option for Mac Users in the menu ?

In D1849#76361, @Imarok wrote:
In D1849#76307, @elexis wrote:

Which two other places are traditionally kept in sync with this file?
Also, how many mac players will look at default.cfg?

To my knowledge this is the only place where macmouse is mentioned. It's neither in the manual nor on the hotkeys wikipage as it is no hotkey.

So the intention is just to inform developers who modify default.cfg, but not to inform users with a mac mouse that their hotkeys might need to be changed?

Why not expose it as an option in the UI if it's relevant for mac users?
Or perhaps detect with SDL if buttons == 1, but that might also be confusing to the user.

Doesn't mac also have a built in function to emulate rightclicks?

Stan added a comment.Apr 26 2019, 7:10 PM
In D1849#76384, @elexis wrote:

So the intention is just to inform developers who modify default.cfg, but not to inform users with a mac mouse that their hotkeys might need to be changed?
Why not expose it as an option in the UI if it's relevant for mac users?
Or perhaps detect with SDL if buttons == 1, but that might also be confusing to the user.
Doesn't mac also have a built in function to emulate rightclicks?

That's the feature, it's just not enabled by default in the SDL

Gamesetup.cpp

SDL_SetHint(SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK, macMouse ? "1" : "0");
In D1849#76384, @elexis wrote:
In D1849#76361, @Imarok wrote:
In D1849#76307, @elexis wrote:

Which two other places are traditionally kept in sync with this file?
Also, how many mac players will look at default.cfg?

To my knowledge this is the only place where macmouse is mentioned. It's neither in the manual nor on the hotkeys wikipage as it is no hotkey.

So the intention is just to inform developers who modify default.cfg, but not to inform users with a mac mouse that their hotkeys might need to be changed?

Where would you add that to inform the users?

Where would you add that to inform the users?

In the files that inform users about hotkeys? Which are the same as:

Which two other places are traditionally kept in sync with this file?

A third place was mentioned in the comments too.

In D1849#76530, @elexis wrote:

Where would you add that to inform the users?

In the files that inform users about hotkeys? Which are the same as:

Which two other places are traditionally kept in sync with this file?

A third place was mentioned in the comments too.

Sure, but I don't think that would match in the manual. And concerning how seldom that feature is used an option seems too overkill.

Sure, but I don't think that would match in the manual.

What stops us from keeping the manual in sync?

And why is the manual not the first place to look at if the purpose of the diff is to inform mac users how to adapt their thing rather than in the source that only developers see?

If the setting is relevant to all or the majority of mac users (is it?), why would it be overkill to expose it in the GUI?

Imarok planned changes to this revision.Mon, May 13, 10:33 PM
In D1849#77631, @elexis wrote:

Sure, but I don't think that would match in the manual.

What stops us from keeping the manual in sync?

Yeah, why not.

And why is the manual not the first place to look at if the purpose of the diff is to inform mac users how to adapt their thing rather than in the source that only developers see?
If the setting is relevant to all or the majority of mac users (is it?), why would it be overkill to expose it in the GUI?

I think it's just a minority of mac users.

I think it's just a minority of mac users.

@vladislavbelov got numbers on mac users and perhaps number of mouse buttons?
Even without numbers, if we can estimate that the option is relevant to half of mac users, it sounds relevant.
Imagine you have to play on a mac and can't use right click. Your ability to use the game is strongly impacted, no?

In D1849#78009, @elexis wrote:

I think it's just a minority of mac users.

@vladislavbelov got numbers on mac users and perhaps number of mouse buttons?
Even without numbers, if we can estimate that the option is relevant to half of mac users, it sounds relevant.
Imagine you have to play on a mac and can't use right click. Your ability to use the game is strongly impacted, no?

Many mac users have normal external mice.
There will also be many that just use "two-finger clicks".
So there should only be about 2%-10% remaining. (I am no mac user, so I am just estimating)

In D1849#77631, @elexis wrote:

Sure, but I don't think that would match in the manual.

What stops us from keeping the manual in sync?
And why is the manual not the first place to look at if the purpose of the diff is to inform mac users how to adapt their thing rather than in the source that only developers see?

Because the manual is a whole different difficulty level of configuration than the macmouse setting.
The manual is meant for beginners. Setting macmouse in the config file is something for more advanced users.
If we add macmouse to the manual, we would first need to explain the whole process of changing the config etc..