├── wait_for_bed_edge ├── crossing_border_example.png ├── not_crossing_border_example.png ├── config │ └── wait_for_bed_edge.cfg └── README.md ├── KAM-settings.cfg ├── README.md ├── KAM-setup.sh ├── sequential_purge ├── README.md └── config │ └── sequential_purge.cfg └── LICENSE /wait_for_bed_edge/crossing_border_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Department-of-Design/Kevins-Awesome-Macros/HEAD/wait_for_bed_edge/crossing_border_example.png -------------------------------------------------------------------------------- /wait_for_bed_edge/not_crossing_border_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Department-of-Design/Kevins-Awesome-Macros/HEAD/wait_for_bed_edge/not_crossing_border_example.png -------------------------------------------------------------------------------- /wait_for_bed_edge/config/wait_for_bed_edge.cfg: -------------------------------------------------------------------------------- 1 | [gcode_macro WAIT_FOR_BED_EDGE_TEMP] 2 | gcode: 3 | {% set bound_percentage = params.BOUND | int | default(50) %} 4 | {% set MINIMUM_TEMP_THRESHOLD = params.MINIMUM_TEMP_THRESHOLD | default(0.8) | float %} 5 | {% set BED_TEMP = params.BED | default(60) | int %} 6 | {% set MINIMUM_TEMP_THRESHOLD = (MINIMUM_TEMP_THRESHOLD * BED_TEMP) | int %} 7 | 8 | {% set all_points = printer.exclude_object.objects | map(attribute='polygon') | sum(start=[]) %} # Get all object points 9 | {% set purge_x_min = (all_points | map(attribute=0) | min | default(0)) %} # Object x min 10 | {% set purge_x_max = (all_points | map(attribute=0) | max | default(0)) %} # Object x max 11 | {% set purge_y_min = (all_points | map(attribute=1) | min | default(0)) %} # Object y min 12 | {% set purge_y_max = (all_points | map(attribute=1) | max | default(0)) %} # Object y max 13 | 14 | {% set x_min = (printer.toolhead.axis_maximum.x / 2) - (printer.toolhead.axis_maximum.x / 2 * (bound_percentage / 100)) %} 15 | {% set x_max = (printer.toolhead.axis_maximum.x / 2) + (printer.toolhead.axis_maximum.x / 2 * (bound_percentage / 100)) %} 16 | {% set y_min = (printer.toolhead.axis_maximum.y / 2) - (printer.toolhead.axis_maximum.y / 2 * (bound_percentage / 100)) %} 17 | {% set y_max = (printer.toolhead.axis_maximum.y / 2) + (printer.toolhead.axis_maximum.y / 2 * (bound_percentage / 100)) %} 18 | 19 | {% if purge_x_min < x_min or purge_x_max > x_max or purge_y_min < y_min or purge_y_max > y_max %} 20 | { action_respond_info("⏳ Print bigger than center boundary of the bed, waiting for edge to reach %d°C." % MINIMUM_TEMP_THRESHOLD) } 21 | M140 S{BED_TEMP} 22 | TEMPERATURE_WAIT SENSOR="temperature_sensor bed_edge" MINIMUM={MINIMUM_TEMP_THRESHOLD} 23 | {% else %} 24 | { action_respond_info("♨️ Print smaller than center boundary of the bed, not waiting. Heating to %d°C." % BED_TEMP) } 25 | M190 S{BED_TEMP} 26 | {% endif %} -------------------------------------------------------------------------------- /KAM-settings.cfg: -------------------------------------------------------------------------------- 1 | [include ./KAM/*.cfg] 2 | 3 | [gcode_macro _KAM_SETTINGS] 4 | description: Settings for KAM macros 5 | 6 | #################### 7 | # Sequential Purging 8 | #################### 9 | 10 | # Continuous: where the purge line gets drawn every print in an order and when the purge_sections_amount is full it will start back at the first purge section. 11 | # Limited: draws a purge line every print and you dont have to worry about accidentally leaving the purgelines on the bed because the print will not start once the purge_sections_amount is full. 12 | # !! for the Limited mode you need CHECK_PURGES somewhere before the SEQUENTIAL_PURGE command in your PRINT_START macro. Preferably before your printer heats up so you don't waste the heating time. 13 | # !! when the purge section is full you can use RESET_PURGES to clear the system and start at the first purge section on your next print. 14 | 15 | # set this to True if you want continuous, and to false if you want limited 16 | # default is True 17 | variable_continuous: True 18 | 19 | # the amount of purge sections in the line 20 | # default is 5 21 | variable_purge_sections_amount: 5 22 | 23 | # this is only needed on limited mode. This will stop the print if the purge section is full, if this is set to false it will echo a message to console instead of aborting the print. 24 | # this will also automatically reset the purges and continue printing. Use at your own risk. 25 | # default is False 26 | variable_stop_print_on_warning: False 27 | 28 | # time user has to remove purges 29 | # default is 30 30 | variable_warning_time: 30 31 | 32 | # the distance the purgeline is away from the bed in X on both sides. 33 | # this will only (haven't tested this on any other printers) work on configurations where the 0,0 point is on the left bottom corner of the bed. 34 | # default is 10 35 | variable_x_purge_offset: 10 36 | 37 | # the distance the purgeline is away from the bed in Y. 38 | # this will only (haven't tested this on any other printers) work on configurations where the 0,0 point is on the left bottom corner of the bed. 39 | # default is 3 40 | variable_y_purge_offset: 3 41 | 42 | # the distance from the bed for the purge line 43 | # default is 0.4 44 | variable_purge_height: 0.4 45 | 46 | # flow rate for the purgeline, this will both be used to set the speed of the purge line and the amount of filament extruded 47 | # so set this setting with caution. Many set this at their hotend flow limit or a little under that. 48 | # default is 12 49 | variable_flow_rate: 12 50 | 51 | # purge multiplier is for when you want more purge than stock offers. This will not increase the flow, it will slow down the purge and purge more material. 52 | # purge line works from 100% to 500%. e.g. 150% more purge = 50% more 53 | # default is 100 54 | variable_multiplier: 100 55 | 56 | # the distance between the tip of the filament and the nozzle before purging should be similar to the final retract amount specified in PRINT_END. 57 | # default is 10 58 | variable_tip_distance: 10 59 | 60 | # specifies the overlap of the purge line with the next purge line in percentage 61 | # default is 50, max is 100 62 | variable_purge_line_end_overlap: 50 63 | 64 | # temperature where filament can be extruder, will error below this temp 65 | # default 180c 66 | variable_min_extrude_temp: 180 67 | 68 | # add more variables here. 69 | 70 | # dont edit anything below. 71 | gcode: 72 | RESPOND MSG="This macro doesnt do anything, it's just to set the settings." 73 | -------------------------------------------------------------------------------- /wait_for_bed_edge/README.md: -------------------------------------------------------------------------------- 1 | # Wait for bed edge to reach temp 2 | 3 | This simple macro is for printers that have a temperature sensor at the edge of the bed to check whether the whole bed is heated. For example aluminum beds heat faster at the center and take some time to heat at the edges. 4 | 5 | This macro checks the size of the part your printing and if it crosses a certain border around the center of the bed it will wait for the edges to heat so you dont unnecessarily heat the whole bed for a small print. 6 | 7 | An example for a `BOUND` of `50` it will regularly heat the bed to the target temp and start the print. 8 | ![not_crossing_border_example](not_crossing_border_example.png) 9 | 10 | In the following case the parts cross the border and the printer will heat to the target temp and wait for the edge of the bed to reach the `MINIMUM_TEMP_THRESHOLD` which was set to `0.8` so if your bed is set to `110°C` that would be `88°C` 11 | ![crossing_border_example](crossing_border_example.png) 12 | 13 | ## Installation 14 | 15 | 1. **Naming the Temperature Sensor:** 16 | - Make sure your sensor is named exactly `bed_edge` in the configuration file. 17 | - Example: 18 | ```plaintext 19 | [temperature_sensor bed_edge] 20 | sensor_type: NTC 100K MGB18-104F39050L32 21 | sensor_pin: PC3 22 | ``` 23 | 24 | 2. **Configuring `exclude_object`:** 25 | - This is required for the macro to work and used in Klipper for excluding parts of prints if needed. There's more info [here](https://www.klipper3d.org/Exclude_Object.html). 26 | 27 | 3. **Installing the Macro:** 28 | - Run the [Quick Install guide](https://github.com/Department-of-Design/Kevins-Awesome-Macros?tab=readme-ov-file#quick-install) and, when prompted, select option `2` to install the "wait for bed edge temp" macro. 29 | 30 | 4. **Restart the Firmware:** 31 | - After installing, restart by typing `FIRMWARE_RESTART` in the terminal/console. 32 | 33 | 5. **Add Macro to Your Start Sequence:** 34 | - Edit the `PRINT_START` macro in your configuration (`printer.cfg`). 35 | - Add the line: 36 | ```plaintext 37 | WAIT_FOR_BED_EDGE_TEMP BED={BED} MINIMUM_TEMP_THRESHOLD=0.8 BOUND=50 38 | ``` 39 | - This macro replaces your current bed heating command. 40 | Here's an example to what it might look like. Don't directly copy this entire print start macro. 41 | 42 | ```yaml 43 | [gcode_macro PRINT_START] 44 | gcode: 45 | {% set BED_TEMP = params.BED_TEMP|default(60)|float %} 46 | {% set EXTRUDER_TEMP = params.EXTRUDER_TEMP|default(190)|float %} 47 | WAIT_FOR_BED_EDGE_TEMP BED={BED_TEMP} MINIMUM_TEMP_THRESHOLD=0.8 BOUND=50 48 | # Use absolute coordinates 49 | G90 50 | # Home the printer 51 | G28 52 | ... 53 | 54 | 6. **Tweak Threshold Values if Needed:** 55 | - `MINIMUM_TEMP_THRESHOLD` and `BOUND` have default values but can be adjusted if necessary. 56 | 57 | ## Uninstalling 58 | That's unfortunate! Is the macro not working for you? If you're having trouble, feel free to send me a direct message on Discord (@danni_design) or ping me in KevinAkaSam's Sandbox server. 59 | 60 | If you still wish to uninstall the macro, you can do so by opening the setup wizard with the following command in your printer's command line: 61 | ```bash 62 | cd ~ && ./KAM-setup.sh 63 | ``` 64 | Navigate to the **Uninstall** menu (option 2) and follow the steps provided. 65 | 66 | If you no longer have the setup wizard, you can manually uninstall KAM by entering these commands in the command line: 67 | 68 | ```bash 69 | cd 70 | rm -rf Kevins-Awesome-Macros 71 | rm printer_data/config/KAM-settings.cfg 72 | rm printer_data/config/KAM/* 73 | rmdir printer_data/config/KAM 74 | ``` 75 | 76 | Additionally, remove the following from your `printer.cfg` file: 77 | ```yaml 78 | [include KAM-settings.cfg] 79 | ``` 80 | 81 | ## Troubleshooting 82 | 83 |
84 | 85 | 86 | I'm getting an error about an unknown sensor! 87 | 88 | 89 |

