Merge branch 'main' into modesty-mesh

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,21 @@
+---
+blank_issues_enabled: false
+contact_links:
+  - name: I want to submit a mod
+    url: https://github.com/VoronDesign/VoronUsers/pulls/
+    about: Mod submissions are handled via pull requests. Please open a pull request to have your mod added
+  - name: I want to learn about the submission rules for this repository
+    url: https://github.com/VoronDesign/VoronUsers/wiki/Mod-Submission-Rules
+    about: The wiki of this repository contains all the information you need to know about submitting mods
+  - name: I'm looking for general discussions about VoronUser mods
+    url: https://discord.com/channels/460117602945990666/635687829254701107
+    about: "The #voronuser_mods channel on the VoronDesign discord is the place to go"
+  - name: I have an issue with a VoronDesign printer
+    url: https://discord.gg/voron
+    about: Please use the help channels for the individual printers on the VoronDesign discord
+  - name: I want to request a mod or a feature for a particular mod
+    url: https://discord.com/channels/460117602945990666/635687829254701107
+    about: "You can ask other mod creators in the #voronuser_mods channel on the VoronDesign discord for support"
+  - name: I have one of the above issues and don't want to use Discord
+    url: https://forum.vorondesign.com
+    about: The VoronDesign forum provides a platform for discussions and support outside of discord

.github/ISSUE_TEMPLATE/mod-issue.yaml

@@ -0,0 +1,31 @@
+name: I want to report an issue with a mod
+description: You have found an issue with one of the mods in this repository? Please use this mod issue report to let us know.
+title: "[MOD ISSUE] <title>"
+labels: Mod Issue
+body:
+- type: textarea
+  attributes:
+    label: Which mod does this issue apply to?
+    placeholder: FHeilmann/flux_capacitor
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Relevant VoronDesign printer
+    description: Which printer did you experience this issue on
+    placeholder: On my V2.4
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe the bug
+    description: A clear and concise description of what the bug is.
+    placeholder: |
+      When starting a print ...
+      When trying to build ...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Addition information
+    description: Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,81 +5,22 @@ highly appreciated!
 
 <!--
 Describe the submission further using the template provided below. The more
-details the better! Please don't forget to thoroughly read the mod requirements and rules below
+details the better! Please don't forget to thoroughly read the mod requirements and rules
 and make sure your mod submission adheres to these rules.
 Doing so speeds up the review process and will increase your chances at acceptance.
 -->
 
-### Which mods/configurations/profiles are added by this PR?
+### Which mods are added by this PR?
 
 ### How was it tested?
 
 ### Any background context you want to provide?
 
 ### Screenshots (if appropriate)
 
-### ⚠️⚠️**PLEASE CAREFULLY READ AND APPLY THE RULES BELOW**⚠️⚠️
+### ⚠️⚠️**PLEASE READ AND COMPLETE THE CHECKLIST BELOW**⚠️⚠️
 
