├── .envrc ├── .gitignore ├── README.md ├── flake.lock ├── flake.nix └── LICENCE /.envrc: -------------------------------------------------------------------------------- 1 | # Expects a valid #!, disable because flake. 2 | # shellcheck disable=SC2148 3 | use flake 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .direnv/ 2 | # General 3 | .DS_Store 4 | .AppleDouble 5 | .LSOverride 6 | Icon[ ] 7 | 8 | # Thumbnails 9 | ._* 10 | 11 | # Files that might appear in the root of a volume 12 | .DocumentRevisions-V100 13 | .fseventsd 14 | .Spotlight-V100 15 | .TemporaryItems 16 | .Trashes 17 | .VolumeIcon.icns 18 | .com.apple.timemachine.donotpresent 19 | 20 | # Directories potentially created on remote AFP share 21 | .AppleDB 22 | .AppleDesktop 23 | Network Trash Folder 24 | Temporary Items 25 | .apdisk 26 | # Windows thumbnail cache files 27 | Thumbs.db 28 | Thumbs.db:encryptable 29 | ehthumbs.db 30 | ehthumbs_vista.db 31 | 32 | # Dump file 33 | *.stackdump 34 | 35 | # Folder config file 36 | [Dd]esktop.ini 37 | 38 | # Recycle Bin used on file shares 39 | $RECYCLE.BIN/ 40 | 41 | # Windows Installer files 42 | *.cab 43 | *.msi 44 | *.msix 45 | *.msm 46 | *.msp 47 | 48 | # Windows shortcuts 49 | *.lnk 50 | *~ 51 | 52 | # temporary files which can be created if a process still has a handle open of a deleted file 53 | .fuse_hidden* 54 | 55 | # Metadata left by Dolphin file manager, which comes with KDE Plasma 56 | .directory 57 | 58 | # Linux trash folder which might appear on any partition or disk 59 | .Trash-* 60 | 61 | # .nfs files are created when an open file is removed but is still being accessed 62 | .nfs* 63 | 64 | # Log files created by default by the nohup command 65 | nohup.out 66 | *.orig 67 | *.rej 68 | # Ignore build outputs from performing a nix-build or `nix build` command 69 | result 70 | result-* 71 | 72 | # Ignore automatically generated direnv output 73 | .direnv 74 | # User Provided 75 | .editorconfig 76 | .pre-commit-config.yaml 77 | 78 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # IgnoreBoy 2 | 3 | ## What is this? 4 | 5 | This is a nix-shell lib that helps you create best practice `.gitignore` files 6 | by using 7 | [Githubs Default .gitignore Templates](https://github.com/github/gitignore), 8 | and/or [Toptal's gitignore.io](https://gitignore.io). No longer will you be held 9 | back by the tyrany of copy and pasting files from around the internet! Let this 10 | copy paste for you! 11 | 12 | ## Why would I use this? Like, my guy, I almost never touch my `.gitignore`. 13 | 14 | There are a few reasons that you might enjoy using this: 15 | 16 | - Codebases with diverse languages often tend to have a `.gitignore` that are 17 | sparse, and don't use best practices. 18 | - If you're setting up a development environment for a new codebase, you might 19 | not event know what a best practice code `.gitignore` looks like! Take the 20 | [Julia](https://github.com/github/gitignore/blob/main/Julia.gitignore) 21 | language for example. I didn't know it looked like that. 22 | - You could _just_ copy and paste these templates, but keeping track, and 23 | checking for updates (if ever!) is annoying, and might be at the very bottom 24 | of your todo list. 25 | - For the low-low price of using this, there are some 26 | [sane defaults built-in](https://github.com/Ookiiboy/ignoreBoy/blob/main/flake.nix#L71C1-L76C24). 27 | All the stuff you forget to add (or never add but should), now added by 28 | default! 29 | - Did a goddamned Node.js project get added to your codebase by Alice. Don't 30 | know what to add to the `.gitignore`? Add `"Node"` to the array and be done 31 | with it. 32 | 33 | ## Okay, I want to at least give it a whirl. How do you use this? 34 | 35 | It should look something like the below. We've left out non-related code for 36 | brevity. In short, add it to your inputs, and have it run in your shellhook of 37 | your main devshell. 38 | 39 | ```nix 40 | 41 | # 1. https://github.com/github/gitignore - use this repo, and add the filename 42 | # and/ or path/filename to the array, drop the extension. Note the uppercase 43 | # filenames. 44 | # 2. `curl -sL https://www.toptal.com/developers/gitignore/api/list`; this 45 | # will give you a list of supported languages. 46 | # 3. GOTCHA: This will fail on first run, you will need to copy the hash into 47 | # the attribute. **Everytime** you update the `gitignoreio.languages`, delete 48 | # the hash, re-run the shell, and copy the updated hash back into the 49 | # attribute after the next fail again. This will force the input to refresh, 50 | # and make a new API request. Otherwise it will remain cached. 51 | # 4. Defaults to `true`, but you can set to false if you don't want OS related 52 | # ignores. You don't usually need to specify. It's here for clarity. 53 | # 5. Anything custom you might want in your .gitignore you can place in this 54 | # extraConfig. 55 | 56 | { 57 | inputs = { 58 | # ... 59 | systems.url = "github:nix-systems/default"; 60 | ignoreBoy.url = "github:Ookiiboy/ignoreBoy"; 61 | }; 62 | 63 | outputs = { 64 | # ... 65 | ignoreBoy, 66 | ... 67 | } @ inputs: let 68 | forAllSystems = nixpkgs.lib.genAttrs (import systems); 69 | in { 70 | devShells = forAllSystems (system: { 71 | default = 72 | pkgs.mkShell { 73 | shellHook = '' 74 | # ... 75 | ${ignoreBoy.lib.${system}.gitignore { 76 | github.languages = ["Node" "community/JavaScript/Vue"]; # 1 77 | gitignoreio.languages = ["node"]; # 2 78 | gitignoreio.hash = ""; # 3 79 | useSaneDefaults = true; # 4 80 | extraConfig = '' 81 | .editorconfig 82 | .pre-commit-config.yaml 83 | ''; # 5 84 | }} 85 | # ... 86 | ''; 87 | buildInputs = with pkgs; [ 88 | # ... 89 | ]; 90 | }; 91 | }); 92 | }; 93 | } 94 | ``` 95 | 96 | ## People who've helped 97 | - [arichtman](https://github.com/arichtman) - Started the work for the gitignore.io api. 98 | - [isabelroses](https://github.com/isabelroses) - Helped cleaned up the `flake.nix` file. 99 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "editorconfig": { 4 | "flake": false, 5 | "locked": { 6 | "lastModified": 1748032927, 7 | "narHash": "sha256-Z/AyBi5qgI6jAlBmMtyAYa1y4ujrBqYd6GDUt40wER4=", 8 | "owner": "Ookiiboy", 9 | "repo": "editor-config", 10 | "rev": "1baed1b2d90db36ddf59ad6c886d74f8d5d4aad3", 11 | "type": "github" 12 | }, 13 | "original": { 14 | "owner": "Ookiiboy", 15 | "repo": "editor-config", 16 | "type": "github" 17 | } 18 | }, 19 | "flake-compat": { 20 | "flake": false, 21 | "locked": { 22 | "lastModified": 1696426674, 23 | "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", 24 | "owner": "edolstra", 25 | "repo": "flake-compat", 26 | "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", 27 | "type": "github" 28 | }, 29 | "original": { 30 | "owner": "edolstra", 31 | "repo": "flake-compat", 32 | "type": "github" 33 | } 34 | }, 35 | "gitignore": { 36 | "inputs": { 37 | "nixpkgs": [ 38 | "pre-commit-hooks", 39 | "nixpkgs" 40 | ] 41 | }, 42 | "locked": { 43 | "lastModified": 1709087332, 44 | "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=", 45 | "owner": "hercules-ci", 46 | "repo": "gitignore.nix", 47 | "rev": "637db329424fd7e46cf4185293b9cc8c88c95394", 48 | "type": "github" 49 | }, 50 | "original": { 51 | "owner": "hercules-ci", 52 | "repo": "gitignore.nix", 53 | "type": "github" 54 | } 55 | }, 56 | "gitignore-repo": { 57 | "flake": false, 58 | "locked": { 59 | "lastModified": 1750869937, 60 | "narHash": "sha256-X7eGOyECpAO8szVN3Wt167MUP39fLfeudE3CcOHfCrY=", 61 | "owner": "github", 62 | "repo": "gitignore", 63 | "rev": "df4a30a4065e1c0fc258843da7fb6c1867ac7277", 64 | "type": "github" 65 | }, 66 | "original": { 67 | "owner": "github", 68 | "repo": "gitignore", 69 | "type": "github" 70 | } 71 | }, 72 | "nixpkgs": { 73 | "locked": { 74 | "lastModified": 1750865895, 75 | "narHash": "sha256-p2dWAQcLVzquy9LxYCZPwyUdugw78Qv3ChvnX755qHA=", 76 | "owner": "NixOS", 77 | "repo": "nixpkgs", 78 | "rev": "61c0f513911459945e2cb8bf333dc849f1b976ff", 79 | "type": "github" 80 | }, 81 | "original": { 82 | "owner": "NixOS", 83 | "ref": "nixpkgs-unstable", 84 | "repo": "nixpkgs", 85 | "type": "github" 86 | } 87 | }, 88 | "nixpkgs_2": { 89 | "locked": { 90 | "lastModified": 1730768919, 91 | "narHash": "sha256-8AKquNnnSaJRXZxc5YmF/WfmxiHX6MMZZasRP6RRQkE=", 92 | "owner": "NixOS", 93 | "repo": "nixpkgs", 94 | "rev": "a04d33c0c3f1a59a2c1cb0c6e34cd24500e5a1dc", 95 | "type": "github" 96 | }, 97 | "original": { 98 | "owner": "NixOS", 99 | "ref": "nixpkgs-unstable", 100 | "repo": "nixpkgs", 101 | "type": "github" 102 | } 103 | }, 104 | "pre-commit-hooks": { 105 | "inputs": { 106 | "flake-compat": "flake-compat", 107 | "gitignore": "gitignore", 108 | "nixpkgs": "nixpkgs_2" 109 | }, 110 | "locked": { 111 | "lastModified": 1750779888, 112 | "narHash": "sha256-wibppH3g/E2lxU43ZQHC5yA/7kIKLGxVEnsnVK1BtRg=", 113 | "owner": "cachix", 114 | "repo": "pre-commit-hooks.nix", 115 | "rev": "16ec914f6fb6f599ce988427d9d94efddf25fe6d", 116 | "type": "github" 117 | }, 118 | "original": { 119 | "owner": "cachix", 120 | "repo": "pre-commit-hooks.nix", 121 | "type": "github" 122 | } 123 | }, 124 | "root": { 125 | "inputs": { 126 | "editorconfig": "editorconfig", 127 | "gitignore-repo": "gitignore-repo", 128 | "nixpkgs": "nixpkgs", 129 | "pre-commit-hooks": "pre-commit-hooks", 130 | "systems": "systems" 131 | } 132 | }, 133 | "systems": { 134 | "locked": { 135 | "lastModified": 1681028828, 136 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", 137 | "owner": "nix-systems", 138 | "repo": "default", 139 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", 140 | "type": "github" 141 | }, 142 | "original": { 143 | "owner": "nix-systems", 144 | "repo": "default", 145 | "type": "github" 146 | } 147 | } 148 | }, 149 | "root": "root", 150 | "version": 7 151 | } 152 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | inputs = { 3 | nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; 4 | systems.url = "github:nix-systems/default"; 5 | pre-commit-hooks.url = "github:cachix/pre-commit-hooks.nix"; 6 | gitignore-repo.url = "github:github/gitignore"; 7 | gitignore-repo.flake = false; 8 | editorconfig.url = "github:Ookiiboy/editor-config/"; 9 | editorconfig.flake = false; 10 | }; 11 | 12 | outputs = { 13 | self, 14 | systems, 15 | nixpkgs, 16 | pre-commit-hooks, 17 | editorconfig, 18 | gitignore-repo, 19 | ... 20 | }: let 21 | forAllSystems = function: nixpkgs.lib.genAttrs (import systems) (system: function nixpkgs.legacyPackages.${system}); 22 | in { 23 | formatter = forAllSystems (pkgs: pkgs.alejandra); 24 | packages = forAllSystems (pkgs: { 25 | default = self.lib.${pkgs.system}.gitignore { 26 | github.languages = []; 27 | gitignoreio.languages = []; 28 | hash = ""; 29 | extraConfig = '' 30 | .editorconfig 31 | .pre-commit-config.yaml 32 | ''; 33 | }; 34 | }); 35 | checks = forAllSystems (pkgs: { 36 | pre-commit-check = pre-commit-hooks.lib.${pkgs.system}.run { 37 | src = ./.; 38 | hooks = { 39 | # Nix 40 | alejandra.enable = true; 41 | deadnix.enable = true; 42 | statix.enable = true; 43 | flake-checker.enable = true; 44 | # Generic - .editorconfig 45 | editorconfig-checker.enable = true; 46 | }; 47 | }; 48 | }); 49 | 50 | devShells = forAllSystems (pkgs: { 51 | default = pkgs.mkShell { 52 | name = "development"; 53 | shellHook = '' 54 | ln -sf ${editorconfig}/.editorconfig ./.editorconfig 55 | ${self.checks.${pkgs.system}.pre-commit-check.shellHook} 56 | ${self.lib.${pkgs.system}.gitignore { 57 | github.languages = []; 58 | gitignoreio.languages = []; 59 | hash = ""; 60 | extraConfig = '' 61 | .editorconfig 62 | .pre-commit-config.yaml 63 | ''; 64 | }} 65 | ''; 66 | buildInputs = self.checks.${pkgs.system}.pre-commit-check.enabledPackages; 67 | }; 68 | }); 69 | 70 | lib = forAllSystems (pkgs: rec { 71 | toptalGitignoreIo = arguments @ { 72 | languages ? [], 73 | hash ? "", 74 | # Allow variadic arguments so we have one API 75 | ... 76 | }: 77 | builtins.fetchurl { 78 | url = "https://www.toptal.com/developers/gitignore/api/${pkgs.lib.concatStringsSep "," arguments.languages}"; 79 | name = "toptalGitignoreIo"; # Required as both "," and "%2C" are invalid store paths 80 | # For some godforsaken reason arguments.hash bombs on missing property 81 | sha256 = hash; 82 | }; 83 | 84 | ignoreRepoFile = file: 85 | # ↓ By the way, how fucking cool is this?! ↓ 86 | gitignore-repo + "/${file}.gitignore"; 87 | 88 | ignoreDirenv = pkgs.writeText "ignoreDirenv" '' 89 | .direnv/ 90 | ''; 91 | saneDefaults = [ 92 | "Global/macOS" 93 | "Global/Windows" 94 | "Global/Linux" 95 | "Global/Patch" 96 | "Nix" 97 | ]; 98 | writeExtraConfig = extra: [ 99 | (pkgs.writeText "extraConfig" '' 100 | # User Provided 101 | ${extra} 102 | '') 103 | ]; 104 | generateGitIgnore = settings: 105 | pkgs.concatText ".gitignore" ( 106 | [ 107 | ignoreDirenv 108 | ] 109 | # Sane Defaults - Ingested 110 | ++ ( 111 | if (!settings ? useSaneDefaults || settings.useSaneDefaults) 112 | then map ignoreRepoFile saneDefaults 113 | else [] 114 | ) 115 | # API Derrived Ignores 116 | ++ ( 117 | if 118 | ( 119 | builtins.hasAttr "gitignoreio" settings 120 | && builtins.hasAttr "languages" settings.gitignoreio 121 | # Since this is an API hit, it will return something on an empty 122 | # array 123 | && settings.gitignoreio.languages != [] 124 | ) 125 | then [ 126 | (toptalGitignoreIo { 127 | inherit (settings.gitignoreio) languages; 128 | hash = 129 | if (builtins.hasAttr "hash" settings.gitignoreio) 130 | then settings.gitignoreio.hash 131 | else ""; 132 | }) 133 | ] 134 | else [] 135 | ) 136 | ++ ( 137 | if (builtins.hasAttr "github" settings && builtins.hasAttr "languages" settings.github) 138 | then map ignoreRepoFile settings.github.languages 139 | else [] 140 | ) 141 | ++ 142 | # User Defined - These come last in the event that anything should be 143 | # overridden. 144 | ( 145 | if builtins.hasAttr "extraConfig" settings 146 | then writeExtraConfig settings.extraConfig 147 | else [] 148 | ) 149 | ); 150 | 151 | # We can't link the file in the store. What a crime. Gotta copy. 152 | gitignore = settings: '' 153 | cp -f ${generateGitIgnore settings} ./.gitignore 154 | ''; 155 | }); 156 | }; 157 | } 158 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. Everyone is 5 | permitted to copy and distribute verbatim copies of this license document, but 6 | changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for software and 11 | other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed to take 14 | away your freedom to share and change the works. By contrast, the GNU General 15 | Public License is intended to guarantee your freedom to share and change all 16 | versions of a program--to make sure it remains free software for all its users. 17 | We, the Free Software Foundation, use the GNU General Public License for most of 18 | our software; it applies also to any other work released this way by its 19 | authors. You can apply it to your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not price. Our 22 | General Public Licenses are designed to make sure that you have the freedom to 23 | distribute copies of free software (and charge for them if you wish), that you 24 | receive source code or can get it if you want it, that you can change the 25 | software or use pieces of it in new free programs, and that you know you can do 26 | these things. 27 | 28 | To protect your rights, we need to prevent others from denying you these rights 29 | or asking you to surrender the rights. Therefore, you have certain 30 | responsibilities if you distribute copies of the software, or if you modify it: 31 | responsibilities to respect the freedom of others. 32 | 33 | For example, if you distribute copies of such a program, whether gratis or for a 34 | fee, you must pass on to the recipients the same freedoms that you received. You 35 | must make sure that they, too, receive or can get the source code. And you must 36 | show them these terms so they know their rights. 37 | 38 | Developers that use the GNU GPL protect your rights with two steps: (1) assert 39 | copyright on the software, and (2) offer you this License giving you legal 40 | permission to copy, distribute and/or modify it. 41 | 42 | For the developers' and authors' protection, the GPL clearly explains that there 43 | is no warranty for this free software. For both users' and authors' sake, the 44 | GPL requires that modified versions be marked as changed, so that their problems 45 | will not be attributed erroneously to authors of previous versions. 46 | 47 | Some devices are designed to deny users access to install or run modified 48 | versions of the software inside them, although the manufacturer can do so. This 49 | is fundamentally incompatible with the aim of protecting users' freedom to 50 | change the software. The systematic pattern of such abuse occurs in the area of 51 | products for individuals to use, which is precisely where it is most 52 | unacceptable. Therefore, we have designed this version of the GPL to prohibit 53 | the practice for those products. If such problems arise substantially in other 54 | domains, we stand ready to extend this provision to those domains in future 55 | versions of the GPL, as needed to protect the freedom of users. 56 | 57 | Finally, every program is threatened constantly by software patents. States 58 | should not allow patents to restrict development and use of software on 59 | general-purpose computers, but in those that do, we wish to avoid the special 60 | danger that patents applied to a free program could make it effectively 61 | proprietary. To prevent this, the GPL assures that patents cannot be used to 62 | render the program non-free. 63 | 64 | The precise terms and conditions for copying, distribution and modification 65 | follow. 66 | 67 | TERMS AND CONDITIONS 68 | 69 | 0. Definitions. 70 | 71 | "This License" refers to version 3 of the GNU General Public License. 72 | 73 | "Copyright" also means copyright-like laws that apply to other kinds of works, 74 | such as semiconductor masks. 75 | 76 | "The Program" refers to any copyrightable work licensed under this License. Each 77 | licensee is addressed as "you". "Licensees" and "recipients" may be individuals 78 | or organizations. 79 | 80 | To "modify" a work means to copy from or adapt all or part of the work in a 81 | fashion requiring copyright permission, other than the making of an exact copy. 82 | The resulting work is called a "modified version" of the earlier work or a work 83 | "based on" the earlier work. 84 | 85 | A "covered work" means either the unmodified Program or a work based on the 86 | Program. 87 | 88 | To "propagate" a work means to do anything with it that, without permission, 89 | would make you directly or secondarily liable for infringement under applicable 90 | copyright law, except executing it on a computer or modifying a private copy. 91 | Propagation includes copying, distribution (with or without modification), 92 | making available to the public, and in some countries other activities as well. 93 | 94 | To "convey" a work means any kind of propagation that enables other parties to 95 | make or receive copies. Mere interaction with a user through a computer network, 96 | with no transfer of a copy, is not conveying. 97 | 98 | An interactive user interface displays "Appropriate Legal Notices" to the extent 99 | that it includes a convenient and prominently visible feature that (1) displays 100 | an appropriate copyright notice, and (2) tells the user that there is no 101 | warranty for the work (except to the extent that warranties are provided), that 102 | licensees may convey the work under this License, and how to view a copy of this 103 | License. If the interface presents a list of user commands or options, such as a 104 | menu, a prominent item in the list meets this criterion. 105 | 106 | 1. Source Code. 107 | 108 | The "source code" for a work means the preferred form of the work for making 109 | modifications to it. "Object code" means any non-source form of a work. 110 | 111 | A "Standard Interface" means an interface that either is an official standard 112 | defined by a recognized standards body, or, in the case of interfaces specified 113 | for a particular programming language, one that is widely used among developers 114 | working in that language. 115 | 116 | The "System Libraries" of an executable work include anything, other than the 117 | work as a whole, that (a) is included in the normal form of packaging a Major 118 | Component, but which is not part of that Major Component, and (b) serves only to 119 | enable use of the work with that Major Component, or to implement a Standard 120 | Interface for which an implementation is available to the public in source code 121 | form. A "Major Component", in this context, means a major essential component 122 | (kernel, window system, and so on) of the specific operating system (if any) on 123 | which the executable work runs, or a compiler used to produce the work, or an 124 | object code interpreter used to run it. 125 | 126 | The "Corresponding Source" for a work in object code form means all the source 127 | code needed to generate, install, and (for an executable work) run the object 128 | code and to modify the work, including scripts to control those activities. 129 | However, it does not include the work's System Libraries, or general-purpose 130 | tools or generally available free programs which are used unmodified in 131 | performing those activities but which are not part of the work. For example, 132 | Corresponding Source includes interface definition files associated with source 133 | files for the work, and the source code for shared libraries and dynamically 134 | linked subprograms that the work is specifically designed to require, such as by 135 | intimate data communication or control flow between those subprograms and other 136 | parts of the work. 137 | 138 | The Corresponding Source need not include anything that users can regenerate 139 | automatically from other parts of the Corresponding Source. 140 | 141 | The Corresponding Source for a work in source code form is that same work. 142 | 143 | 2. Basic Permissions. 144 | 145 | All rights granted under this License are granted for the term of copyright on 146 | the Program, and are irrevocable provided the stated conditions are met. This 147 | License explicitly affirms your unlimited permission to run the unmodified 148 | Program. The output from running a covered work is covered by this License only 149 | if the output, given its content, constitutes a covered work. This License 150 | acknowledges your rights of fair use or other equivalent, as provided by 151 | copyright law. 152 | 153 | You may make, run and propagate covered works that you do not convey, without 154 | conditions so long as your license otherwise remains in force. You may convey 155 | covered works to others for the sole purpose of having them make modifications 156 | exclusively for you, or provide you with facilities for running those works, 157 | provided that you comply with the terms of this License in conveying all 158 | material for which you do not control copyright. Those thus making or running 159 | the covered works for you must do so exclusively on your behalf, under your 160 | direction and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under the conditions 164 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 165 | 166 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 167 | 168 | No covered work shall be deemed part of an effective technological measure under 169 | any applicable law fulfilling obligations under article 11 of the WIPO copyright 170 | treaty adopted on 20 December 1996, or similar laws prohibiting or restricting 171 | circumvention of such measures. 172 | 173 | When you convey a covered work, you waive any legal power to forbid 174 | circumvention of technological measures to the extent such circumvention is 175 | effected by exercising rights under this License with respect to the covered 176 | work, and you disclaim any intention to limit operation or modification of the 177 | work as a means of enforcing, against the work's users, your or third parties' 178 | legal rights to forbid circumvention of technological measures. 179 | 180 | 4. Conveying Verbatim Copies. 181 | 182 | You may convey verbatim copies of the Program's source code as you receive it, 183 | in any medium, provided that you conspicuously and appropriately publish on each 184 | copy an appropriate copyright notice; keep intact all notices stating that this 185 | License and any non-permissive terms added in accord with section 7 apply to the 186 | code; keep intact all notices of the absence of any warranty; and give all 187 | recipients a copy of this License along with the Program. 188 | 189 | You may charge any price or no price for each copy that you convey, and you may 190 | offer support or warranty protection for a fee. 191 | 192 | 5. Conveying Modified Source Versions. 193 | 194 | You may convey a work based on the Program, or the modifications to produce it 195 | from the Program, in the form of source code under the terms of section 4, 196 | provided that you also meet all of these conditions: 197 | 198 | a) The work must carry prominent notices stating that you modified 199 | it, and giving a relevant date. 200 | 201 | b) The work must carry prominent notices stating that it is 202 | released under this License and any conditions added under section 203 | 7. This requirement modifies the requirement in section 4 to 204 | "keep intact all notices". 205 | 206 | c) You must license the entire work, as a whole, under this 207 | License to anyone who comes into possession of a copy. This 208 | License will therefore apply, along with any applicable section 7 209 | additional terms, to the whole of the work, and all its parts, 210 | regardless of how they are packaged. This License gives no 211 | permission to license the work in any other way, but it does not 212 | invalidate such permission if you have separately received it. 213 | 214 | d) If the work has interactive user interfaces, each must display 215 | Appropriate Legal Notices; however, if the Program has interactive 216 | interfaces that do not display Appropriate Legal Notices, your 217 | work need not make them do so. 218 | 219 | A compilation of a covered work with other separate and independent works, which 220 | are not by their nature extensions of the covered work, and which are not 221 | combined with it such as to form a larger program, in or on a volume of a 222 | storage or distribution medium, is called an "aggregate" if the compilation and 223 | its resulting copyright are not used to limit the access or legal rights of the 224 | compilation's users beyond what the individual works permit. Inclusion of a 225 | covered work in an aggregate does not cause this License to apply to the other 226 | parts of the aggregate. 227 | 228 | 6. Conveying Non-Source Forms. 229 | 230 | You may convey a covered work in object code form under the terms of sections 4 231 | and 5, provided that you also convey the machine-readable Corresponding Source 232 | under the terms of this License, in one of these ways: 233 | 234 | a) Convey the object code in, or embodied in, a physical product 235 | (including a physical distribution medium), accompanied by the 236 | Corresponding Source fixed on a durable physical medium 237 | customarily used for software interchange. 238 | 239 | b) Convey the object code in, or embodied in, a physical product 240 | (including a physical distribution medium), accompanied by a 241 | written offer, valid for at least three years and valid for as 242 | long as you offer spare parts or customer support for that product 243 | model, to give anyone who possesses the object code either (1) a 244 | copy of the Corresponding Source for all the software in the 245 | product that is covered by this License, on a durable physical 246 | medium customarily used for software interchange, for a price no 247 | more than your reasonable cost of physically performing this 248 | conveying of source, or (2) access to copy the 249 | Corresponding Source from a network server at no charge. 250 | 251 | c) Convey individual copies of the object code with a copy of the 252 | written offer to provide the Corresponding Source. This 253 | alternative is allowed only occasionally and noncommercially, and 254 | only if you received the object code with such an offer, in accord 255 | with subsection 6b. 256 | 257 | d) Convey the object code by offering access from a designated 258 | place (gratis or for a charge), and offer equivalent access to the 259 | Corresponding Source in the same way through the same place at no 260 | further charge. You need not require recipients to copy the 261 | Corresponding Source along with the object code. If the place to 262 | copy the object code is a network server, the Corresponding Source 263 | may be on a different server (operated by you or a third party) 264 | that supports equivalent copying facilities, provided you maintain 265 | clear directions next to the object code saying where to find the 266 | Corresponding Source. Regardless of what server hosts the 267 | Corresponding Source, you remain obligated to ensure that it is 268 | available for as long as needed to satisfy these requirements. 269 | 270 | e) Convey the object code using peer-to-peer transmission, provided 271 | you inform other peers where the object code and Corresponding 272 | Source of the work are being offered to the general public at no 273 | charge under subsection 6d. 274 | 275 | A separable portion of the object code, whose source code is excluded from the 276 | Corresponding Source as a System Library, need not be included in conveying the 277 | object code work. 278 | 279 | A "User Product" is either (1) a "consumer product", which means any tangible 280 | personal property which is normally used for personal, family, or household 281 | purposes, or (2) anything designed or sold for incorporation into a dwelling. In 282 | determining whether a product is a consumer product, doubtful cases shall be 283 | resolved in favor of coverage. For a particular product received by a particular 284 | user, "normally used" refers to a typical or common use of that class of 285 | product, regardless of the status of the particular user or of the way in which 286 | the particular user actually uses, or expects or is expected to use, the 287 | product. A product is a consumer product regardless of whether the product has 288 | substantial commercial, industrial or non-consumer uses, unless such uses 289 | represent the only significant mode of use of the product. 290 | 291 | "Installation Information" for a User Product means any methods, procedures, 292 | authorization keys, or other information required to install and execute 293 | modified versions of a covered work in that User Product from a modified version 294 | of its Corresponding Source. The information must suffice to ensure that the 295 | continued functioning of the modified object code is in no case prevented or 296 | interfered with solely because modification has been made. 297 | 298 | If you convey an object code work under this section in, or with, or 299 | specifically for use in, a User Product, and the conveying occurs as part of a 300 | transaction in which the right of possession and use of the User Product is 301 | transferred to the recipient in perpetuity or for a fixed term (regardless of 302 | how the transaction is characterized), the Corresponding Source conveyed under 303 | this section must be accompanied by the Installation Information. But this 304 | requirement does not apply if neither you nor any third party retains the 305 | ability to install modified object code on the User Product (for example, the 306 | work has been installed in ROM). 307 | 308 | The requirement to provide Installation Information does not include a 309 | requirement to continue to provide support service, warranty, or updates for a 310 | work that has been modified or installed by the recipient, or for the User 311 | Product in which it has been modified or installed. Access to a network may be 312 | denied when the modification itself materially and adversely affects the 313 | operation of the network or violates the rules and protocols for communication 314 | across the network. 315 | 316 | Corresponding Source conveyed, and Installation Information provided, in accord 317 | with this section must be in a format that is publicly documented (and with an 318 | implementation available to the public in source code form), and must require no 319 | special password or key for unpacking, reading or copying. 320 | 321 | 7. Additional Terms. 322 | 323 | "Additional permissions" are terms that supplement the terms of this License by 324 | making exceptions from one or more of its conditions. Additional permissions 325 | that are applicable to the entire Program shall be treated as though they were 326 | included in this License, to the extent that they are valid under applicable 327 | law. If additional permissions apply only to part of the Program, that part may 328 | be used separately under those permissions, but the entire Program remains 329 | governed by this License without regard to the additional permissions. 330 | 331 | When you convey a copy of a covered work, you may at your option remove any 332 | additional permissions from that copy, or from any part of it. (Additional 333 | permissions may be written to require their own removal in certain cases when 334 | you modify the work.) You may place additional permissions on material, added by 335 | you to a covered work, for which you have or can give appropriate copyright 336 | permission. 337 | 338 | Notwithstanding any other provision of this License, for material you add to a 339 | covered work, you may (if authorized by the copyright holders of that material) 340 | supplement the terms of this License with terms: 341 | 342 | a) Disclaiming warranty or limiting liability differently from the 343 | terms of sections 15 and 16 of this License; or 344 | 345 | b) Requiring preservation of specified reasonable legal notices or 346 | author attributions in that material or in the Appropriate Legal 347 | Notices displayed by works containing it; or 348 | 349 | c) Prohibiting misrepresentation of the origin of that material, or 350 | requiring that modified versions of such material be marked in 351 | reasonable ways as different from the original version; or 352 | 353 | d) Limiting the use for publicity purposes of names of licensors or 354 | authors of the material; or 355 | 356 | e) Declining to grant rights under trademark law for use of some 357 | trade names, trademarks, or service marks; or 358 | 359 | f) Requiring indemnification of licensors and authors of that 360 | material by anyone who conveys the material (or modified versions of 361 | it) with contractual assumptions of liability to the recipient, for 362 | any liability that these contractual assumptions directly impose on 363 | those licensors and authors. 364 | 365 | All other non-permissive additional terms are considered "further restrictions" 366 | within the meaning of section 10. If the Program as you received it, or any part 367 | of it, contains a notice stating that it is governed by this License along with 368 | a term that is a further restriction, you may remove that term. If a license 369 | document contains a further restriction but permits relicensing or conveying 370 | under this License, you may add to a covered work material governed by the terms 371 | of that license document, provided that the further restriction does not survive 372 | such relicensing or conveying. 373 | 374 | If you add terms to a covered work in accord with this section, you must place, 375 | in the relevant source files, a statement of the additional terms that apply to 376 | those files, or a notice indicating where to find the applicable terms. 377 | 378 | Additional terms, permissive or non-permissive, may be stated in the form of a 379 | separately written license, or stated as exceptions; the above requirements 380 | apply either way. 381 | 382 | 8. Termination. 383 | 384 | You may not propagate or modify a covered work except as expressly provided 385 | under this License. Any attempt otherwise to propagate or modify it is void, and 386 | will automatically terminate your rights under this License (including any 387 | patent licenses granted under the third paragraph of section 11). 388 | 389 | However, if you cease all violation of this License, then your license from a 390 | particular copyright holder is reinstated (a) provisionally, unless and until 391 | the copyright holder explicitly and finally terminates your license, and (b) 392 | permanently, if the copyright holder fails to notify you of the violation by 393 | some reasonable means prior to 60 days after the cessation. 394 | 395 | Moreover, your license from a particular copyright holder is reinstated 396 | permanently if the copyright holder notifies you of the violation by some 397 | reasonable means, this is the first time you have received notice of violation 398 | of this License (for any work) from that copyright holder, and you cure the 399 | violation prior to 30 days after your receipt of the notice. 400 | 401 | Termination of your rights under this section does not terminate the licenses of 402 | parties who have received copies or rights from you under this License. If your 403 | rights have been terminated and not permanently reinstated, you do not qualify 404 | to receive new licenses for the same material under section 10. 405 | 406 | 9. Acceptance Not Required for Having Copies. 407 | 408 | You are not required to accept this License in order to receive or run a copy of 409 | the Program. Ancillary propagation of a covered work occurring solely as a 410 | consequence of using peer-to-peer transmission to receive a copy likewise does 411 | not require acceptance. However, nothing other than this License grants you 412 | permission to propagate or modify any covered work. These actions infringe 413 | copyright if you do not accept this License. Therefore, by modifying or 414 | propagating a covered work, you indicate your acceptance of this License to do 415 | so. 416 | 417 | 10. Automatic Licensing of Downstream Recipients. 418 | 419 | Each time you convey a covered work, the recipient automatically receives a 420 | license from the original licensors, to run, modify and propagate that work, 421 | subject to this License. You are not responsible for enforcing compliance by 422 | third parties with this License. 423 | 424 | An "entity transaction" is a transaction transferring control of an 425 | organization, or substantially all assets of one, or subdividing an 426 | organization, or merging organizations. If propagation of a covered work results 427 | from an entity transaction, each party to that transaction who receives a copy 428 | of the work also receives whatever licenses to the work the party's predecessor 429 | in interest had or could give under the previous paragraph, plus a right to 430 | possession of the Corresponding Source of the work from the predecessor in 431 | interest, if the predecessor has it or can get it with reasonable efforts. 432 | 433 | You may not impose any further restrictions on the exercise of the rights 434 | granted or affirmed under this License. For example, you may not impose a 435 | license fee, royalty, or other charge for exercise of rights granted under this 436 | License, and you may not initiate litigation (including a cross-claim or 437 | counterclaim in a lawsuit) alleging that any patent claim is infringed by 438 | making, using, selling, offering for sale, or importing the Program or any 439 | portion of it. 440 | 441 | 11. Patents. 442 | 443 | A "contributor" is a copyright holder who authorizes use under this License of 444 | the Program or a work on which the Program is based. The work thus licensed is 445 | called the contributor's "contributor version". 446 | 447 | A contributor's "essential patent claims" are all patent claims owned or 448 | controlled by the contributor, whether already acquired or hereafter acquired, 449 | that would be infringed by some manner, permitted by this License, of making, 450 | using, or selling its contributor version, but do not include claims that would 451 | be infringed only as a consequence of further modification of the contributor 452 | version. For purposes of this definition, "control" includes the right to grant 453 | patent sublicenses in a manner consistent with the requirements of this License. 454 | 455 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent 456 | license under the contributor's essential patent claims, to make, use, sell, 457 | offer for sale, import and otherwise run, modify and propagate the contents of 458 | its contributor version. 459 | 460 | In the following three paragraphs, a "patent license" is any express agreement 461 | or commitment, however denominated, not to enforce a patent (such as an express 462 | permission to practice a patent or covenant not to sue for patent infringement). 463 | To "grant" such a patent license to a party means to make such an agreement or 464 | commitment not to enforce a patent against the party. 465 | 466 | If you convey a covered work, knowingly relying on a patent license, and the 467 | Corresponding Source of the work is not available for anyone to copy, free of 468 | charge and under the terms of this License, through a publicly available network 469 | server or other readily accessible means, then you must either (1) cause the 470 | Corresponding Source to be so available, or (2) arrange to deprive yourself of 471 | the benefit of the patent license for this particular work, or (3) arrange, in a 472 | manner consistent with the requirements of this License, to extend the patent 473 | license to downstream recipients. "Knowingly relying" means you have actual 474 | knowledge that, but for the patent license, your conveying the covered work in a 475 | country, or your recipient's use of the covered work in a country, would 476 | infringe one or more identifiable patents in that country that you have reason 477 | to believe are valid. 478 | 479 | If, pursuant to or in connection with a single transaction or arrangement, you 480 | convey, or propagate by procuring conveyance of, a covered work, and grant a 481 | patent license to some of the parties receiving the covered work authorizing 482 | them to use, propagate, modify or convey a specific copy of the covered work, 483 | then the patent license you grant is automatically extended to all recipients of 484 | the covered work and works based on it. 485 | 486 | A patent license is "discriminatory" if it does not include within the scope of 487 | its coverage, prohibits the exercise of, or is conditioned on the non-exercise 488 | of one or more of the rights that are specifically granted under this License. 489 | You may not convey a covered work if you are a party to an arrangement with a 490 | third party that is in the business of distributing software, under which you 491 | make payment to the third party based on the extent of your activity of 492 | conveying the work, and under which the third party grants, to any of the 493 | parties who would receive the covered work from you, a discriminatory patent 494 | license (a) in connection with copies of the covered work conveyed by you (or 495 | copies made from those copies), or (b) primarily for and in connection with 496 | specific products or compilations that contain the covered work, unless you 497 | entered into that arrangement, or that patent license was granted, prior to 28 498 | March 2007. 499 | 500 | Nothing in this License shall be construed as excluding or limiting any implied 501 | license or other defenses to infringement that may otherwise be available to you 502 | under applicable patent law. 503 | 504 | 12. No Surrender of Others' Freedom. 505 | 506 | If conditions are imposed on you (whether by court order, agreement or 507 | otherwise) that contradict the conditions of this License, they do not excuse 508 | you from the conditions of this License. If you cannot convey a covered work so 509 | as to satisfy simultaneously your obligations under this License and any other 510 | pertinent obligations, then as a consequence you may not convey it at all. For 511 | example, if you agree to terms that obligate you to collect a royalty for 512 | further conveying from those to whom you convey the Program, the only way you 513 | could satisfy both those terms and this License would be to refrain entirely 514 | from conveying the Program. 515 | 516 | 13. Use with the GNU Affero General Public License. 517 | 518 | Notwithstanding any other provision of this License, you have permission to link 519 | or combine any covered work with a work licensed under version 3 of the GNU 520 | Affero General Public License into a single combined work, and to convey the 521 | resulting work. The terms of this License will continue to apply to the part 522 | which is the covered work, but the special requirements of the GNU Affero 523 | General Public License, section 13, concerning interaction through a network 524 | will apply to the combination as such. 525 | 526 | 14. Revised Versions of this License. 527 | 528 | The Free Software Foundation may publish revised and/or new versions of the GNU 529 | General Public License from time to time. Such new versions will be similar in 530 | spirit to the present version, but may differ in detail to address new problems 531 | or concerns. 532 | 533 | Each version is given a distinguishing version number. If the Program specifies 534 | that a certain numbered version of the GNU General Public License "or any later 535 | version" applies to it, you have the option of following the terms and 536 | conditions either of that numbered version or of any later version published by 537 | the Free Software Foundation. If the Program does not specify a version number 538 | of the GNU General Public License, you may choose any version ever published by 539 | the Free Software Foundation. 540 | 541 | If the Program specifies that a proxy can decide which future versions of the 542 | GNU General Public License can be used, that proxy's public statement of 543 | acceptance of a version permanently authorizes you to choose that version for 544 | the Program. 545 | 546 | Later license versions may give you additional or different permissions. 547 | However, no additional obligations are imposed on any author or copyright holder 548 | as a result of your choosing to follow a later version. 549 | 550 | 15. Disclaimer of Warranty. 551 | 552 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 553 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER 554 | PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER 555 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 556 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 557 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 558 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 559 | 560 | 16. Limitation of Liability. 561 | 562 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 563 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 564 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 565 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE 566 | THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED 567 | INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE 568 | PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY 569 | HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 570 | 571 | 17. Interpretation of Sections 15 and 16. 572 | 573 | If the disclaimer of warranty and limitation of liability provided above cannot 574 | be given local legal effect according to their terms, reviewing courts shall 575 | apply local law that most closely approximates an absolute waiver of all civil 576 | liability in connection with the Program, unless a warranty or assumption of 577 | liability accompanies a copy of the Program in return for a fee. 578 | 579 | END OF TERMS AND CONDITIONS 580 | 581 | How to Apply These Terms to Your New Programs 582 | 583 | If you develop a new program, and you want it to be of the greatest possible use 584 | to the public, the best way to achieve this is to make it free software which 585 | everyone can redistribute and change under these terms. 586 | 587 | To do so, attach the following notices to the program. It is safest to attach 588 | them to the start of each source file to most effectively state the exclusion of 589 | warranty; and each file should have at least the "copyright" line and a pointer 590 | to where the full notice is found. 591 | 592 | 593 | Copyright (C) 594 | 595 | This program is free software: you can redistribute it and/or modify 596 | it under the terms of the GNU General Public License as published by 597 | the Free Software Foundation, either version 3 of the License, or 598 | (at your option) any later version. 599 | 600 | This program is distributed in the hope that it will be useful, 601 | but WITHOUT ANY WARRANTY; without even the implied warranty of 602 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 603 | GNU General Public License for more details. 604 | 605 | You should have received a copy of the GNU General Public License 606 | along with this program. If not, see . 607 | 608 | Also add information on how to contact you by electronic and paper mail. 609 | 610 | If the program does terminal interaction, make it output a short notice like 611 | this when it starts in an interactive mode: 612 | 613 | IgnoreBoy Copyright (C) 2024 Cameron Leslie 614 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 615 | This is free software, and you are welcome to redistribute it 616 | under certain conditions; type `show c' for details. 617 | 618 | The hypothetical commands `show w' and`show c' should show the appropriate parts 619 | of the General Public License. Of course, your program's commands might be 620 | different; for a GUI interface, you would use an "about box". 621 | 622 | You should also get your employer (if you work as a programmer) or school, if 623 | any, to sign a "copyright disclaimer" for the program, if necessary. For more 624 | information on this, and how to apply and follow the GNU GPL, see 625 | . 626 | 627 | The GNU General Public License does not permit incorporating your program into 628 | proprietary programs. If your program is a subroutine library, you may consider 629 | it more useful to permit linking proprietary applications with the library. If 630 | this is what you want to do, use the GNU Lesser General Public License instead 631 | of this License. But first, please read 632 | . 633 | --------------------------------------------------------------------------------