90 | This is because your temperature sensor does not have the right name assigned. Please call it `bed_edge`. Refer to the installation for more info https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/wait_for_bed_edge#installation

91 |
92 | 93 | ## Credits 94 | Huge thanks to [Kyleisah](https://github.com/kyleisah) for the amazing work on KAMP and for the inspiration behind this macro. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kevin's Awesome Macros 2 | 3 | ![image](https://repository-images.githubusercontent.com/777636883/d4b1e7d1-9515-496b-a353-a37fbd9885d5) 4 | 5 | A collection of awesome macros for Klipper printers 6 | 7 | > [!IMPORTANT] 8 | > Please make sure to ${ \textsf{\color{red}read the documentation} }$ before installing these macros. The docs contain valuable information about installation, configuration, and optional features. 9 | 10 | # How does one use the macro's? 11 | 12 | There's a file called KAM-settings.cfg. This file already includes all the settings for Sequential Purging. Sequential Purging is currently the only macro that we've made. But soon when more macro's come available you'll be able to add more variables in the file for setting up the other macro's. 13 | 14 | # All available macro's 15 | ## Sequential Purging Macro 16 | 17 | ![Sequential Purge4](https://github.com/user-attachments/assets/939f6509-9136-4ea3-83d8-b0293a6a49f5) 18 | 19 | [![Documentation](https://github.com/Department-of-Design/Kevins-Awesome-Macros/assets/16231288/da62d421-d8e3-43b6-b535-5429b333bdab)](https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/sequential_purge) 20 | 21 | This incredible macro ensures you shall worry no more! Avoid problems caused by purge lines from previous prints that haven't been removed from the bed. 22 | 23 | While the macro itself doesn't (and can't) remove the purge line from your bed automatically, it does provide a mechanism by which the purge line is printed in avoidance of previous purges, remembering and avoiding the location of the purge lines in previous print jobs. 24 | 25 | ## Wait for bed edge temp 26 | 27 | [![Documentation](https://github.com/Department-of-Design/Kevins-Awesome-Macros/assets/16231288/da62d421-d8e3-43b6-b535-5429b333bdab)](https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/wait_for_bed_edge) 28 | 29 | This simple macro is for printers that have a temperature sensor at the edge of the bed to check whether the whole bed is heated. For example aluminum beds heat faster at the center and take some time to heat at the edges. 30 | 31 | This macro checks the size of the part your printing and if it crosses a certain border around the center of the bed it will wait for the edges to heat so you dont unnecessarily heat the whole bed for a small print. 32 | 33 | # Quick install 34 | 35 | To install the macro(s) you want, follow the steps below. This guide assumes you’re using a compatible terminal program like [Putty](https://www.putty.org/) to access your printer. 36 | 37 | ### Installation Steps: 38 | 39 | 1. **Update your system and install Git:** 40 | Open your terminal and run the following commands: 41 | 42 | ```bash 43 | sudo apt-get update && sudo apt-get install git -y 44 | ``` 45 | 46 | 2. **Download the Macro Setup Script:** 47 | Navigate to your home directory and clone the installation repository: 48 | 49 | ```bash 50 | cd ~ && git clone https://github.com/Department-of-Design/Kevins-Awesome-Macros.git 51 | ``` 52 | 53 | 3. **Run the Setup Script:** 54 | Execute the setup script to begin installation: 55 | 56 | ```bash 57 | ./Kevins-Awesome-Macros/KAM-setup.sh 58 | ``` 59 | 60 | 4. **Follow the On-Screen Menu:** 61 | The script will present you with an installation menu. You can navigate this menu by entering the corresponding number for each option and pressing `Enter`. 62 | 63 | Example: 64 | ```bash 65 | ======================== 66 | Choose an option: 1 67 | ``` 68 | 69 | 5. **Monitor for Prompts:** 70 | During installation, you may be prompted for manual input. Make sure to follow any on-screen instructions and keep an eye on the terminal for updates. 71 | 72 | 6. **Edit Your `moonraker.conf` File: Add the following configuration to your `moonraker.conf` file:** 73 | ```yaml 74 | [update_manager Kevins-Awesome-Macros] 75 | type: git_repo 76 | channel: dev 77 | path: ~/Kevins-Awesome-Macros 78 | origin: https://github.com/Department-of-Design/Kevins-Awesome-Macros.git 79 | managed_services: klipper 80 | primary_branch: main 81 | ``` 82 | 83 | 7. **Edit Your `printer.cfg` File: Add the following line to your `printer.cfg` file:** 84 | ```yaml 85 | [include KAM-settings.cfg] 86 | ``` 87 | 88 | 8. **Continue to documentation** 89 | Continue to the documentation of the macro you're trying to install. This will also be in the output of the installation. 90 | 91 | # Community 92 | 93 | Got stuck with a macro? Unsure of what to do with an error? 94 | Or just curious where all the other nerds hang out? 95 | 96 | Discord is the place-to-be! Home to the Department of Design and fans of KevinAkaSam's inventions alike. 97 | 98 | [![Discord Invite](https://discordapp.com/api/guilds/964441223169449984/widget.png?style=banner3)](https://discord.gg/xqpKrxt9FC) 99 | -------------------------------------------------------------------------------- /KAM-setup.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Text Colors 4 | BLACK='\033[0;30m' 5 | RED='\033[0;31m' 6 | GREEN='\033[0;32m' 7 | YELLOW='\033[0;33m' 8 | BLUE='\033[0;34m' 9 | PURPLE='\033[0;35m' 10 | CYAN='\033[0;36m' 11 | WHITE='\033[0;37m' 12 | 13 | # Bold Text Colors 14 | BOLD_BLACK='\033[1;30m' 15 | BOLD_RED='\033[1;31m' 16 | BOLD_GREEN='\033[1;32m' 17 | BOLD_YELLOW='\033[1;33m' 18 | BOLD_BLUE='\033[1;34m' 19 | BOLD_PURPLE='\033[1;35m' 20 | BOLD_CYAN='\033[1;36m' 21 | BOLD_WHITE='\033[1;37m' 22 | 23 | # Background Colors 24 | BG_BLACK='\033[40m' 25 | BG_RED='\033[41m' 26 | BG_GREEN='\033[42m' 27 | BG_YELLOW='\033[43m' 28 | BG_BLUE='\033[44m' 29 | BG_PURPLE='\033[45m' 30 | BG_CYAN='\033[46m' 31 | BG_WHITE='\033[47m' 32 | BG_GREY='\033[0;100m' 33 | 34 | GREY='\033[0;90m' 35 | BOLD_GREY='\033[1;90m' 36 | # Reset color 37 | RESET='\033[0m' 38 | 39 | set -e 40 | umask 022 41 | clear 42 | # Function to display the menu 43 | echo -e "${BOLD_WHITE}██╗ ██╗███████╗██╗ ██╗██╗███╗ ██╗███████╗ "; 44 | echo "██║ ██╔╝██╔════╝██║ ██║██║████╗ ██║██╔════╝ "; 45 | echo "█████╔╝ █████╗ ██║ ██║██║██╔██╗ ██║███████╗ "; 46 | echo "██╔═██╗ ██╔══╝ ╚██╗ ██╔╝██║██║╚██╗██║╚════██║ "; 47 | echo "██║ ██╗███████╗ ╚████╔╝ ██║██║ ╚████║███████║ "; 48 | echo "╚═╝ ╚═╝╚══════╝ ╚═══╝ ╚═╝╚═╝ ╚═══╝╚══════╝ "; 49 | echo " "; 50 | echo " █████╗ ██╗ ██╗███████╗███████╗ ██████╗ ███╗ ███╗███████╗"; 51 | echo "██╔══██╗██║ ██║██╔════╝██╔════╝██╔═══██╗████╗ ████║██╔════╝"; 52 | echo "███████║██║ █╗ ██║█████╗ ███████╗██║ ██║██╔████╔██║█████╗ "; 53 | echo "██╔══██║██║███╗██║██╔══╝ ╚════██║██║ ██║██║╚██╔╝██║██╔══╝ "; 54 | echo "██║ ██║╚███╔███╔╝███████╗███████║╚██████╔╝██║ ╚═╝ ██║███████╗"; 55 | echo "╚═╝ ╚═╝ ╚══╝╚══╝ ╚══════╝╚══════╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝"; 56 | echo " "; 57 | echo "███╗ ███╗ █████╗ ██████╗██████╗ ██████╗ ███████╗ "; 58 | echo "████╗ ████║██╔══██╗██╔════╝██╔══██╗██╔═══██╗██╔════╝ "; 59 | echo "██╔████╔██║███████║██║ ██████╔╝██║ ██║███████╗ "; 60 | echo "██║╚██╔╝██║██╔══██║██║ ██╔══██╗██║ ██║╚════██║ "; 61 | echo "██║ ╚═╝ ██║██║ ██║╚██████╗██║ ██║╚██████╔╝███████║ "; 62 | echo -e "╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝${RESET}"; 63 | 64 | show_menu() { 65 | echo "========================" 66 | echo " Install Menu " 67 | echo "========================" 68 | echo -e "${BOLD_WHITE}1) Install Sequential Purging" 69 | empty_line 70 | echo -e "${BOLD_WHITE}2) Install wait for bed edge temp" 71 | empty_line 72 | echo -e "${BOLD_RED}9) Uninstall${RESET}" 73 | empty_line 74 | echo -e "${BOLD_WHITE}Q) Exit${RESET}" 75 | echo "========================" 76 | } 77 | 78 | # Function to handle the selection 79 | run_choice() { 80 | case $1 in 81 | 1) 82 | install_sequential_purging 83 | ;; 84 | 2) 85 | install_wait_for_bed_edge_temp 86 | ;; 87 | 9) 88 | empty_line 89 | if [ ! -d "printer_data/config/KAM" ]; then 90 | echo -e "${WHITE}Kevin's Awesome Macro's is already uninstalled.${RESET}" 91 | else 92 | read -p $'\e[1;31mDo you wish to delete the KAM-settings.cfg file? You will lose all your settings. This can\'t be undone! [y/n]\e[0m: ' -r 93 | empty_line 94 | if [[ $REPLY =~ ^[Yy]$ ]]; then 95 | read -p $'\e[1;31mAre you sure? You will lose all your settings! [y/n]\e[0m: ' -r 96 | empty_line 97 | if [[ $REPLY =~ ^[Yy]$ ]]; then 98 | echo -e "\033[1;31mDeleting KAM settings file...${RESET}" 99 | rm printer_data/config/KAM-settings.cfg 100 | uninstall_KAM 101 | else 102 | echo -e "${GREEN}Fine! Skipping settings deletion.${RESET}" 103 | uninstall_KAM 104 | fi 105 | else 106 | echo -e "${GREEN}Fine! Only deleting the macro files.${RESET}" 107 | uninstall_KAM 108 | fi 109 | fi 110 | sleep 1 111 | ;; 112 | Q | q) 113 | empty_line 114 | echo -e "${BOLD_RED}Exiting...${RESET}" 115 | exit 0 116 | ;; 117 | *) 118 | echo "Invalid option, please try again." 119 | sleep 1 120 | ;; 121 | esac 122 | } 123 | 124 | uninstall_KAM() { 125 | cd 126 | echo -e "\033[1;31mDeleting KAM folder contents...${RESET}" 127 | rm printer_data/config/KAM/* 128 | echo -e "\033[1;31mDeleting KAM folder...${RESET}" 129 | rmdir printer_data/config/KAM 130 | empty_line 131 | echo -e "\033[0;32mDone uninstalling!${RESET}" 132 | } 133 | 134 | install_sequential_purging() { 135 | empty_line 136 | echo -e "${BOLD_PINK}Installing Sequential Purging...${RESET}" 137 | empty_line 138 | echo -e "${BOLD_RED}DO NOT TURN OF THE MACHINE!${RESET}" 139 | empty_line 140 | if [ ! -e "printer_data/config/KAM-settings.cfg" ]; then 141 | echo -e "${BOLD_WHITE}Copying over config file...${RESET}" 142 | cp ~/Kevins-Awesome-Macros/KAM-settings.cfg ~/printer_data/config/KAM-settings.cfg 143 | empty_line 144 | else 145 | echo -e "${BOLD_WHITE}Config file already exists. Skipping...${RESET}" 146 | empty_line 147 | fi 148 | if [ ! -d "printer_data/config/KAM" ]; then 149 | echo -e "${BOLD_WHITE}Making KAM folder...${RESET}" 150 | mkdir ~/printer_data/config/KAM/ 151 | empty_line 152 | echo -e "${BOLD_WHITE}Creating symbolic link...${RESET}" 153 | else 154 | echo -e "${BOLD_WHITE}KAM folder already exists. Skipping...${RESET}" 155 | empty_line 156 | fi 157 | ln -s ~/Kevins-Awesome-Macros/sequential_purge/config/sequential_purge.cfg printer_data/config/KAM/sequential_purge.cfg 158 | empty_line 159 | echo -e "${BOLD_GREEN}Installation succesful!${RESET}" 160 | empty_line 161 | echo -e "${BOLD_PURPLE}For documentation go to https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/sequential_purge#installation${RESET}" 162 | empty_line 163 | read -n 1 -s -p $'\e[1;36mPress any key to continue...\e[0m ' key 164 | } 165 | 166 | install_wait_for_bed_edge_temp() { 167 | empty_line 168 | echo -e "${BOLD_PINK}Installing Wait for bed edge temp...${RESET}" 169 | empty_line 170 | echo -e "${BOLD_RED}DO NOT TURN OF THE MACHINE!${RESET}" 171 | empty_line 172 | if [ ! -d "printer_data/config/KAM" ]; then 173 | echo -e "${BOLD_WHITE}Making KAM folder...${RESET}" 174 | mkdir ~/printer_data/config/KAM/ 175 | empty_line 176 | echo -e "${BOLD_WHITE}Creating symbolic link...${RESET}" 177 | else 178 | echo -e "${BOLD_WHITE}KAM folder already exists. Skipping...${RESET}" 179 | empty_line 180 | fi 181 | ln -s ~/Kevins-Awesome-Macros/wait_for_bed_edge/config/wait_for_bed_edge.cfg printer_data/config/KAM/wait_for_bed_edge.cfg 182 | empty_line 183 | echo -e "${BOLD_GREEN}Installation succesful!${RESET}" 184 | empty_line 185 | echo -e "${BOLD_PURPLE}For documentation go to https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/wait_for_bed_edge#installation${RESET}" 186 | empty_line 187 | read -n 1 -s -p $'\e[1;36mPress any key to continue...\e[0m ' key 188 | } 189 | empty_line () { 190 | echo 191 | } 192 | # Main loop 193 | while true; do 194 | show_menu 195 | read -p $'\e[36mChoose an option: \e[0m' choice 196 | run_choice $choice 197 | empty_line 198 | done 199 | -------------------------------------------------------------------------------- /sequential_purge/README.md: -------------------------------------------------------------------------------- 1 | # BETA 2 | For issues, ping me (danni_design) in the [Discord](https://discord.gg/xqpKrxt9FC) server. 3 | 4 | # Sequential Purging 5 | 6 | This incredible macro ensures you will worry no more about purge lines from previous prints that haven't been removed from the bed. 7 | 8 | ![Sequential Purge4](https://github.com/user-attachments/assets/939f6509-9136-4ea3-83d8-b0293a6a49f5) 9 | 10 | While the macro itself doesn't (and can't) remove the purge lines from your bed automatically, it provides a system that remembers the locations of previous purges and avoids them in future print jobs. This ensures new purge lines are printed in clean sections of the bed. 11 | 12 | Currently, the macro can only purge on the front of the bed and does not support purging on the back, left, or right sides. 13 | 14 | ## Modes 15 | ### Continuous 16 | In continuous mode, the purge line is drawn in sequence with every print. Once all purge sections are filled, the macro starts again from the first purge section. 17 | 18 | ### Limited 19 | In limited mode, the purge line is drawn with every print. The print will not start once all purge sections are full, ensuring no accidental purge lines are left on the bed. 20 | 21 | ## Installation 22 | 1. Follow the instructions in the [Quick Install guide](https://github.com/Department-of-Design/Kevins-Awesome-Macros?tab=readme-ov-file#quick-install) and press `1` for `Install sequential purging` in the installation wizard. Once done, return to this page. 23 | 24 | 2. Restart your firmware by sending `FIRMWARE_RESTART`. 25 | 26 | 3. To initialize the counting and check if everything is installed correctly, send the macro `_INITIALIZE_PURGE` in your printer's console. This only needs to be done once. 27 | 4. It is required to add `max_extrude_cross_section: 5` to your `[extruder]` config to allow effective purging to be possible. 28 | 5. Open `KAM-settings.cfg` and navigate to the `Sequential Purging` section: 29 | ```yaml 30 | [gcode_macro _KAM-settings] 31 | description: Settings for KAM macros 32 | 33 | #################### 34 | # Sequential Purging 35 | #################### 36 | 37 | # Continuous: where the purge line gets drawn every print in an order and when the purge_sections_amount is full it will start back at the first purge section. 38 | # Limited: draws a purge line every print, and you don't have to worry about accidentally leaving the purge lines on the bed because the print will not start once the purge_sections_amount is full. 39 | # !! For Limited mode, you need CHECK_PURGES somewhere before the SEQUENTIAL_PURGE command in your PRINT_START macro. Preferably, place it before your printer heats up so you don't waste heating time. 40 | # !! When the purge section is full, you can use RESET_PURGES to clear the system and start at the first purge section on your next print. 41 | 42 | # Set this to True if you want continuous mode, and to False if you want limited mode. 43 | # Default is True 44 | variable_continuous: True 45 | 46 | # this is only... 47 | ``` 48 | 49 | Here, you can configure the settings for the macro. The most important setting is `variable_continuous`. This allows you to select the mode you want to use. For continuous mode, set `variable_continuous` to `True`. For limited mode, set it to `False`. You can read more about the modes [here](https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/sequential_purge#modes). 50 | 51 | 52 | > [!IMPORTANT] 53 | > After making any changes in the config you will need to restart the firmware by using `FIRMWARE_RESTART` or the button in the UI. If you don't restart the firmware the changes will not have any effect. 54 | 55 | ## Configuration 56 | | Setting | Description | Input | Default | 57 | |-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|---------| 58 | | `variable_continuous` | Setting for the mode you want to use. | `True` (Continuous)
`False` (Limited) | `True` | 59 | | `variable_stop_print_on_warning` | This is only needed in limited mode. This will stop the print if the purge section is full; if set to false, it will echo a message to the console instead of aborting the print. This will also automatically reset the purges and continue printing. Use at your own risk. | `True`
`False` | `False` | 60 | | `variable_warning_time` | Time the user has to remove purges | `0` to `3600` | `30` | 61 | | `variable_x_purge_offset` | The distance the purge line is away from the bed in X on both sides. This will only (not tested on other printers) work on configurations where the 0,0 point is on the left bottom corner of the bed. | `0` to `100` | `10` | 62 | | `variable_y_purge_offset` | The distance the purge line is away from the bed in Y. This will only (not tested on other printers) work on configurations where the 0,0 point is on the left bottom corner of the bed. | `0` to `100` | `3` | 63 | | `variable_purge_sections_amount` | The amount of purge sections in the line. | `0` to `20` | `5` | 64 | | `variable_purge_height` | The distance from the bed for the purge line. | Any number above `0` | `0.4` | 65 | | `variable_flow_rate` | Flow rate for the purge line; this will set the speed of the purge line and the amount of filament extruded, so set this carefully. Many set this at their hotend flow limit or slightly below that. | Any number above `0` | `12` | 66 | | `variable_multiplier` | Purge multiplier is for when you want more purge than stock offers. This will not increase the flow but will slow down the purge and use more material. The purge line works from 100% to 500%. For example, 150% more purge = 50% more. | 100 to 500 | `100` | 67 | | `variable_tip_distance` | The distance between the tip of the filament and the nozzle before purging. It should be similar to the final retract amount specified in PRINT_END. | Any number above `0` | `10` | 68 | | `variable_purge_line_end_overlap` | Specifies the overlap of the purge line with the next purge line in percentage. | Percentage from `0` to `100` | `50` | 69 | | `min_temp_extrude` | Temperature below which filament cannot be extruded. An error will occur if this temperature is not reached. | Temperature in Celsius | `180` | 70 | ## Macros in config 71 | 72 | This package contain's 3 macros: `_SEQUENTIAL_PURGE`, `_CHECK_PURGES` and `_RESET_PURGES`. 73 | 74 | For [continuous](https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/sequential_purge#continuous) mode you only need `_SEQUENTIAL_PURGE`. With the [limited](https://github.com/Department-of-Design/Kevins-Awesome-Macros/tree/main/sequential_purge#limited) mode you need all 3 the macros. 75 | 76 | Here's how your `PRINT_START` would look for both of them. 77 | 78 | #### Continuous 79 | ```yaml 80 | Home printer 81 | Heat printer 82 | (more print start stuff) 83 | _SEQUENTIAL_PURGE 84 | ``` 85 | In the continuous mode you can just replace your purge with the SEQUENTIAL_PURGE command. 86 | #### Limited 87 | ```yaml 88 | _CHECK_PURGES 89 | Home printer 90 | Heat printer 91 | (more print start stuff) 92 | _SEQUENTIAL_PURGE 93 | ``` 94 | For the limited mode it's a little different, here you check if the purge section is full before the print start's so you don't heat the printer up to find out there's still purges. 95 | 96 | ## Usage (only when using limited mode) 97 | When your purge section is full and you try to start a print, you'll notice you can't. This is because your printer knows the purge section is full and you'll have to remove all the purge lines and use the `_RESET_PURGES` command to let the printer know you've removed all purges. Now you can start a print again and be happily ever after. 98 | 99 | ## Technical info 100 | Here is a flowchart on how the macro performs. 101 | ```mermaid 102 | flowchart TD 103 | A[_SEQUENTIAL_PURGE] --> 104 | B[Get settings] --> 105 | C[Check if hotend is heated up] --> 106 | D[Divide the full purge section into multiple sections with the given purge_sections_amount] --> 107 | E[Calculate section_index, representing the section the current purge falls into based on purge_index] --> 108 | F[Get the first coordinate of the purge line]--> 109 | G[Get the last coordinate of the purge line]--> 110 | H[Continuous or Limited?] 111 | H --> |Continuous| I[Check if purge_index exceeds sections_amount] --> J[Reset purge_index if necessary] 112 | H --> |Limited| K[Check if purge section is full] 113 | K --> |Full| L[Raise error or respond with warning] --> M[Run RESET_PURGES] --> J 114 | K --> |Not Full| J 115 | J --> N[Make purge line in the calculated section] --> O[Increase purge_index] --> P[End macro] 116 | ``` 117 | 118 | ## Uninstalling 119 | That's unfortunate! Is the macro not working for you? If you're having trouble, feel free to send me a direct message on Discord (@danni_design) or ping me in KevinAkaSam's Sandbox server. 120 | 121 | If you still wish to uninstall the macro, you can do so by opening the setup wizard with the following command in your printer's command line: 122 | ```bash 123 | cd ~ && ./KAM-setup.sh 124 | ``` 125 | Navigate to the **Uninstall** menu (option 2) and follow the steps provided. 126 | 127 | If you no longer have the setup wizard, you can manually uninstall KAM by entering these commands in the command line: 128 | 129 | ```bash 130 | cd 131 | rm -rf Kevins-Awesome-Macros 132 | rm printer_data/config/KAM-settings.cfg 133 | rm printer_data/config/KAM/* 134 | rmdir printer_data/config/KAM 135 | ``` 136 | 137 | Additionally, remove the following from your `printer.cfg` file: 138 | ```yaml 139 | [include KAM-settings.cfg] 140 | ``` 141 | 142 | ## Troubleshooting 143 | 144 |
145 | 146 | 147 | I'm getting an error about save_variables! 148 | 149 | 150 |

