this repo has no description
Help improvements (#2570)
* Help improvements
Several commands help improvements
* Advertise the Esc+F1 keyboard shortcut in the menu to switch from game to editor
Solve https://github.com/nesbox/TIC-80/issues/2274
+42
-33
+41
-32
src/studio/screens/console.c
+41
-32
src/studio/screens/console.c
···
2719
2719
#define ADDGET_FILE(macro) \
2720
2720
macro("add", \
2721
2721
NULL, \
2722
-
"upload file to the browser local storage.", \
2722
+
"Upload file to the browser local storage.", \
2723
2723
NULL, \
2724
2724
onAddCommand, \
2725
2725
NULL, \
···
2727
2727
\
2728
2728
macro("get", \
2729
2729
NULL, \
2730
-
"download file from the browser local storage.", \
2730
+
"Download file from the browser local storage.", \
2731
2731
"get <file>", \
2732
2732
onGetCommand, \
2733
2733
tabCompleteFiles, \
···
2741
2741
#define COMMANDS_LIST(macro) \
2742
2742
macro("help", \
2743
2743
NULL, \
2744
-
"show help info about commands/api/...", \
2744
+
"Show help info about commands/api/...", \
2745
2745
HelpUsage, \
2746
2746
onHelpCommand, \
2747
2747
tabCompleteHelp, \
···
2749
2749
\
2750
2750
macro("exit", \
2751
2751
"quit", \
2752
-
"exit the application.", \
2752
+
"Exit the application (Hotkey: CTRL+Q).", \
2753
2753
NULL, \
2754
2754
onExitCommand, \
2755
2755
NULL, \
···
2757
2757
\
2758
2758
macro("edit", \
2759
2759
NULL, \
2760
-
"open cart editors.", \
2760
+
"Open cart editors (Hotkey: ESC or F1).", \
2761
2761
NULL, \
2762
2762
onEditCommand, \
2763
2763
NULL, \
···
2765
2765
\
2766
2766
macro("new", \
2767
2767
NULL, \
2768
-
"creates a new `Hello World` cartridge.", \
2768
+
"Creates a new `Hello World` cartridge.", \
2769
2769
"new <$LANG_NAMES_PIPE$>", \
2770
2770
onNewCommand, \
2771
2771
tabCompleteLanguages, \
···
2773
2773
\
2774
2774
macro("load", \
2775
2775
NULL, \
2776
-
"load cartridge from the local filesystem" \
2776
+
"Load cartridge from the local filesystem" \
2777
2777
"(there's no need to type the .tic extension).\n" \
2778
-
"you can also load just the section (sprites, map etc) from another cart.", \
2778
+
"You can also load just the section (sprites, map, screen etc)" \
2779
+
"from another cart.", \
2779
2780
"load <cart> [code" TIC_SYNC_LIST(SECTION_DEF) "]", \
2780
2781
onLoadCommand, \
2781
2782
tabCompleteFiles, \
···
2783
2784
\
2784
2785
macro("save", \
2785
2786
NULL, \
2786
-
"save cartridge to the local filesystem, use $LANG_EXTENSIONS$" \
2787
-
"cart extension to save it in text format (PRO feature).", \
2787
+
"Save cartridge to the local filesystem (Hotkey: CTRL+S), use $LANG_EXTENSIONS$"\
2788
+
"cart extension to save it in text format (PRO feature).\n" \
2789
+
"Use .png file extension to save it as a png cart.", \
2788
2790
"save <cart>", \
2789
2791
onSaveCommand, \
2790
2792
tabCompleteFiles, \
···
2792
2794
\
2793
2795
macro("run", \
2794
2796
NULL, \
2795
-
"run current cart / project.", \
2797
+
"Run current cart / project (Hotkey: CTRL+R).", \
2796
2798
NULL, \
2797
2799
onRunCommand, \
2798
2800
NULL, \
···
2800
2802
\
2801
2803
macro("resume", \
2802
2804
NULL, \
2803
-
"resume last run cart / project.", \
2805
+
"Resume last run cart / project.", \
2804
2806
NULL, \
2805
2807
onResumeCommand, \
2806
2808
NULL, \
···
2808
2810
\
2809
2811
macro("eval", \
2810
2812
"=", \
2811
-
"run code provided code.", \
2813
+
"Run provided code within the console, " \
2814
+
"useful for debugging and testing.\n" \
2815
+
"\nTips\n" \
2816
+
"- Use trace() to log the results. Eg: eval trace(2+2)\n" \
2817
+
"- The virtual machine should be launched first by " \
2818
+
"running a cart; otherwise it will output an empty string.", \
2812
2819
NULL, \
2813
2820
onEvalCommand, \
2814
2821
NULL, \
···
2816
2823
\
2817
2824
macro("dir", \
2818
2825
"ls", \
2819
-
"show list of local files.", \
2826
+
"Show list of local files.", \
2820
2827
NULL, \
2821
2828
onDirCommand, \
2822
2829
NULL, \
···
2824
2831
\
2825
2832
macro("cd", \
2826
2833
NULL, \
2827
-
"change directory.", \
2834
+
"Change directory.", \
2828
2835
"\ncd <path>\ncd /\ncd ..", \
2829
2836
onChangeDirectory, \
2830
2837
tabCompleteDirs, \
···
2832
2839
\
2833
2840
macro("mkdir", \
2834
2841
NULL, \
2835
-
"make a directory.", \
2842
+
"Make a directory.", \
2836
2843
"mkdir <name>", \
2837
2844
onMakeDirectory, \
2838
2845
NULL, \
···
2840
2847
\
2841
2848
macro("folder", \
2842
2849
NULL, \
2843
-
"open working directory in OS.", \
2850
+
"Open working directory in OS.", \
2844
2851
NULL, \
2845
2852
onFolderCommand, \
2846
2853
NULL, \
···
2848
2855
\
2849
2856
macro("export", \
2850
2857
NULL, \
2851
-
"export cart to HTML,\n" \
2858
+
"Export cart to HTML,\n" \
2852
2859
"native build (win linux rpi mac),\n" \
2853
2860
"export sprites/map/... as a .png image " \
2854
2861
"or export sfx and music to .wav files.", \
2855
-
"\nexport [" EXPORT_CMD_LIST(EXPORT_CMD_DEF) "...] " \
2856
-
"<file> [" EXPORT_KEYS_LIST(EXPORT_KEYS_DEF) "...]" , \
2862
+
"\nexport [" EXPORT_CMD_LIST(EXPORT_CMD_DEF) "] " \
2863
+
"<file> [" EXPORT_KEYS_LIST(EXPORT_KEYS_DEF) "]" , \
2857
2864
onExportCommand, \
2858
2865
tabCompleteExport, \
2859
2866
tabCompleteFiles) \
2860
2867
\
2861
2868
macro("import", \
2862
2869
NULL, \
2863
-
"import code/sprites/map/... from an external file.", \
2864
-
"\nimport [" IMPORT_CMD_LIST(IMPORT_CMD_DEF) "...] " \
2865
-
"<file> [" IMPORT_KEYS_LIST(IMPORT_KEYS_DEF) "...]", \
2870
+
"Import code/sprites/map/... from an external file.\n" \
2871
+
"While importing images, colors are merged to the " \
2872
+
"closest color of the palette.", \
2873
+
"\nimport [" IMPORT_CMD_LIST(IMPORT_CMD_DEF) "] " \
2874
+
"<file> [" IMPORT_KEYS_LIST(IMPORT_KEYS_DEF) "]", \
2866
2875
onImportCommand, \
2867
2876
tabCompleteImport, \
2868
2877
tabCompleteFiles) \
2869
2878
\
2870
2879
macro("del", \
2871
2880
"rm", \
2872
-
"delete from the filesystem.", \
2881
+
"Delete from the filesystem.", \
2873
2882
"del <file|folder>", \
2874
2883
onDelCommand, \
2875
2884
tabCompleteFilesAndDirs, \
···
2877
2886
\
2878
2887
macro("cls", \
2879
2888
"clear", \
2880
-
"clear console screen.", \
2889
+
"Clear console screen.", \
2881
2890
NULL, \
2882
2891
onClsCommand, \
2883
2892
NULL, \
···
2885
2894
\
2886
2895
macro("demo", \
2887
2896
NULL, \
2888
-
"install demo carts to the current directory.", \
2897
+
"Install demo carts to the current directory.", \
2889
2898
NULL, \
2890
2899
onInstallDemosCommand, \
2891
2900
NULL, \
···
2893
2902
\
2894
2903
macro("config", \
2895
2904
NULL, \
2896
-
"edit system configuration cartridge,\n" \
2897
-
"use `reset` param to reset current configuration,\n" \
2898
-
"use `default` to edit default cart template.", \
2905
+
"Edit system configuration cartridge.\n" \
2906
+
"Use `reset` param to reset current configuration.\n" \
2907
+
"Use `default` to edit default cart template.", \
2899
2908
"config [reset|default]", \
2900
2909
onConfigCommand, \
2901
2910
tabCompleteConfig, \
···
2903
2912
\
2904
2913
macro("surf", \
2905
2914
NULL, \
2906
-
"open carts browser.", \
2915
+
"Open carts browser.", \
2907
2916
NULL, \
2908
2917
onSurfCommand, \
2909
2918
NULL, \
···
2911
2920
\
2912
2921
macro("menu", \
2913
2922
NULL, \
2914
-
"show game menu where you can setup video, sound and input options.", \
2923
+
"Show menu where you can setup video, sound and input options.", \
2915
2924
NULL, \
2916
2925
onGameMenuCommand, \
2917
2926
NULL, \
···
3192
3201
id++;
3193
3202
}
3194
3203
3195
-
ptr += sprintf(ptr, "\n+--------+----+----+----+----+");
3204
+
ptr += sprintf(ptr, "\n+--------+----+----+----+----+\n");
3196
3205
3197
3206
return strlen(buf);
3198
3207
}