-  * [ ] The mod, firmware configuration or slicer profile is in the correct category
-    folder. Printable mods go to `printer_mods/`, firmware configurations
-    go to `firmware_configurations/`, slicer profiles go to `slicer_profiles/`.
-    Create a subfolder with your name, and place the mods in a subfolder with
-    a descriptive name within that folder, e.g.: `/printer_mods/FHeilmann/flux_capacitor`.
-  * [ ] Folder and file naming:
-    * Folders and filenames MUST NOT contain spaces. Only letters `a-zA-Z`, numbers `0-9`, underscores `_`, hyphens `-` and periods `.`
-    * You may use the following filenames to indicate the color and quantity of your prints:
-      * Primary color: `part_xyz.stl`
-      * Accent color: `[a]_part_xyz.stl`
-      * Opaque color (Blocks light): `[o]_part_xyz.stl`
-      * Clear/transparent color (Allows light): `[c]_part_xyz.stl`
-      * Quantity, if more than one is needed: `part_xyz_x4.stl`
-  * [ ] Each mod folder must contain a `.metadata.yml` file with information about the mod.
-    Refer to the following template for the required and optional contents:
-    ```yaml
-    ---
-    title: Mod Title # required
-    description: "This mod does awesome things with awesome printers!" # required
-    mod_version: 1 # required
-    printer_compatibility:  # required, one or more of the options listed below
-      - V0
-      - V0.1
-      - V0.2
-      - V0.2r1
-      - V1
-      - V1.6
-      - V1.8
-      - V1.8r1
-      - V2
-      - V2.1
-      - V2.2
-      - V2.4
-      - V2.4r1
-      - V2.4r2
-      - VSW
-      - VT
-      - VTr1
-      - VL
-    cad: # required: At least 1 CAD file for your mod, path relative to your mod folder
-      - CAD/my_step_file_1.step
-      - CAD/my_f360_file_1.f3d
-    images: # optional, image files provided with your mod, path relative to your mod folder
-      - images/mods_site_card_image.png
-      - images/side_view.png
-      - images/install_guide.png
-    discord_username: discord_person # optional, your discord username
-    ```
-  * [ ] For each mod, add a small `README.md` file to its folder with a short description
-    of what the mod accomplishes. This readme can be used to add pictures, give assembly
-    instructions or specify a bill of materials if the mod requires additional hardware.
-  * [ ] The mod/configuration/profile has been **TESTED** by the person submitting the mod
-    and/or other Voron users. Make sure to add information about how the mod was tested below.
-  * [ ] The mod is **NOT** merely a slight modification of an official Voron part, configuration
-    or profile (i.e. an official Voron part with a few mm added or removed or a slicer profile
-    which only modifies a few values). *(When in doubt, contact one of the admins in the
-    Voron discord before submitting the PR)*
-  * [ ] Submitted STLs are **printable without support and oriented properly**. If supports can't be avoided,
-    the model must include break-away supports.
-  * [ ] Submitted STL files are **not corrupt**. *(This can be tested by opening the STL in PrusaSlicer
-    and checking if mesh errors are reported.)*
-  * [ ] Submissions **must** include a CAD file in the form of a `.STEP`, `.F3D` or `.SCAD` file
-  * [ ] Submitted firmware configs or slicer profiles **contain no sensitive data** (e.g. API keys).
+  * [ ] I have read the rules available [here](https://github.com/VoronDesign/VoronUsers/wiki/Mod-Submission-Rules) and
+        my mod adheres to these rules.
+  * [ ] This mod was created by myself and I agree to publish it under the repository
+        [license](https://github.com/VoronDesign/VoronUsers/blob/master/LICENSE.md)

.github/workflows/pull_request_ci.yml

@@ -2,12 +2,12 @@ name: pull_request_ci
 run-name: "#${{github.event.number}} - ${{github.event.pull_request.title}}"
 on:
     pull_request:
-        types: [opened, reopened, synchronize]
+        types: [opened, reopened, synchronize, labeled]
 concurrency:
     group: ${{ github.ref }}
     cancel-in-progress: true
 permissions:
     pull-requests: write
 jobs:
     voronusers_ci_pr_check:
-        uses: VoronDesign/.github/.github/workflows/voronusers-ci-pr-check.yml@main
+        uses: VoronDesign/.github/.github/workflows/voronusers-ci-pr-check.yml@main

.github/workflows/pull_request_post_process_ci.yml

@@ -1,3 +1,4 @@
+run-name: "Post-processing #${{github.event.number}}"
 on:
     workflow_run:
         workflows: ["pull_request_ci"]
@@ -10,4 +11,4 @@ jobs:
         uses: VoronDesign/.github/.github/workflows/voronusers-ci-pr-postprocess.yml@main
         secrets:
             IMAGEKIT_PRIVATE_KEY: ${{ secrets.IMAGEKIT_PRIVATE_KEY}}
-            IMAGEKIT_PUBLIC_KEY: ${{ secrets.IMAGEKIT_PUBLIC_KEY }}
+            IMAGEKIT_PUBLIC_KEY: ${{ secrets.IMAGEKIT_PUBLIC_KEY }}

.gitignore

@@ -1,4 +1,116 @@
-.DS_Store
-.DS_store
+# Created by https://www.toptal.com/developers/gitignore/api/macos,visualstudiocode,windows,linux,git,tortoisegit
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,visualstudiocode,windows,linux,git,tortoisegit
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_[Ss]tore
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### TortoiseGit ###
+# Project-level settings
+/.tgitconfig
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
 .history
-.vscode
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,visualstudiocode,windows,linux,git,tortoisegit

README.md

@@ -1,10 +1,13 @@
 ![TravisCI passing](https://travis-ci.org/VoronDesign/VoronUsers.svg?branch=master)
 # VoronUsers repository
 
-Welcome to the VoronUsers github repository. This is a place to share your awesome mods for the Voron0, Voron1 and Voron2 3D printers and find useful resources from other Voron community members.
+Welcome to the VoronUsers github repository. This is a place to share your awesome mods for the VoronDesign 3D printers and find useful resources from other Voron community members.
 
-Check the [`printer_mods`](./printer_mods) [`firmware_configurations`](./firmware_configurations) and [`slicer_configurations`](./slicer_configurations) folders for mods that apply to 
-the current generation of printers. All mods that apply to older (=legacy printers) can be found in the [legacy printers](./legacy_printers) folder.
+Check the [`printer_mods`](./printer_mods) folder for mods that apply to the current generation of printers. 
+
+All mods that apply to older (=legacy printers) can be found in the [legacy printers](./legacy_printers) folder.
+
+Orphaned mods where the authors have abandoned development can be found in the [orphaned mods](./orphaned_mods/) folder. If you want to start maintaining one of these mods, feel free to reach out via a github issue.
 
 ![Image of Voron 2.2](http://vorondesign.com/images/voron2.4.jpg)