Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add keyboard shortcut support for the mcdu remote display in browser mode #86

Merged
merged 6 commits into from
Oct 18, 2023

Conversation

ozgend
Copy link
Contributor

@ozgend ozgend commented Jun 20, 2023

docs pr ref: flybywiresim/docs#887


this pr introduces keyboard shortcuts to the remote mcdu display on the browser via js keyEvents.

keyboard - mcdu key mapping

keyboard code mcdu key
F1-F6 LSK1-LSK6
F7-F12 RSK1-RSK6
A-Z A-Z
0-9, Digit, Numpad 0-9
Tab DIR
Insert PROG
Home PERF
PageUp INIT
Enter DATA
NumpadEnter DATA
Delete FPLN
End RAD
PageDown FUEL
Escape MENU
ShiftLeft AIRPORT
ArrowLeft PREVPAGE
ArrowRight NEXTPAGE
ArrowUp UP
ArrowDown DOWN
Backspace CLR
Space SP
Period DOT
Slash DIV
Minus PLUSMINUS
NumpadSubtract PLUSMINUS
NumpadAdd PLUSMINUS
NumpadDecimal DOT
NumpadDivide DIV
NumpadMultiply OVFY

@Lucky38i
Copy link
Member

Lucky38i commented Sep 3, 2023

Is there documentation for this? @ozgend

@ozgend
Copy link
Contributor Author

ozgend commented Sep 3, 2023

Is there documentation for this? @ozgend

honestly, i could not find a place for mcdu ui documentation on this repo; so i only described the introduced keymap in the pr description.

i can add the keymap documentation if i'm pointed to right/proper place

@Lucky38i
Copy link
Member

Lucky38i commented Sep 5, 2023

Is there documentation for this? @ozgend

honestly, i could not find a place for mcdu ui documentation on this repo; so i only described the introduced keymap in the pr description.

i can add the keymap documentation if i'm pointed to right/proper place

Hey, you can find our documentation here: https://github.com/flybywiresim/docs. Our docs are generated MkDocs using python. You can refer to these set of file https://github.com/flybywiresim/docs/tree/primary/docs/simbridge/simbridge-feature-guides/remote-displays for editing the documentation relating to the remote display. Feel free to ping Valastiri on the Discord for some more guidance about more intricate editing but it's fairly simple. When you reference this PR in your PR for the docs, and it's approved, I'll merge this PR and deploy it.

@ozgend ozgend changed the title introduced keyboard inputs feat: add keyboard input documentation for the mcdu remote display in browser mode Sep 8, 2023
@ozgend ozgend changed the title feat: add keyboard input documentation for the mcdu remote display in browser mode feat: add keyboard shortcut support for the mcdu remote display in browser mode Sep 8, 2023
@Valastiri
Copy link
Member

@Lucky38i docs are ready

@alepouna
Copy link
Member

A quick idea: Perhaps also we can add some icon or button that shows a little question mark button or a keyboard icon that when clicked shows the user the available keybinds?

@ozgend
Copy link
Contributor Author

ozgend commented Sep 17, 2023

A quick idea: Perhaps also we can add some icon or button that shows a little question mark button or a keyboard icon that when clicked shows the user the available keybinds?

i thought the same, but i did not want to bloat and complicate the ui itself. all the guide related to the mcdu is already on the official documentation page and this feature's documentation will be like in this preview.

@Lucky38i Lucky38i merged commit 2303485 into flybywiresim:main Oct 18, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants