Created Fancade Web (markdown)
commited
commit
89d8f18a57396ee32f6642d232986ba8c30ae3a8
... | ... | @@ -0,0 +1,125 @@ |
1 | # Fancade Web App |
|
2 | ||
3 | Fancade is also available as a web app! |
|
4 | ||
5 | ## Starting the Web App |
|
6 | ||
7 | The web app is available at <https://play.fancade.com> |
|
8 | ||
9 | ## Linking to Games |
|
10 | ||
11 | A link to a published game can be generated in the web app (and also in the regular app after version 1.7 is released) by clicking the 'Share' button for that game. |
|
12 | ||
13 | Links to games have the following format: <https://play.fancade.com/5F084A0BCE06B710> |
|
14 | where '5F084A0BCE06B710' is the game's unique identifier. |
|
15 | ||
16 | The web app will load the linked game and directly start the first level. |
|
17 | ||
18 | ## Setting Start Level of Linked Games |
|
19 | ||
20 | The starting level of a linked game can be set by appending the level index to the end like this: <https://play.fancade.com/5F084A0BCE06B710/8> |
|
21 | The '/8' part (after the game's unique identifier) sets the start level to 8, in this case. |
|
22 | ||
23 | ## Additional Controls |
|
24 | ||
25 | The web app has additonal controls for mouse and keyboard. |
|
26 | ||
27 | In the info below, CMD and CTRL on macOS are treated as the same button. |
|
28 | ||
29 | ### Edit Mode |
|
30 | ||
31 | | Input | Description | Other | |
|
32 | | ----- |-------------| ----- | |
|
33 | | Mouse + RMB OR Arrow keys OR WASD keys OR Keypad | Pan | Shift pans slower. Pan is default in xz-plane only but using ALT unlocks free pan like in the app | |
|
34 | | Mouse scroll wheel OR Keypad +/- OR ? and ´ keys (the two buttons at the right of 0) | Zoom | Shift and CTRL modifies speed | |
|
35 | | Mouse + MMB OR O key OR R key | Orbit | Shift orbits slower, CTRL snaps angle, ALT snaps angle to topdown view | |
|
36 | | LMB + CTRL | Toggle selection of mouse-hovered block | | |
|
37 | | LMB + CTRL + Mouse move | Rectangle select adds to current selection | | |
|
38 | | Backspace OR Delete | Remove block | Removes selected blocks first. If no blocks are selected, it removes the block that the mouse hovers over. Holding down Shift continuously removes all blocks that the mouse hovers over. | |
|
39 | | E key | Open / Close block | | |
|
40 | | T key | Open / Close block for painting | | |
|
41 | | I key | Open / Close inventory | | |
|
42 | | F key | Focus on selected / Auto-fit camera | Auto-fits camera if no blocks are selected | |
|
43 | | G key | Camera pitch snap | Same as tapping on the camera button | |
|
44 | | Shift + F key | Fill block with current paint | Only available in paint block mode | |
|
45 | | CTRL + C key | Copy blocks | | |
|
46 | | CTRL + V key | Paste blocks | | |
|
47 | | CTRL + X key | Cut blocks | | |
|
48 | | CTRL + S key | Save game in the browser's local storage | This is not a normal file in the filesystem. Local storage can easily be cleared, so it is recommended to download the game as a local file regularly using CTRL + Shift + S | |
|
49 | | CTRL + Shift + S key | Save the game as a local file | Such local files can later be dragged and dropped over the browser window to restore a lost game file or for collaboration projects | |
|
50 | | CTRL + Z key | Undo | | |
|
51 | | CTRL + Shift + Z key | Redo | | |
|
52 | | Escape key | Go back or Close | | |
|
53 | ||
54 | ||
55 | ### Play Mode |
|
56 | ||
57 | | Input | Description | Other | |
|
58 | | ----- |-------------| ----- | |
|
59 | | Arrow keys | Generate directional swipes with minor offset along secondary direction + Generating fake accelerometer inputs | Shift and CTRL modifies the distance. Special cases when detecting the Virtual Gamepad or Neo Joystick | |
|
60 | | WASD | Same as arrow keys but with opposite minor offset along secondary direction | Shift and CTRL modifies the distance | |
|
61 | | Keypad keys | Same as arrow keys but no secondary direction offsets | Shift and CTRL modifies the distance | |
|
62 | | TFGH | Fake accelerometer | Shift and CTRL modifies the angle amount, ALT adds white noise to the output | |
|
63 | | IJKL | Tap like it was an on-screen control in left-right-back-forward | | |
|
64 | | Space key OR Keypad 5 | Tap middle | | |
|
65 | | Z key | Tap left middle | | |
|
66 | | X key | Tap right middle | | |
|
67 | | Escape key | Tap top left | | |
|
68 | | Enter key | Tap top right | | |
|
69 | | P key | Pause / Resume | | |
|
70 | | Mouse + RMB | Pan with fake gesture | | |
|
71 | | Mouse scroll wheel OR ? and ´ keys OR Keypad +/- (the two buttons at the right of 0) | Zoom with fake gesture | Shift and CTRL modifies speed | |
|
72 | | Mouse + MMB | Orbit with fake gesture | | |
|
73 | | Mouse + MMB + CTRL | Pitch with fake gesture | | |
|
74 | | CTRL + R key | Restart | Also works in the pause menu | |
|
75 | | CTRL + P key | Enters "dev pause mode" where the game is paused without the pause UI showing | | |
|
76 | | Shift + P key | Steps a single frame forward in "dev pause mode" | Only works in edit mode | |
|
77 | ||
78 | ### Menus |
|
79 | ||
80 | | Input | Description | Other | |
|
81 | | ----- |-------------| ----- | |
|
82 | | Mouse scroll wheel OR Up and down arrow keys | Scroll up and down | | |
|
83 | | Left and right arrow keys | Switches tab in main menu | | |
|
84 | | Enter key | Tap the "focus" button | | |
|
85 | | Escape key | Close or back | | |
|
86 | | CTRL + Q | Eject / Exit game in pause menu | | |
|
87 | ||
88 | ### Top Menu |
|
89 | ||
90 | | CTRL + S key | Save the selected game as a local file | Only works in "Projects" or if the current logged-in user is the author of the game | |
|
91 | | Files dropped onto window | Create a new game in "Projects" for each file | Only works in the top menu. Doesn't work if the file exists or if the current logged-in user is not the author of that game (and the game is not editable). This can be used for turn-based collaboration. | |
|
92 | ||
93 | ### Misc |
|
94 | ||
95 | | Input | Description | Other | |
|
96 | | ----- |-------------| ----- | |
|
97 | | F1 | Contextual help | Open a wiki help page in a new tab. Selecting or hovering over (in the inventory) a stock prefab opens up the wiki page for that prefab. | |
|
98 | ||
99 | ||
100 | ## Size Parameters |
|
101 | ||
102 | The size of the web app canvas can be controlled with parameters. |
|
103 | ||
104 | This is useful when checking if a game works well on different screen sizes and orientations. |
|
105 | ||
106 | | Parameter | Description | Other | |
|
107 | | --------- | ----------- | ----- | |
|
108 | | max_w | Maximum width of the canvas | Default value is 1024 | |
|
109 | | max_h | Maximum height of the canvas | Default value is 768 | |
|
110 | | ar_w | Aspect ratio width | In a 4/3 aspect ratio, this parameter should be 3. If any of the ar_w or ar_h is set, the aspect ratio is forced and limited by the max_w and max_h parameters | |
|
111 | | ar_h | Aspect ratio height | In a 4/3 aspect ratio, this parameter should be 4. If any of the ar_w or ar_h is set, the aspect ratio is forced and limited by the max_w and max_h parameters | |
|
112 | ||
113 | The size of the canvas is never greater than the browser window's inner size. |
|
114 | ||
115 | If any of the aspect ratio parameters are set, the aspect ratio is enforced. |
|
116 | ||
117 | The width and height of the canvas is always maximized given the constraints from max_w, max_h, ar_w and ar_h. |
|
118 | ||
119 | Some examples of how to use the parameters: |
|
120 | ||
121 | | Link | Description | |
|
122 | | ---- | ----------- | |
|
123 | | <https://play.fancade.com?ar_w=16&ar_h=9> | Forces aspect ratio to 16/9 and maximizes the size | |
|
124 | | <https://play.fancade.com?ar_w=9&ar_h=16&max_h=800> | Forces aspect ratio to 9/16 and restricts the height to max 800 | |
|
125 |