Skip to content

Commit

Permalink
docs: update kiosk.md (#6192)
Browse files Browse the repository at this point in the history
* update kiosk.md

* update kiosk code duration

* xbox mention
  • Loading branch information
eanders-ms authored Nov 3, 2023
1 parent e97c810 commit e7393f0
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/hardware/kiosk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MakeCode Arcade Kiosk

The Kiosk mode in MakeCode Arcade is meant to be used in conjunction with a MakeCode Arcade machine, a [DIY MakeCode Arcade cabinet]( https://arcade.makecode.com/hardware/raspberry-pi/wooden-cabinet), or a simple computer screen with a game controller interface – i.e. [Shoe Box Controller](https://arcade.makecode.com/hardware/shoebox-controller).
The Kiosk mode in MakeCode Arcade is meant to be used in conjunction with a MakeCode Arcade machine, a [DIY MakeCode Arcade cabinet]( https://arcade.makecode.com/hardware/raspberry-pi/wooden-cabinet), or a simple computer screen with a game controller interface – i.e. [Shoebox Controller](https://arcade.makecode.com/hardware/shoebox-controller). You can also use the [MakeCode Arcade Kiosk](https://www.xbox.com/games/store/makecode-arcade-kiosk/9p3rgvvtvb1s) app in the Xbox Store to upload and play Arcade games on the big screen with a game controller.

![Makecode Arcade consoles](/static/hardware/kiosk/makecode-arcade-machines.jpg)

Expand All @@ -14,17 +14,17 @@ If you are using a Windows computer for your Arcade machine, we recommend using

## Operating the Kiosk

The default Kiosk mode, accessed at https://arcade.makecode.com/kiosk, contains a list of popular MakeCode Arcade single and multiplayer games including [Galga](https://arcade.makecode.com/_Y8VUmcHYsdsy), [Secure the River](https://arcade.makecode.com/32777-59846-95775-11055), [Tic Tac Two](https://arcade.makecode.com/13412-17300-80986-88577), [Pigeon: Deliverance](https://arcade.makecode.com/24832-19682-40817-54648) and more – see [GameList.json](https://github.com/microsoft/pxt-arcade/blob/master/kiosk/public/GameList.json) for the full list.
The default Kiosk mode, accessed at https://arcade.makecode.com/kiosk, contains a list of popular MakeCode Arcade single and multiplayer games including [Space Destroyer](https://arcade.makecode.com/25572-25731-72869-29244), [Bunny Hop!](https://arcade.makecode.com/84490-94874-87123-99597), [Pigeon: Deliverance](https://arcade.makecode.com/60307-91678-81892-80686), [NINJA](https://arcade.makecode.com/16040-59904-05312-47571) and more – see the `kiosk` section of [targetconfig.json](https://github.com/microsoft/pxt-arcade/blob/master/targetconfig.json) for the full list.

To navigate the Kiosk interface, use the **Player 1** joystick and the **A** button:

* **Joystick**: left and right will allow you to move game selection through the carousel list
* **Joystick**: up and down allows you to select the "Add your game" button, or scroll through the alphabet when setting High Score initials for a game
* **Joystick left/right**: navigate game selection in the carousel list
* **Joystick up/down**: select the "Add your game" button, or scroll through the alphabet when setting High Score initials for a game
* **Button A**: enter or select to play a game, click on buttons, or set a name initial in the High Score interface
* **Menu button**: if your Arcade machine or controller includes a Menu button, this will take you back to the main Kiosk carousel menu screen
* **Reset button**: if your Arcade machine or controller includes a Reset button, this will take you back to the main Kiosk carousel screen

If you have a keyboard connected to your Arcade machine, you can also use the directional arrow keys or WASD keys to simulate joystick movement,
the **Space bar** for the **A** button, and the **Escape** key (Esc) for the Menu button.
If you have a keyboard connected to your Arcade machine, you can also use the <kbd>←</kbd><kbd>→</kbd><kbd>↑</kbd><kbd>↓</kbd> (directional arrow) keys or <kbd>W</kbd><kbd>A</kbd><kbd>S</kbd><kbd>D</kbd> keys to simulate joystick movement,
<kbd>Space</kbd> for **A button**, <kbd>1</kbd> for **Menu**, and <kbd>2</kbd> or <kbd>Escape</kbd> (Esc) for **Reset**.

Each game in the Kiosk has an image or gif, a title, a description, and some have a list of high scores if scoring is enabled in the game.

Expand Down Expand Up @@ -62,7 +62,7 @@ This will append your game to your Arcade machine’s kiosk game list.

Alternately, you can add a game to the kiosk through a shared game link. On the MakeCode Arcade machine, use your phone or other computer’s camera to scan the QR code in the Add your Game screen for your kiosk (or browse to http://arcade.makecode.com/kiosk#add-game:<KIOSK_ID> where the KIOSK ID is the 6-digit alphanumeric code of your kiosk) and enter in the **Share Link** for the game you would like to add to the kiosk.

Please note that for security purposes, the Kiosk ID is only valid for 10 minutes, after which time you will need to generate a new Kiosk ID. There is no limit to how many games can be added to a kiosk.
Please note that for security purposes, the Kiosk ID is only valid for 30 minutes, after which time you will need to generate a new Kiosk ID. There is no limit to how many games can be added to a kiosk.

## Deleting a game from the Kiosk

Expand All @@ -81,7 +81,7 @@ Move the joystick left or right to highlight Cancel or Confirm. Press the **A**

Instead of starting with the default game list in the MakeCode Arcade Kiosk, you can open Kiosk mode with no games in the game list. Use the **"clean=1"** flag to do this:

https://arcade.makecode.com/kiosk#clean=1
https://arcade.makecode.com/kiosk?clean=1

![No games uploaded yet](/static/hardware/kiosk/no-uploaded-games.png)

Expand All @@ -93,9 +93,9 @@ Note that if you have only uploaded one game to the kiosk, you will see multiple

Once you’ve set up your game list in the Kiosk, you have the option to lock the kiosk into a read-only mode – where no games can be added or deleted. This may be helpful if you have your MakeCode Arcade machine located in a public space and don’t want people to edit your game list. Use the **"lock=1"** flag to do this:

https://arcade.makecode.com/kiosk#lock=1
https://arcade.makecode.com/kiosk?lock=1

You can also combine lock and clean option as following

https://arcade.makecode.com/kiosk#lock=1&clean=1
https://arcade.makecode.com/kiosk?lock=1&clean=1

0 comments on commit e7393f0

Please sign in to comment.