make ftp have ip configured in the file and draft release in workflow (#4)

Author: Pistonight

.github/workflows/main.yml

@@ -38,3 +38,16 @@ jobs:
       run: | 
         just lintc
         if [[ $? -ne 0 ]]; then echo "Run just format to fix"; fi
+    - name: Release | Draft Release Notes
+      if: github.event_name != 'pull_request' && startsWith(github.ref, 'refs/tags/v')
+      run: |
+        just draft-release > RELEASE_NOTES.txt
+        cp standalont_ftp.py ftp.py
+    - name: Release | Create Draft Release
+      if: github.event_name != 'pull_request' && startsWith(github.ref, 'refs/tags/v')
+      uses: softprops/action-gh-release@v1
+      with:
+        draft: true
+        body_path: RELEASE_NOTES.txt
+        files: |
+          ftp.py

Justfile

@@ -92,11 +92,11 @@ ftp COMMAND="install":
 
 # Run standalone ftp util wrapper for sending restore state.
 send-restore:
-    @if [[ -z ${SWITCH_CONSOLE_IP:+x} ]] ; then python3 tools/ftp.py install; else python3 standalone_ftp.py $SWITCH_CONSOLE_IP runtime/restore.txt set ; fi
+    @if [[ -z ${SWITCH_CONSOLE_IP:+x} ]] ; then python3 tools/ftp.py install; else python3 standalone_ftp.py runtime/restore.txt set -ip $SWITCH_CONSOLE_IP ; fi
 
 # Run standalone ftp util wrapper for getting latest state.
 get-latest:
-    @if [[ -z ${SWITCH_CONSOLE_IP:+x} ]] ; then python3 tools/ftp.py install; else python3 standalone_ftp.py $SWITCH_CONSOLE_IP runtime/latest.txt get ; fi
+    @if [[ -z ${SWITCH_CONSOLE_IP:+x} ]] ; then python3 tools/ftp.py install; else python3 standalone_ftp.py runtime/latest.txt get -ip $SWITCH_CONSOLE_IP ; fi
 
 # Search for symbol in dumpped (debug) build
 find-symbol SYMBOL:

README.md

@@ -109,7 +109,9 @@ You need to lower the setting level to restore!
 ```
 
 ### Save State Transfer Script
-A python script `ftp.py` is also included for transfering save state files over FTP (with the `ftpd` homebrew app). Run `python3 ftp.py` to see how to use
+A python script `ftp.py` is also included for transfering save state files over FTP (with the `ftpd` homebrew app). Run `python3 ftp.py` to see how to use. 
+
+(This has nothing to do in game, just makes managing the save state files generated by the mod easier)
 
 ## Developer
 **This section is intented for developers**

standalone_ftp.py

@@ -3,17 +3,21 @@
 from os.path import isfile
 import sys
 
+# Change this to whatever your IP is shown in ftpd, can also use -ip option
+YOUR_IP = "192.168.0.123"
+
 def print_usage():
     """Print usage"""
-    print(f"Usage: {sys.argv[0]} ip file <get|set>")
-    print("ip        = your console's ip, like 192.168.0.123")
+    print(f"Usage: {sys.argv[0]} file <get|set>")
     print("file      = file name of the input for set, or output for get")
     print("<get|set> = get: download the latest save state from switch")
     print("            set: send input file to switch for restoring save state")
     print()
-    print(f"Example: {sys.argv[0]} 192.168.0.123 inside_bombs.txt set")
+    print(f"You also need to open {sys.argv[0]} and change YOUR_IP to your console's IP address")
+    print()
+    print(f"Example: {sys.argv[0]} inside_bombs.txt set")
     print("          ^ This will send inside_bombs.txt to your switch for restoring")
-    print(f"Example: {sys.argv[0]} 192.168.0.123 output_state.txt get")
+    print(f"Example: {sys.argv[0]} output_state.txt get")
     print("          ^ This will download the last save state from switch and save it as output_state.txt on your computer")
 def run(console_ip, local_path, command):
     """Main"""
@@ -87,7 +91,11 @@ def add_slash_if_need(path):
     return path if path.startswith("/") else "/"+path
 
 if __name__ == "__main__":
-    if len(sys.argv) < 4:
+    if len(sys.argv) < 3:
         print_usage()
         sys.exit(-1)
-    run(sys.argv[1], sys.argv[2], sys.argv[3])
+    ip = YOUR_IP
+    for i, arg in enumerate(sys.argv):
+        if arg[i] == "-ip":
+            ip = arg[i+1]
+    run(ip, sys.argv[1], sys.argv[2])