workflow and readme changes

.github/workflows/build.yml

@@ -50,7 +50,7 @@ jobs:
           move build\bin\Release\injector.exe Overlunky\Overlunky.exe
           move README.md Overlunky\README.txt
           move examples Overlunky\Scripts
-          7z a Overlunky_${{ steps.get_version.outputs.VERSION }}.zip Overlunky\Overlunky.exe Overlunky\injected.dll Overlunky\README.txt
+          7z a Overlunky_${{ steps.get_version.outputs.VERSION }}.zip Overlunky\
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v2

README.md

@@ -45,16 +45,22 @@ Current features and their *default* keyboard shortcuts. Note: There's a LOT of
   - **F5**: Game state
       + See and change a lot of variables from the game state
       + **Ctrl+P**: Toggle game engine pause
+  - **F8**: Scripts
+      + You can load, edit and set options for Lua scripts here
   - **F9**: Options
       + Lots of options. **Check the ini for hotkeys, I'm tired of updating this.**
   - **F11**: Hide overlay
   - **Ctrl+Shift+U**: Change UI color
   - **Ctrl+Shift+I**: ImGui internal metrics and settings
   - **Ctrl+Shift+S**: Save options, hotkeys and UI colors
   - **Ctrl+Shift+L**: Load options, hotkeys and UI colors
+  - **Ctrl+Shift+D**: Detach active tab in tabbed interface
   - **Enter**: Run active tool
   - **Escape**: Return focus to game from an input
 
+### Scripts
+Lua scripting is buggy and unfinished and the **API will change**, so don't go around making and releasing huge things. They will break. Also there's no documentation, but a few examples. Everything you really need is in `script.cpp` and `rpc.hpp` though. Scripts are loaded from `Spelunky 2/Overlunky/Scripts` by default, but you can change this in the ini.
+
 ## Troubleshooting
   - If your game crashes when launching Overlunky or it just closes and you don't ever see the overlay in game:
     + Make sure you are running the latest version of each. We don't support old game versions and sometimes not the too recent ones either. The latest somewhat tested version can be found at the top if this document.

src/injected/ui.cpp

@@ -2437,6 +2437,11 @@ void render_script_files()
 
 void render_scripts()
 {
+    ImGui::PushTextWrapPos(0.0f);
+    ImGui::TextColored(
+        ImVec4(1.0f, 0.3f, 0.3f, 1.0f),
+        "Note: The Lua API is unstable, not ready and it WILL change, probably a lot. You can play around with it, but don't be surprised if none of your scripts work next week.");
+    ImGui::PopTextWrapPos();
     ImGui::PushItemWidth(-1);
     for (int i = 0; i < g_scripts.size();)
     {