From cffe1a4a139e952476d39279af68c4d66d5d5389 Mon Sep 17 00:00:00 2001 From: mdthorpe Date: Sat, 16 May 2015 09:27:06 -0700 Subject: [PATCH 1/3] Converted docs to MD --- README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f61d37c --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ +Basic Help +---------- + +To advance through the game, `left-click` or press the `space` or +`enter` keys. When at a menu, `left-click` to make a choice, or use the +arrow keys to select a choice and `enter` to activate it. + +### Game Menu + +When playing a game, `right-click` or press the `escape` key to enter +the game menu. The game menu gives the following choices: + +Return +: Returns to the game. +Save Game +: Allows you to save a game by clicking on a save slot. +Load Game +: Allows you to load a game by clicking on a save slot. Clicking on + "Auto" accesses the automatic save slots. +Preferences +: Changes the game preferences (options/configuration): + Display + : Switches between fullscreen and windowed mode. + Transitions + : Controls the display of transitions between game screens. + Text Speed + : Controls the rate at which text displays. The further to the + right this slider is, the faster the text will display. All the + way to the right causes text to be shown instantly. + Joystick + : Lets you control the game using a joystick. + Skip + : Chooses between skipping messages that have been already seen + (in any play through the game), and skipping all messages. + Begin Skipping + : Returns to the game, while skipping. + After Choices + : Controls if skipping stops upon reaching a menu. + Auto-Forward Time + : Controls automatic advance. The further to the left this slider + is, the shorter the amount of time before the game advances. All + the way to the right means text will never auto-forward. + Music, Sound, and Voice Volume + : Controls the volume of the Music, Sound effect, and Voice + channels, respectively. The further to the right these are, the + louder the volume. + +Main Menu +: Returns to the main menu, ending the current game. +Help +: Shows this help screen. +Quit +: Exits the game; the game will be closed and ended. + +### Key and Mouse Bindings + +Left-click, Enter +: Advances through the game, activates menu choices, buttons, and + sliders. +Space +: Advances through the game, but does not activate choices. +Arrow Keys +: Selects menu choices, buttons, and sliders. +Ctrl +: Causes skipping to occur while the ctrl key is held down. +Tab +: Toggles skipping, causing it to occur until tab is pressed again. +Mousewheel-Up, PageUp +: Causes rollback to occur. Rollback reverses the game back in time, + showing prior text and even allowing menu choices to be changed. +Mousewheel-Down, PageDown +: Causes rollforward to occur, canceling out a previous rollback. +Right-click, Escape +: Enters the game menu. When in the game menu, returns to the game. +Middle-click, H +: Hides the text window and other transient displays. +F +: Toggles fullscreen mode +S +: Takes a screenshot, saving it in a file named screenshotxxxx.png, + where xxxx is a serial number. +Alt-M, Command-H +: Hides (iconifies) the window. +Alt-F4, Command-Q +: Quits the game. +Delete +: When a save slot is selected, deletes that save slot. +v +: Toggles self-voicing mode, which reads text to the user using an + os-supplied speech synthesizer. For more information, please read + the [self-voicing](http://www.renpy.org/doc/html/self_voicing.html) + documentation. +Shift+C +: Toggles clipboard-voicing mode, which copies text to the clipboard + so it can be read by a screen reader. + +Legal Notice +------------ + +This program contains free software licensed under a number of licenses, +including the GNU Lesser Public License. A complete list of software is +available at +[http://www.renpy.org/doc/html/license.html](http://www.renpy.org/doc/html/license.html). From 3611a9f1cab422b176767206e7612dcaae9a5254 Mon Sep 17 00:00:00 2001 From: mdthorpe Date: Sat, 16 May 2015 09:32:36 -0700 Subject: [PATCH 2/3] Update README.md --- README.md | 248 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 153 insertions(+), 95 deletions(-) diff --git a/README.md b/README.md index f61d37c..b39d1c3 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,161 @@ -Basic Help ----------- + + +README + + + -Main Menu -: Returns to the main menu, ending the current game. -Help -: Shows this help screen. -Quit -: Exits the game; the game will be closed and ended. +

Basic Help

+

+ To advance through the game, left-click or press the space + or enter keys. When at a menu, left-click to make + a choice, or use the arrow keys to select a choice and enter + to activate it. +

-### Key and Mouse Bindings +

Game Menu

+

+ When playing a game, right-click or press the escape + key to enter the game menu. The game menu gives the following + choices: +

