Merge branch 'main' of https://github.com/ducng99/SimHub-SF1000-UDP

.github/ISSUE_TEMPLATE/suggestions.md

@@ -0,0 +1,11 @@
+---
+name: Ideas and Suggestions
+about: Use this template if you have an idea or suggestion for the plugin
+title: ''
+labels: question, enhancement
+assignees: ''
+
+---
+
+**New suggestion**
+

.github/workflows/build.yml

@@ -8,6 +8,9 @@ on:
 permissions:
   contents: write
 
+env:
+  ReleaseFileName: SimHubSF1000UDP_${{ github.ref_name }}.zip
+
 jobs:
   generate-changelog:
     name: Generate changelog
@@ -30,12 +33,6 @@ jobs:
   build:
     runs-on: windows-latest
 
-    needs:
-    - generate-changelog
-
-    env:
-      ReleaseFileName: SimHubSF1000UDP_${{ github.ref_name }}.zip
-
     steps:
     - name: Checkout
       uses: actions/checkout@v4
@@ -48,7 +45,26 @@ jobs:
 
     - name: Zip output DLL file
       run: Compress-Archive -Path ./SimHubSF1000UDP/bin/Release/SimHubSF1000UDP.dll -DestinationPath ./${{ env.ReleaseFileName }}
-
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: build-file
+        path: ${{ env.ReleaseFileName }}
+
+  create-release:
+    runs-on: ubuntu-latest
+
+    needs:
+    - generate-changelog
+    - build
+
+    steps:
+    - name: Download artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: build-file
+
     - name: Create release
       uses: softprops/action-gh-release@v2
       with:

README.md

@@ -57,6 +57,10 @@ You should see these two files (you can ignore the steps for F1 games):
 - Start your game and the wheel should show the dash.
 
 ## Building
+
+> [!NOTE]
+> This section is for developers only, if you just want to use the plugin, follow [Installation](https://github.com/ducng99/SimHub-SF1000-UDP#installation) and [Configuration](https://github.com/ducng99/SimHub-SF1000-UDP#configuration)
+
 ### Requirements
 
 - Visual Studio 2022 (recommended), other versions might work but not tested.
@@ -66,11 +70,13 @@ You should see these two files (you can ignore the steps for F1 games):
 
 1. Clone this repo
 2. Open Visual Studio
-3. SimHub libraries are included in this repo, so building should be straightforward as hitting build button. A .dll file will be generated in `bin/Debug` or `bin/Release` folder, depending on your configuration selection.
-4. You know what to do next.
+3. SimHub libraries are included in this repo, so building should be straightforward as hitting build button.
+4. A .dll file will be generated in `bin/Debug` or `bin/Release` folder, depending on your configuration selection.
+5. Copy the built .dll file to SimHub directory.
+6. Do whatever you want with the plugin
 
 ## Issues & suggestions
-If you have any issues or suggestions, please create an issue [here](https://github.com/ducng99/SimHub-SF1000-UDP/issues/new/choose).
+If you have any issues/questions or suggestions, please create an issue [here](https://github.com/ducng99/SimHub-SF1000-UDP/issues/new/choose).
 
 ## Disclaimer
 This application/project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Guillemot Corporation S.A, or any of its subsidiaries or its affiliate. Thrustmaster is a registered trademarks of Guillemot Corporation S.A.