Merge pull request #101 from YoYoGames/develop.bart

Develop.bart

Manual/GenerateKeyboardShortcutTableFromJson.py

@@ -3,15 +3,30 @@
 ### Provide the full directory path to the .json files as the command line argument.
 ### The output HTML file will also be placed there.
 ### For example: CMD > python GenerateKeyboardShortcutTableFromJson.py "C:/Users/Dev/Documents/Manual/" -name_as_desc
+###
+### You can provide an optional argument: 
+### 
+### -name_as_desc: Add this to write the hotkey's name as the description.
 ### 
-### Important: The JSON cannot contain trailing commas, this isn't supported
-###            using the built-in json module.
+### Important: Technically, the JSON cannot contain trailing commas, this isn't supported
+###            using the built-in json module. Though it is supported through the yy_load function.
 ###
 
 import sys
 import json
+import re
 from collections import OrderedDict
 
+def yy_load(file):
+    """ Load json from a file that possibly contains trailing commas """
+    # Do some tricky regex substitution
+    # so we can use the json module
+    data_string = ''.join(file.readlines())
+    data_string = re.sub("(,)(\s*[]}])","\g<2>", data_string)
+
+    # Now we can import using the json module
+    return json.loads(data_string)
+
 # Utility functions
 def get_combo_string(combo):
     if not combo:
@@ -42,9 +57,10 @@ def get_combo_string(combo):
 shortcuts_per_location = OrderedDict()  # stores shortcuts under locations
 
 # First read the Windows defaults file
-with open(fdir + "/" + fname_win_hotkeys, 'r') as f:
+with open(fdir + "/" + fname_win_hotkeys, 'r', encoding="utf-8") as f:
     # Load all the data
-    input = json.load(f)
+    # input = json.load(f)              # risk of errors if trailing commas are present
+    input = yy_load(f)                  # regex-replace variety that fixes things
 
     # Add items under their respective locations (i.e. "group" per location)
     for shortcut in input:
@@ -84,7 +100,7 @@ def get_combo_string(combo):
 # Then add the combos in the macOS defaults file
 with open(fdir + "/" + fname_mac_hotkeys, 'r') as f:
     # Load all the data
-    input = json.load(f)
+    input = yy_load(f)
 
     # Add items under their respective locations
     for shortcut in input:

Manual/contents/IDE_Navigation/Keyboard_Shortcuts.htm

@@ -39,7 +39,7 @@ <h2>Global</h2>
         <th>Scope</th>
         <th>Description</th>
       </tr>
-      <tr>
+      <tr class="rh-cursor-row">
         <td>Control + Equals</td>
         <td>Command + Equals</td>
         <td>Global</td>
@@ -702,7 +702,7 @@ <h2>Room Editor</h2>
         <th>Scope</th>
         <th>Description</th>
       </tr>
-      <tr>
+      <tr class="rh-cursor-row">
         <td>Control + R</td>
         <td>Command + R</td>
         <td>Room Editor</td>
@@ -891,8 +891,12 @@ <h2>Room Editor</h2>
         <td>Paint With Resource</td>
       </tr>
       <tr>
-        <td>Control + Alt</td>
-        <td>Command + Alt</td>
+        <td>Control + Left<br />
+          Control + Right<br />
+          Control + Up<br />
+          Control + Down</td>
+        <td>Command + Alt<br />
+          Alt + Command</td>
         <td>Room Editor</td>
         <td>Paint With Resource Precise Item Placement</td>
       </tr>
@@ -908,6 +912,12 @@ <h2>Room Editor</h2>
         <td>Room Editor</td>
         <td>Select Override</td>
       </tr>
+      <tr>
+        <td>Shift</td>
+        <td> </td>
+        <td>Room Editor</td>
+        <td>Select Tile Brush Subsection</td>
+      </tr>
     </tbody>
   </table>
   <h2>Sequence Editor</h2>
@@ -1308,7 +1318,7 @@ <h2>Image Editor</h2>
         <th>Scope</th>
         <th>Description</th>
       </tr>
-      <tr>
+      <tr class="rh-cursor-row">
         <td>Space</td>
         <td> </td>
         <td>Image Editor</td>
@@ -1657,7 +1667,7 @@ <h2>Sprite Editor</h2>
         <th>Scope</th>
         <th>Description</th>
       </tr>
-      <tr>
+      <tr class="rh-cursor-row">
         <td>Space</td>
         <td> </td>
         <td>Sprite Editor</td>
@@ -1716,7 +1726,7 @@ <h2>Object Editor</h2>
         <th>Scope</th>
         <th>Description</th>
       </tr>
-      <tr>
+      <tr class="rh-cursor-row">
         <td>Space</td>
         <td> </td>
         <td>Object Editor</td>
@@ -1946,7 +1956,7 @@ <h2>Tile Set Editor</h2>
         <th>Scope</th>
         <th>Description</th>
       </tr>
-      <tr>
+      <tr class="rh-cursor-row">
         <td>Control + Shift + I</td>
         <td>Command + Shift + I</td>
         <td>Tile Set Editor</td>