+
+
Return
+
Returns to the game.
+
Save Game
+
Allows you to save a game by clicking on a save slot.
+
Load Game
+
Allows you to load a game by clicking on a save slot. + Clicking on "Auto" accesses the automatic save slots.
+
Preferences
+
+ Changes the game preferences (options/configuration): +
+
Display
+
Switches between fullscreen and windowed mode.
+
Transitions
+
Controls the display of transitions between game + screens.
+
Text Speed
+
Controls the rate at which text displays. The further + to the right this slider is, the faster the text will display. + All the way to the right causes text to be shown instantly.
+
Joystick
+
Lets you control the game using a joystick.
+
Skip
+
Chooses between skipping messages that have been + already seen (in any play through the game), and skipping all + messages.
+
Begin Skipping
+
Returns to the game, while skipping.
+
After Choices
+
Controls if skipping stops upon reaching a menu.
+
Auto-Forward Time
+
Controls automatic advance. The further to the left + this slider is, the shorter the amount of time before the game + advances. All the way to the right means text will never + auto-forward.
+
Music, Sound, and Voice Volume
+
Controls the volume of the Music, Sound effect, and + Voice channels, respectively. The further to the right these + are, the louder the volume.
+
+
+
+
+
Main Menu
+
Returns to the main menu, ending the current game.
+
Help
+
Shows this help screen.
+
Quit
+
Exits the game; the game will be closed and ended.
+
-Left-click, Enter -: Advances through the game, activates menu choices, buttons, and - sliders. -Space -: Advances through the game, but does not activate choices. -Arrow Keys -: Selects menu choices, buttons, and sliders. -Ctrl -: Causes skipping to occur while the ctrl key is held down. -Tab -: Toggles skipping, causing it to occur until tab is pressed again. -Mousewheel-Up, PageUp -: Causes rollback to occur. Rollback reverses the game back in time, - showing prior text and even allowing menu choices to be changed. -Mousewheel-Down, PageDown -: Causes rollforward to occur, canceling out a previous rollback. -Right-click, Escape -: Enters the game menu. When in the game menu, returns to the game. -Middle-click, H -: Hides the text window and other transient displays. -F -: Toggles fullscreen mode -S -: Takes a screenshot, saving it in a file named screenshotxxxx.png, - where xxxx is a serial number. -Alt-M, Command-H -: Hides (iconifies) the window. -Alt-F4, Command-Q -: Quits the game. -Delete -: When a save slot is selected, deletes that save slot. -v -: Toggles self-voicing mode, which reads text to the user using an - os-supplied speech synthesizer. For more information, please read - the [self-voicing](http://www.renpy.org/doc/html/self_voicing.html) - documentation. -Shift+C -: Toggles clipboard-voicing mode, which copies text to the clipboard - so it can be read by a screen reader. +

Key and Mouse Bindings

+
+
Left-click, Enter
+
Advances through the game, activates menu choices, buttons, + and sliders.
+
Space
+
Advances through the game, but does not activate choices.
+
Arrow Keys
+
Selects menu choices, buttons, and sliders.
+
Ctrl
+
Causes skipping to occur while the ctrl key is held down.
+
Tab
+
Toggles skipping, causing it to occur until tab is pressed + again.
+
Mousewheel-Up, PageUp
+
Causes rollback to occur. Rollback reverses the game back + in time, showing prior text and even allowing menu choices to be + changed.
+
Mousewheel-Down, PageDown
+
Causes rollforward to occur, canceling out a previous + rollback.
+
Right-click, Escape
+
Enters the game menu. When in the game menu, returns to the + game.
+
Middle-click, H
+
Hides the text window and other transient displays.
+
F
+
Toggles fullscreen mode
+
S
+
Takes a screenshot, saving it in a file named + screenshotxxxx.png, where xxxx is a serial number.
+
Alt-M, Command-H
+
Hides (iconifies) the window.
+
Alt-F4, Command-Q
+
Quits the game.
+
Delete
+
When a save slot is selected, deletes that save slot.
+
v
+
+ Toggles self-voicing mode, which reads text to the user using an + os-supplied speech synthesizer. For more information, please read + the self-voicing + documentation. +
+
Shift+C
+
Toggles clipboard-voicing mode, which copies text to the + clipboard so it can be read by a screen reader.
+
-Legal Notice ------------- - -This program contains free software licensed under a number of licenses, -including the GNU Lesser Public License. A complete list of software is -available at -[http://www.renpy.org/doc/html/license.html](http://www.renpy.org/doc/html/license.html). +

Legal Notice

+

+ This program contains free software licensed under a number of + licenses, including the GNU Lesser Public License. A complete list + of software is available at http://www.renpy.org/doc/html/license.html. + + From 68260a68fe9db15db257eefad01a3eff5de08994 Mon Sep 17 00:00:00 2001 From: mdthorpe Date: Sat, 16 May 2015 09:32:54 -0700 Subject: [PATCH 3/3] Update README.md --- README.md | 36 ------------------------------------ 1 file changed, 36 deletions(-) diff --git a/README.md b/README.md index b39d1c3..490f43a 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,3 @@ - - -README - - -

Basic Help