151 | This happens because the macro already includes the `save_variables` section. To fix this, remove the conflicting section from a location other than `sequential_purge.cfg`. 152 |

153 |
154 | 155 |
156 | 157 | 158 | I'm getting the error `Error evaluating 'gcode_macro sequential_purge :gcode': jinja2.exceptions.UndefinedError: 'dict object' has no attribute 'purge_index'` 159 | 160 | 161 |

162 | This is caused by a bug in Klipper, to resolve this refer to step 3 in the installation. TL;DR: run _INITIALIZE_PURGE. 163 |

164 |
165 | 166 |
167 | 168 | 169 | I'm getting the error `Unknown command: "RESPOND"` when using the `_INITIALIZE_PURGES` command. 170 | 171 | 172 |

173 | This error occurs if you don't have the `[respond]` section configured. To fix it, add `[respond]` anywhere in your configuration file, preferably in `printer.cfg`. 174 |

175 |
176 | 177 | ## Credits 178 | Huge thanks to [Kyleisah](https://github.com/kyleisah) for the amazing work on KAMP and for the inspiration behind this macro. -------------------------------------------------------------------------------- /sequential_purge/config/sequential_purge.cfg: -------------------------------------------------------------------------------- 1 | [save_variables] 2 | filename: ~/variables.cfg 3 | 4 | [gcode_macro CHECK_PURGES] 5 | description: Checks if purge section is full. Only needed when using the limited version. 6 | gcode: 7 | 8 | {% if printer.save_variables.variables.purge_index > printer["gcode_macro _KAM_SETTINGS"].purge_sections_amount and printer["gcode_macro _KAM_SETTINGS"].continuous is not true%} 9 | {action_raise_error("Purge area is full! Please remove all purges. Use RESET_PURGES when done.")} 10 | {% endif %} 11 | 12 | [gcode_macro RESET_PURGES] 13 | description: Resets the purge_index to 1 indicating there is no purgeline present. Only needed when using the Limited version. 14 | gcode: 15 | SAVE_VARIABLE VARIABLE=purge_index VALUE=1 16 | RESPOND MSG="Purges are reset!" 17 | 18 | [gcode_macro _INITIALIZE_PURGE] 19 | description: Initializes the purges for initial install. 20 | gcode: 21 | SAVE_VARIABLE VARIABLE=purge_index VALUE=1 22 | RESPOND MSG="Macro working and initialized successfully!" 23 | 24 | [gcode_macro _SEQUENTIAL_PURGE] 25 | description: Makes sequential purges in case you forget to remove the purge your previous print did. Requires save_variables 26 | gcode: 27 | {% set purge_index = printer.save_variables.variables.purge_index | int %} # gets current purge order location thingy 28 | 29 | {% set kam_settings = printer["gcode_macro _KAM_SETTINGS"] %} 30 | {% if kam_settings.continuous %} 31 | {% set continuous = kam_settings.continuous %} 32 | {% set stop_print_on_warning = kam_settings.stop_print_on_warning %} 33 | {% set warning_time = kam_settings.warning_time | int %} 34 | {% set x_purge_offset = kam_settings.x_purge_offset | float %} 35 | {% set y_purge_offset = kam_settings.y_purge_offset | float %} 36 | {% set purge_sections_amount = kam_settings.purge_sections_amount | int %} 37 | {% set purge_height = kam_settings.purge_height | float %} 38 | {% set flow_rate = kam_settings.flow_rate | float %} 39 | {% set multiplier = kam_settings.multiplier / 100 | float %} 40 | {% set tip_distance = kam_settings.tip_distance | float %} 41 | {% set purge_line_end_overlap = kam_settings.purge_line_end_overlap | int %} 42 | {% set min_extrude_temp = kam_settings.min_extrude_temp |int %} 43 | {% set nozzle_diameter = printer.configfile.config['extruder'].nozzle_diameter | float %} 44 | {% set filament_diameter = printer.configfile.config['extruder'].filament_diameter | float %} 45 | {% endif %} 46 | 47 | {% set pi = 3.141592653589 | float %} 48 | 49 | {% if printer.extruder.temperature < min_extrude_temp %} # check whether hotend is heated up 50 | action_respond_error("Hotend is not up to temp. Please heat it.") 51 | {% endif %} 52 | 53 | {% if purge_index > purge_sections_amount and continuous is true %} 54 | SAVE_VARIABLE VARIABLE=purge_index VALUE=1 55 | {% endif %} 56 | 57 | {% set purge_begin_x = printer.toolhead.axis_minimum.x + x_purge_offset %} # gets the start point of the overall purge line 58 | {% set purge_end_x = printer.toolhead.axis_maximum.x - ( 2 * x_purge_offset ) %} # gets the end point of the overall purge line 59 | {% set purge_begin_y = printer.toolhead.axis_minimum.y + y_purge_offset %} # gets the start point of the overall purge line 60 | 61 | {% set section_size = purge_end_x // purge_sections_amount %} # divide the full purge section in multiple sections with the given purge_sections_amount 62 | {% set section_index = (purge_index - 1) % purge_sections_amount | int %} # this line calculates the section_index, which represents which section the current purge falls into based on the purge_index and the number of purge_sections_amount 63 | {% set purge_start_x = (section_index * section_size) + x_purge_offset | int %} # gets the first coordinate of the purge line 64 | {% set purge_end_x = (((section_index + 1) * section_size)) - (3 * (purge_line_end_overlap * 0.01)) + x_purge_offset %} # gets the end coordinate fro the purge while accounting for the offset # gets the last coordinate of the purge line 65 | 66 | {% set purge_area = ((4 - purge_height) * purge_height + pi * (purge_height / 2) ** 2) | float %} 67 | 68 | {% set purge_move_speed = ((flow_rate / purge_area) / multiplier) * 60 | float %} 69 | {% set purge_volume = (purge_area * section_size) %} 70 | {% set purge_extrusion = purge_volume / (pi * (filament_diameter / 2) ** 2) * multiplier %} 71 | 72 | {% if printer.firmware_retraction is defined %} 73 | {% set retract = G10 | string %} 74 | {% set unretract = G11 | string %} 75 | {% else %} 76 | {% set retract = 'G1 E-1 F2100' | string %} 77 | {% set unretract = 'G1 E1 F2100' | string %} 78 | {% endif %} 79 | 80 | {% if "xyz" not in printer.toolhead.homed_axes %} 81 | G28 82 | {% endif %} 83 | 84 | {% if continuous %} 85 | 86 | SAVE_GCODE_STATE NAME=prepurge # create gcode state 87 | 88 | G92 E0 # reset extruder 89 | G0 F5000 # set travel speed 90 | G90 # set absolute positioning # check if the toolhead has clearance for the purge lines 91 | G0 Z{purge_height + 7.5} 92 | 93 | {% if purge_index != 1 %} 94 | G0 X{purge_start_x - 1} Y{purge_begin_y} # move to the start of the purge line and move a bit in the other purge to merge them for easier removal 95 | {% else %} 96 | G0 X{purge_start_x} Y{purge_begin_y} # move to the start of the purge line 97 | {% endif %} 98 | 99 | G0 Z{purge_height} 100 | M83 # set absolute positioning 101 | G1 E{tip_distance} F{purge_move_speed} 102 | G1 F300 E{5 / ((0.4 / nozzle_diameter) ** 2)} 103 | G1 F300 E{5 / ((0.4 / nozzle_diameter) ** 2)} 104 | M106 S100 105 | G91 106 | G0 Y1.5 F5000 107 | G90 108 | G3 I-.75 J-.75 Z{purge_height + 1} # spiral 109 | G3 I-.75 J-.75 Z{purge_height + 2} # spiral 110 | G3 I-.75 J-.75 Z{purge_height + 3} # spiral 111 | G3 I-.75 J-.75 Z{purge_height + 4} # spiral 112 | G3 I-.75 J-.75 Z{purge_height + 5} # spiral 113 | G3 I-.75 J-.75 Z{purge_height + 6} # spiral 114 | G91 115 | G0 Y-.75 F5000 116 | G90 117 | G92 E0 118 | G91 119 | G0 X1.75 F5000 120 | G90 121 | M106 S0 122 | G0 Z{purge_height} 123 | G1 X{purge_end_x - 3} E{purge_extrusion} F{purge_move_speed} # print the purge line 124 | {retract} # unretract filament 125 | G92 E0 # set extruder back to zero 126 | M82 # set relative positioning 127 | G0 Z{purge_height * 2} # move nozzle up 128 | 129 | SAVE_VARIABLE VARIABLE=purge_index VALUE={purge_index + 1} # increase purge_index by 1 for the next purge/print 130 | 131 | RESTORE_GCODE_STATE NAME=prepurge # restore the gcode state 132 | 133 | {% else %} 134 | 135 | {% if purge_index > purge_sections_amount %} # start print should check this before doing purge so printer isnt uselessly heated before aborting print. But doing this check anyways 136 | {% if stop_print_on_warning is true %} 137 | {action_raise_error("Purge area is full! Please remove all purges from the buildplate. Use RESET_PURGES when done. And restart print.")} 138 | {% else %} 139 | RESPOND TYPE=error MSG="Purge area is full! Please remove all purges from the buildplate." 140 | G4 S{warning_time} 141 | RESET_PURGES 142 | {% endif %} 143 | {% endif %} 144 | 145 | SAVE_GCODE_STATE NAME=prepurge # create gcode state 146 | 147 | G92 E0 # reset extruder 148 | G0 F5000 # set travel speed 149 | G90 # set absolute positioning 150 | {% if purge_index != 1 %} 151 | G0 X{purge_start_x - 1} Y{purge_begin_y} # move to the start of the purge line and move a bit in the other purge to merge them for easier removal 152 | {% else %} 153 | G0 X{purge_start_x} Y{purge_begin_y} # move to the start of the purge line 154 | {% endif %} 155 | 156 | {% if printer.toolhead.position.z < 5 and purge_index >= 1 %} # check if the toolhead has clearance for the purge lines 157 | G0 Z{purge_height * 2} 158 | {% else %} 159 | G0 Z{purge_height} 160 | {% endif %} 161 | G0 Z{purge_height} 162 | M83 # set absolute positioning 163 | G1 F300 E{5 / ((0.4 / nozzle_diameter) ** 2)} 164 | G1 F300 E{5 / ((0.4 / nozzle_diameter) ** 2)} 165 | M106 S100 166 | G91 167 | G0 Y1.5 F5000 168 | G90 169 | G3 I-.75 J-.75 Z{purge_height + 1} # spiral 170 | G3 I-.75 J-.75 Z{purge_height + 2} # spiral 171 | G3 I-.75 J-.75 Z{purge_height + 3} # spiral 172 | G3 I-.75 J-.75 Z{purge_height + 4} # spiral 173 | G3 I-.75 J-.75 Z{purge_height + 5} # spiral 174 | G3 I-.75 J-.75 Z{purge_height + 6} # spiral 175 | G91 176 | G0 Y-.75 F5000 177 | G90 178 | G92 E0 179 | G91 180 | G0 X1.75 F5000 181 | G90 182 | M106 S0 183 | G0 Z{purge_height} 184 | G1 X{purge_end_x - 3} E{purge_extrusion} F{purge_move_speed} # print the purge line 185 | {retract} # unretract filament 186 | G92 E0 # set extruder back to zero 187 | M82 # set relative positioning 188 | G0 Z{purge_height * 2} # move nozzle up 189 | 190 | SAVE_VARIABLE VARIABLE=purge_index VALUE={purge_index + 1} # increase purge_index by 1 for the next purge/print 191 | 192 | RESTORE_GCODE_STATE NAME=prepurge # restore the gcode state 193 | 194 | {% endif %} 195 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------