├── .gitattributes ├── docs ├── gimp_screenshot1.png ├── gimp_screenshot2.png ├── gimp_screenshot3.png ├── spriteatlas_extend.png └── spriteatlas_summary.png ├── example └── example_sprites.xcf ├── GIMP 2 └── lib │ └── gimp │ └── 2.0 │ └── plug-ins │ ├── create_spritesheet.py │ └── create_spriteatlas.py ├── readme.md └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /docs/gimp_screenshot1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BdR76/GimpSpriteAtlas/HEAD/docs/gimp_screenshot1.png -------------------------------------------------------------------------------- /docs/gimp_screenshot2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BdR76/GimpSpriteAtlas/HEAD/docs/gimp_screenshot2.png -------------------------------------------------------------------------------- /docs/gimp_screenshot3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BdR76/GimpSpriteAtlas/HEAD/docs/gimp_screenshot3.png -------------------------------------------------------------------------------- /docs/spriteatlas_extend.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BdR76/GimpSpriteAtlas/HEAD/docs/spriteatlas_extend.png -------------------------------------------------------------------------------- /docs/spriteatlas_summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BdR76/GimpSpriteAtlas/HEAD/docs/spriteatlas_summary.png -------------------------------------------------------------------------------- /example/example_sprites.xcf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BdR76/GimpSpriteAtlas/HEAD/example/example_sprites.xcf -------------------------------------------------------------------------------- /GIMP 2/lib/gimp/2.0/plug-ins/create_spritesheet.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # License: Public Domain - https://creativecommons.org/share-your-work/public-domain/cc0/ 3 | # https://github.com/Spydarlee/scripts/tree/master/GIMP 4 | # 5 | # Create a sprite sheet consisting of uniformly-sized image frames, 6 | # current image size will be the spritesheet frame sizes 7 | # 8 | # 2022-04-30 script updated by BdR 9 | 10 | from gimpfu import * 11 | import math 12 | 13 | def create_spritesheet(image, tileLayout, spriteCenter): 14 | 15 | # Grab all the layers from the original image, each one of which will become an animation frame 16 | layers = image.layers 17 | numLayers = len(layers) 18 | 19 | # Deterime how many rows and columns we need for each of our layers/animation frames 20 | if (tileLayout == 1): 21 | numCols = int(math.ceil(math.sqrt(numLayers))) 22 | numRows = int(math.ceil(1.0 * numLayers / numCols)) 23 | else: 24 | numRows = 1 if (tileLayout == 2) else numLayers # Single row 25 | numCols = 1 if (tileLayout == 3) else numLayers # Single column 26 | 27 | # Determine frame sizes = current image size 28 | frameWidth = image.width 29 | frameHeight = image.height 30 | 31 | # Determine new image size, based on the number of rows and columns 32 | newImgWidth = frameWidth * numCols 33 | newImgHeight = frameHeight * numRows 34 | 35 | # Create a new image and a single layer that fills the entire canvas 36 | newImage = gimp.Image(newImgWidth, newImgHeight, RGB) 37 | newLayer = gimp.Layer(newImage, "Spritesheet", newImgWidth, newImgHeight, RGBA_IMAGE, 100, NORMAL_MODE) 38 | newImage.add_layer(newLayer, 1) 39 | 40 | # Select image size to ensure uniformly-sized frames (i.e. when original layer is larger than image then "crop" to image size) 41 | pdb.gimp_selection_all(image) 42 | 43 | # go through all layers (GIMP Layers used to be in the reverse order, not anymore) 44 | layerIndex = 0 45 | 46 | # Loop over our spritesheet grid filling each one row at a time 47 | for y in xrange(0, numRows): 48 | for x in xrange(0, numCols): 49 | # check layerIndex because it's possible there are less layers than grid positions 50 | # i.e. cannot always fill out entire grid, last tile positions will just be empty 51 | if layerIndex < numLayers: 52 | # Copy the layer's contents and paste it into a "floating" layer in the new image 53 | pdb.gimp_edit_copy(layers[layerIndex]) 54 | floatingLayer = pdb.gimp_edit_paste(newLayer, TRUE) 55 | 56 | # Arrange frames as tiles from top-left to bottom-right 57 | xPos = x * frameWidth 58 | yPos = y * frameHeight 59 | 60 | # Floating layer defaults to center, get current offset and corrent for desired position 61 | xOffset, yOffset = floatingLayer.offsets 62 | xOffset = xPos - xOffset 63 | yOffset = yPos - yOffset 64 | 65 | # center if needed (i.e. when layer size is smaller than frame size) 66 | if spriteCenter and (floatingLayer.width < frameWidth): 67 | xOffset += (frameWidth - floatingLayer.width) / 2 68 | if spriteCenter and (floatingLayer.height < frameHeight): 69 | yOffset += (frameHeight - floatingLayer.height) / 2 70 | 71 | # Move the floating layer into the correct position 72 | pdb.gimp_layer_translate(floatingLayer, xOffset, yOffset) 73 | 74 | # Move to the next layer index 75 | layerIndex = layerIndex + 1 76 | 77 | # Merge the last floating layer into our final 'Spritesheet' layer 78 | pdb.gimp_image_merge_visible_layers(newImage, 0) 79 | 80 | # Create and show a new image window for our spritesheet 81 | gimp.Display(newImage) 82 | gimp.displays_flush() 83 | 84 | # Register the plugin with Gimp so it appears in the filters menu 85 | register( 86 | "python_fu_create_spritesheet", 87 | "Creates a new spritesheet image, from the layers of the current image.", 88 | "Creates a new spritesheet image, from the layers of the current image.", 89 | "Karn Bianco", 90 | "Karn Bianco", 91 | "2022", 92 | "Create Spritesheet", 93 | "*", 94 | [ 95 | (PF_IMAGE, "image", "Input image:", None), 96 | (PF_RADIO, "tileLayout", "Spritesheet layout:", 1, (("Grid", 1), ("Single row", 2), ("Single column", 3))), 97 | (PF_BOOL, "spriteCenter", "Center sprite in frame\n(when sprites are smaller)", TRUE) 98 | ], 99 | [], 100 | create_spritesheet, menu="/Filters/Animation/") 101 | 102 | main() 103 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | GIMP SpriteAtlas 2 | ================ 3 | 4 | GIMP SpriteAtlas is a plug-in to compile 5 | sprite textures for use in games and websites. 6 | 7 | The plug-in takes several smaller images and compiles them into a single image. 8 | It uses a packing algorithm to use as little space as possible in the final 9 | texture. And it exports a JSON, Atlas, XML or CSS file with the sprite names and 10 | their coordinates within the compiled texture. 11 | 12 | ![GIMP Sprite Atlas plug-in summary](/docs/spriteatlas_summary.png?raw=true "GIMP Sprite Atlas plug-in summary") 13 | 14 | How to install 15 | ------------- 16 | First install [GIMP](https://www.gimp.org/), then place the Python script file 17 | [create_spriteatlas.py](/GIMP%202/lib/gimp/2.0/plug-ins) in the GIMP folder, 18 | typically under program files: 19 | 20 | Windows (all users) 21 | %PROGRAMFILES%\GIMP 2\lib\gimp\2.0\plug-ins\ 22 | Windows (single user) 23 | %USERPROFILE%\AppData\Roaming\GIMP\2.10\plug-ins\ 24 | 25 | Linux 26 | ~/.config/GIMP/2.10/plug-ins/ 27 | 28 | After you've copied the file in this directory, open GIMP and the plug-in is 29 | available in the menu: 30 | 31 | Filters -> Animation -> Sprite Atlas 32 | 33 | How to use it 34 | ------------- 35 | 36 | 1. Open GIMP 37 | 2. Open your images as layers (Ctrl + Alt + O) 38 | 3. Start the plug-in from `Filters > Animation > Sprite Atlas` 39 | 4. Select an export folder 40 | 5. Press OK to generate the sprite texture 41 | 42 | So first open all your images as layers. You can do this from the menu 43 | `Open As Layers` (Ctrl + Alt + O), select all your files and click `Open`. 44 | Alternatively, you can first open one image (preferably the largest one), and 45 | then drag and drop all the remaining images onto the layers window. 46 | 47 | Note: opening images as layers can be remarkably slow 48 | (see [issue report](https://gitlab.gnome.org/GNOME/gimp/-/issues/8200)). 49 | 50 | ![GIMP Sprite Atlas plug-in how to use 1](/docs/gimp_screenshot1.png?raw=true "GIMP Sprite Atlas plug-in how to use 1") 51 | 52 | Then go to the menu `Filters > Animation > Sprite Atlas` to open the GIMP 53 | SpriteAtlas plug-in, you'll see the following dialog. 54 | 55 | ![GIMP Sprite Atlas plug-in how to use 1](/docs/gimp_screenshot2.png?raw=true "GIMP Sprite Atlas plug-in how to use 2") 56 | 57 | Make sure to select an export folder, this is where the output image and 58 | coordinates datafile will be exported to. The default export folder is 59 | `\tmp\`, if you don't change this to an actual existing folder you will get 60 | the following error message: 61 | 62 | RuntimeError: Could not open '\tmp\sprites.png' for writing: No such file or directory 63 | 64 | Press OK to generate the spriteatlas and export the sprite texture and sprite 65 | metadata file. 66 | 67 | ![GIMP Sprite Atlas plug-in how to use 1](/docs/gimp_screenshot3.png?raw=true "GIMP Sprite Atlas plug-in how to use 3") 68 | 69 | Options 70 | ------- 71 | 72 | **Export filename**: Export filename for both the texture image and the 73 | coordinates file, for example, set it to `sprites123` and the output files 74 | will be named `sprites123.png` and `sprites123.json`. 75 | 76 | **Export folder**: Output folder for both the texture image and the 77 | coordinates file. 78 | 79 | **Export filetype** 80 | 81 | * JSON TexturePacker-array, compatible with the TexturePacker format 82 | * JSON TexturePacker hash, compatible with the TexturePacker format 83 | * libGDX TextureAtlas, .atlas text file 84 | * CSS sprites, can be used for html and websites 85 | * XML, plain xml format 86 | 87 | The TexturePacker-array/hash output is the preferred format for use with 88 | [Phaser.io](https://phaser.io/). If you need any other format, you can edit 89 | the Python code and add a custom function or you can post an 90 | [issue here](https://github.com/BdR76/GIMPSpriteAtlas/issues). 91 | 92 | **Pad one pixel between sprites** separate all sprites by at least one pixel, 93 | recommended to avoid *texture bleeding*. If a sprite texture contains sprites 94 | that are right next to each other, in some graphics engines the 95 | texture tiles can "overflow" and pick up parts of neighboring tiles. 96 | 97 | **Extending sprites** the plug-in can automatically extend the edges on some 98 | sprites Up Down Left and/or Right. This can be useful to make tiles in a 99 | tilemap align seemlessly, so without any lines between tiles. For example if 100 | you want to extend a sprite **D**own and **R**right you can add `[ext=DR]` to 101 | the name like this 102 | 103 | mytile01 [ext=dr].png 104 | 105 | In the compiled texture, the plug-in will extend this sprite by one pixel down 106 | and one pixel right, meaning it will copy the bottom row pixels and the 107 | right-most column of pixels of that sprite. 108 | 109 | ![GIMP Sprite Atlas plug-in extend edges](/docs/spriteatlas_extend.png?raw=true "GIMP Sprite Atlas plug-in extend edges") 110 | 111 | Sprite Sheet 112 | ------------ 113 | This repository also includes a `create_spritesheet.py` plugin, for the sake 114 | of completeness. It creates a sprite sheet where all the sprites are the same 115 | size in a simple grid layout. This doesn't require a coordinates file. 116 | The tile size will be the width and height of the original image. 117 | 118 | It is based on a [plug-in by Spydarlee](https://github.com/Spydarlee/scripts/tree/master/GIMP) 119 | but with some bugfixes and additional options 120 | 121 | Trouble shooting / Known issues 122 | ------------------------------- 123 | * Opening images as layers is remarkably slow in GIMP (see 124 | [issue report](https://gitlab.gnome.org/GNOME/gimp/-/issues/8200)). 125 | Once you've created a sprite texture, it's best to also save the original 126 | image with the layers as a `.xcf`. If you want to make changes to the texture 127 | at a later time (add/remove sprites) then you can more quickly open the `.xcf` 128 | instead of having to re-add all the images as layers again. 129 | 130 | * You can use this plug-in create any custom coordinates format or custom 131 | preprocessing by editing the Python file. Alternatively you can also create 132 | sprite atlas/textures using the 133 | [TexturePacker Online (free)](https://www.codeandweb.com/tp-online) 134 | or [Leshy SpriteSheet Tool](https://www.leshylabs.com/apps/sstool/) 135 | 136 | History 137 | ------- 138 | 26-may-2022 - v0.1 first release 139 | 14-oct-2023 - v0.2 json bugfix 140 | 09-mrt-2024 - v0.3 fix pad-pixel option 141 | 142 | BdR©2023 Free to use - send questions or comments: Bas de Reuver - bdr1976@gmail.com 143 | -------------------------------------------------------------------------------- /GIMP 2/lib/gimp/2.0/plug-ins/create_spriteatlas.py: -------------------------------------------------------------------------------- 1 | # GIMP plug-in Create SpriteAtlas 2 | # Take layers as images and compile into spriteatlas 3 | # including a coordinates file in json/atlas/css/xml format 4 | # uses rectangle packing algorithm 5 | # 6 | # https://github.com/BdR76/GimpSpriteAtlas/ 7 | 8 | from gimpfu import * 9 | import math 10 | import os 11 | 12 | layer_rects = [] 13 | spaces = [] 14 | pixel_space = 1 15 | ATLAS_PLUGIN_VERSION = "v0.3" 16 | 17 | # empty space 18 | class spaceobj(object): 19 | def __init__(self, x, y, width, height): 20 | self.x = x 21 | self.y = y 22 | self.width = width 23 | self.height = height 24 | def __cmp__(self, other): 25 | return (self.width * self.height < other.width * other.height) 26 | def __lt__(self, other): 27 | return (self.width * self.height < other.width * other.height) 28 | 29 | # image layer metadata 30 | class imgRect(object): 31 | def __init__(self, n, w, h, i): 32 | # process stuff 33 | if n.endswith(('.png', '.jpg')): 34 | n = os.path.splitext(n)[0] 35 | # set parameters 36 | self.name = n 37 | self.width = w 38 | self.height = h 39 | self.index = i 40 | # extra stuff 41 | self.pack_x = 0 42 | self.pack_y = 0 43 | self.ext_up = 0 44 | self.ext_down = 0 45 | self.ext_left = 0 46 | self.ext_right = 0 47 | # determinate name and optional extend direction, example "green_pipe [ext=UD].png" -> name="green_pipe" ext_up=1 ext_down=1 48 | pos1 = n.find('[') 49 | pos2 = n.find(']') 50 | if pos1 >= 0 and pos2 >= 0 and pos1 < pos2: 51 | self.name = n[0:pos1].strip() 52 | ex = n[pos1+1:pos2].strip().lower() 53 | if ex.startswith("ext="): 54 | ex = ex[4:] 55 | self.ext_up = 1 if "u" in ex else 0 56 | self.ext_down = 1 if "d" in ex else 0 57 | self.ext_left = 1 if "l" in ex else 0 58 | self.ext_right = 1 if "r" in ex else 0 59 | # total width and height, including extruding parts 60 | self.tot_width = self.width + self.ext_left + self.ext_right 61 | self.tot_height = self.height + self.ext_up + self.ext_down 62 | def __cmp__(self, other): 63 | return (self.height < other.height) 64 | def __lt__(self, other): 65 | return (self.height < other.height) 66 | 67 | def prepare_layers_metadata(layers): 68 | # Collect metadata from all layers as custom list 69 | idx = 0 70 | area = 0 71 | maxWidth = 0 72 | for lyr in layers: 73 | # layer image metadata 74 | n = lyr.name 75 | w = lyr.width 76 | h = lyr.height 77 | newrec = imgRect(n, w, h, idx) 78 | layer_rects.append(newrec) 79 | # calculate total layer area and maximum layer width 80 | area += (newrec.tot_width + pixel_space) * (newrec.tot_height + pixel_space); 81 | maxWidth = max(newrec.tot_width + pixel_space, maxWidth + pixel_space) 82 | idx = idx + 1 83 | 84 | # sort the layer data for packing by height, descending 85 | layer_rects.sort(reverse=True); 86 | 87 | # aim for a square-ish resulting container, 88 | # slightly adjusted for sub-100% space utilization 89 | startWidth = max(math.ceil(math.sqrt(area / 0.95)), maxWidth) 90 | 91 | # also initialise list of spaces, start with a single empty space based on average layer size 92 | spaces.append(spaceobj(0, 0, startWidth, (startWidth+startWidth))) 93 | return 94 | 95 | def calc_layers_packing(): 96 | # packing algorithm, explanation and code example by Volodymyr Agafonkin 97 | # https://observablehq.com/@mourner/simple-rectangle-packing 98 | for box in layer_rects: 99 | 100 | # look through spaces backwards so that we check smaller spaces first 101 | i = len(spaces)-1 102 | while i >= 0: 103 | 104 | space = spaces[i]; 105 | 106 | # look for empty spaces that can accommodate the current box 107 | if (box.tot_width > space.width or box.tot_height > space.height): 108 | i -= 1; 109 | continue; 110 | 111 | # found the space; add the box to its top-left corner 112 | # |-------|-------| 113 | # | box | | 114 | # |_______| | 115 | # | space | 116 | # |_______________| 117 | box.pack_x = space.x + box.ext_left 118 | box.pack_y = space.y + box.ext_up 119 | 120 | if (box.tot_width + pixel_space == space.width and box.tot_height + pixel_space == space.height): 121 | # space matches the box exactly; remove it 122 | spaces.remove(space) 123 | 124 | elif (box.tot_height + pixel_space == space.height): 125 | # space matches the box height; update it accordingly 126 | # |-------|---------------| 127 | # | box | updated space | 128 | # |_______|_______________| 129 | spaces[i].x += (box.tot_width + pixel_space); 130 | spaces[i].width -= (box.tot_width + pixel_space); 131 | elif (box.tot_width + pixel_space == space.width): 132 | # space matches the box width; update it accordingly 133 | # |---------------| 134 | # | box | 135 | # |_______________| 136 | # | updated space | 137 | # |_______________| 138 | spaces[i].y += (box.tot_height + pixel_space); 139 | spaces[i].height -= (box.tot_height + pixel_space); 140 | else: 141 | # otherwise the box splits the space into two spaces 142 | # |-------|-----------| 143 | # | box | new space | 144 | # |_______|___________| 145 | # | updated space | 146 | # |___________________| 147 | spaces.append(spaceobj(space.x + box.tot_width + pixel_space, space.y, space.width - box.tot_width - pixel_space, box.tot_height + pixel_space)); 148 | spaces[i].y += (box.tot_height + pixel_space); 149 | spaces[i].height -= (box.tot_height + pixel_space); 150 | i -= 1; 151 | break; 152 | return 153 | 154 | def extrude_edges_2(img, lyr, x, y, w, h, xgoal, ygoal): 155 | # render output atlas based on current layer coordinates 156 | pdb.gimp_image_select_rectangle(img, CHANNEL_OP_REPLACE, x, y, w, h) 157 | pdb.gimp_edit_copy(lyr) 158 | floatselection = pdb.gimp_edit_paste(lyr, FALSE) 159 | 160 | # Floating layer defaults to center, get current offset and corrent for desired position 161 | xOffset, yOffset = floatselection.offsets 162 | xOffset = xgoal - xOffset 163 | yOffset = ygoal - yOffset 164 | 165 | # Move the floating layer into the correct position 166 | pdb.gimp_layer_translate(floatselection, xOffset, yOffset) 167 | pdb.gimp_floating_sel_anchor(floatselection) 168 | 169 | def extrude_edges(img, lyr, x, y, w, h): 170 | # render output atlas based on current layer coordinates 171 | pdb.gimp_image_select_rectangle(img, CHANNEL_OP_REPLACE, x, y, w, 1) 172 | pdb.gimp_edit_copy(lyr) 173 | floatselection = pdb.gimp_edit_paste(lyr, FALSE) 174 | 175 | # Floating layer defaults to center, get current offset and corrent for desired position 176 | xOffset, yOffset = floatselection.offsets 177 | xOffset = x - xOffset 178 | yOffset = y - 1 - yOffset 179 | 180 | # Move the floating layer into the correct position 181 | pdb.gimp_layer_translate(floatselection, xOffset, yOffset) 182 | 183 | def render_spriteatlas(layers, filename, filetag): 184 | # render output atlas based on current layer coordinates 185 | 186 | # determine total width, height 187 | img_w = 0 188 | img_h = 0 189 | for obj in layer_rects: 190 | w = obj.pack_x + obj.width + obj.ext_right 191 | h = obj.pack_y + obj.height + obj.ext_up 192 | if w > img_w: 193 | img_w = w 194 | if h > img_h: 195 | img_h = h 196 | 197 | # create new image 198 | imgAtlas = gimp.Image(img_w, img_h, RGB) 199 | newLayer = gimp.Layer(imgAtlas, filetag, img_w, img_h, RGBA_IMAGE, 100, NORMAL_MODE) 200 | imgAtlas.add_layer(newLayer, 1) 201 | 202 | # copy all layers to new positions 203 | for obj in layer_rects: 204 | 205 | # Copy the layer's contents and paste it into a "floating" layer in the new image 206 | pdb.gimp_edit_copy(layers[obj.index]) 207 | floatingLayer = pdb.gimp_edit_paste(newLayer, FALSE) 208 | 209 | # Floating layer defaults to center, get current offset and corrent for desired position 210 | xOffset, yOffset = floatingLayer.offsets 211 | xOffset = obj.pack_x - xOffset 212 | yOffset = obj.pack_y - yOffset 213 | 214 | # Move the floating layer into the correct position 215 | pdb.gimp_layer_translate(floatingLayer, xOffset, yOffset) 216 | # Anchor the floating selection before making another selection 217 | pdb.gimp_floating_sel_anchor(floatingLayer) 218 | 219 | # extrude up, down, left, right 220 | if obj.ext_up == 1: # up 221 | extrude_edges_2(imgAtlas, newLayer, obj.pack_x, obj.pack_y, obj.width, 1, obj.pack_x, obj.pack_y-1) 222 | if obj.ext_down == 1: # down 223 | extrude_edges_2(imgAtlas, newLayer, obj.pack_x, obj.pack_y+obj.height-1, obj.width, 1, obj.pack_x, obj.pack_y+obj.height) 224 | if obj.ext_left == 1: # left 225 | extrude_edges_2(imgAtlas, newLayer, obj.pack_x, obj.pack_y, 1, obj.height, obj.pack_x-1, obj.pack_y) 226 | if obj.ext_right == 1: # right 227 | extrude_edges_2(imgAtlas, newLayer, obj.pack_x+obj.width-1, obj.pack_y, 1, obj.height, obj.pack_x+obj.width, obj.pack_y) 228 | 229 | #pdb.gimp_drawable_set_pixel(floatingLayer, 10, 10, 4, [240, 0, 0, 255]) 230 | #pdb.gimp_drawable_set_pixel(floatingLayer, 11, 10, 4, [240, 0, 240, 255]) 231 | #pdb.gimp_drawable_set_pixel(floatingLayer, 12, 10, 4, [240, 240, 0, 255]) 232 | 233 | # Merge the last floating layer into our final 'Spritesheet' layer 234 | pdb.gimp_image_merge_visible_layers(imgAtlas, 0) 235 | 236 | # look through spaces backwards so that we check smaller spaces first 237 | horzmark = True 238 | xmark = img_w 239 | ymark = img_h 240 | spaces.sort(); # sort smallest first 241 | 242 | idx = 0 243 | for sp in spaces: 244 | # adjust space for out-of-bounds of final image size 245 | if (sp.x + sp.width > img_w): 246 | sp.width -= (sp.x + sp.width - img_w) 247 | if (sp.y + sp.height > img_h): 248 | sp.height -= (sp.y + sp.height - img_h) 249 | # check if watermark fits inside space 250 | idx += 1 251 | if (sp.width >= 54 and sp.height >= 8) or (sp.width >= 8 and sp.height >= 54): 252 | xmark = sp.x 253 | ymark = sp.y 254 | horzmark = (sp.width >= 54) 255 | break 256 | 257 | #pdb.gimp_message_set_handler(ERROR_CONSOLE) 258 | #pdb.gimp_message("xmark=%d ymark=%d" % (xmark, ymark)) 259 | 260 | # add small watermark 261 | drwLayer = pdb.gimp_image_active_drawable(imgAtlas) 262 | pixelwm = [7, 5, 6, 0, 7, 0, 55, 65, 50, 1, 119, 80, 119, 3, 64, 0, 84, 119, 97, 0, 7, 3, 112, 119, 97, 0, 103, 112, 1, 119, 49, 96, 7, 7, 21, 112, 70, 3, 118, 81, 119, 1, 16, 119, 68, 0, 54, 35, 118, 0, 4, 7, 1] 263 | for wm in pixelwm: 264 | for b in range(0, 7): 265 | if wm & (1 << b): # bitwise-and 266 | xplot = xmark if horzmark else xmark+8-b 267 | yplot = ymark+b if horzmark else ymark 268 | if (xplot < img_w and yplot < img_h): 269 | pdb.gimp_drawable_set_pixel(drwLayer, xplot, yplot, 4, [255, 255, 255, 255]) # xposition, yposition, nr-channels-per-pixel(3 or 4), [r,g,b] 270 | #rectimg.putpixel((xplot, yplot), (255,0,255)) 271 | if horzmark: 272 | xmark += 1 273 | else: 274 | ymark += 1 275 | 276 | # save as png 277 | outputname = '%s.png' % (filename) 278 | pdb.gimp_file_save(imgAtlas, imgAtlas.active_layer, outputname, outputname) 279 | 280 | # Create and show a new image window for our spritesheet 281 | gimp.Display(imgAtlas) 282 | gimp.displays_flush() 283 | return img_w, img_h 284 | 285 | def write_spriteatlas_jsonarray(filename, filetag, sizex, sizey): 286 | stroutput = "{\n\t\"frames\":[" 287 | 288 | # insert all sprite metadata 289 | for obj in layer_rects: 290 | stroutput += '\n\t\t{"filename":"%s","frame":{"x":%d,"y":%d,"w":%d,"h":%d},"rotated":"false","trimmed":"false",' % (obj.name, obj.pack_x, obj.pack_y, obj.width, obj.height) 291 | stroutput += '"spriteSourceSize":{"x":0,"y":0,"w":%d,"h":%d},' % (obj.width, obj.height) 292 | stroutput += '"sourceSize":{"w":%d,"h":%d}},' % (obj.width, obj.height) 293 | 294 | # remove last comma 295 | stroutput = stroutput[:-1] 296 | 297 | # meta data 298 | stroutput += "\n\t],\n" 299 | stroutput += "\t\"meta\":{\n" 300 | stroutput += "\t\t\"app\":\"https://github.com/BdR76/GimpSpriteAtlas/\",\n" 301 | stroutput += "\t\t\"version\":\"GIMP SpriteAtlas plug-in %s\",\n" % ATLAS_PLUGIN_VERSION 302 | stroutput += "\t\t\"author\":\"Bas de Reuver\",\n" 303 | stroutput += ("\t\t\"image\":\"%s.png\",\n" % filetag) 304 | stroutput += ("\t\t\"size\":{\"w\":%d,\"h\":%d},\n" % (sizex, sizey)) 305 | stroutput += "\t\t\"scale\":1\n" 306 | stroutput += "\t}\n" 307 | stroutput += "}" 308 | 309 | # export filename 310 | outputname = '%s.json' % (filename) 311 | 312 | # export coordinate variables to textfile 313 | outputfile = file(outputname, 'w') 314 | outputfile.write(stroutput) 315 | outputfile.close() 316 | return 317 | 318 | def write_spriteatlas_jsonhash(filename, filetag, img_w, img_h): 319 | stroutput = "{\n\t\"frames\":{" 320 | 321 | # insert all sprite metadata 322 | for obj in layer_rects: 323 | stroutput += '\n\t\t"%s":{"frame":{"x":%d,"y":%d,"w":%d,"h":%d},"rotated":"false","trimmed":"false",' % (obj.name, obj.pack_x, obj.pack_y, obj.width, obj.height) 324 | stroutput += '"spriteSourceSize":{"x":0,"y":0,"w":%d,"h":%d},' % (obj.width, obj.height) 325 | stroutput += '"sourceSize":{"w":%d,"h":%d}},' % (obj.width, obj.height) 326 | 327 | # remove last comma 328 | stroutput = stroutput[:-1] 329 | 330 | # meta data 331 | stroutput += "\n\t},\n" 332 | stroutput += "\t\"meta\":{\n" 333 | stroutput += "\t\t\"app\":\"https://github.com/BdR76/GimpSpriteAtlas/\",\n" 334 | stroutput += "\t\t\"version\":\"GIMP SpriteAtlas plug-in %s\",\n" % ATLAS_PLUGIN_VERSION 335 | stroutput += "\t\t\"author\":\"Bas de Reuver\",\n" 336 | stroutput += ("\t\t\"image\":\"%s.png\",\n" % filetag) 337 | stroutput += ("\t\t\"size\":{\"w\":%d,\"h\":%d},\n" % (img_w, img_h)) 338 | stroutput += "\t\t\"scale\":1\n" 339 | stroutput += "\t}\n" 340 | stroutput += "}" 341 | 342 | # export filename 343 | outputname = '%s.json' % (filename) 344 | 345 | # export coordinate variables to textfile 346 | outputfile = file(outputname, 'w') 347 | outputfile.write(stroutput) 348 | outputfile.close() 349 | return 350 | 351 | def write_spriteatlas_libgdx(filename, filetag, img_w, img_h): 352 | 353 | stroutput = ("%s.png\nsize: %d,%d\nformat: RGBA8888\nfilter: Linear,Linear\nrepeat: none\n" % (filetag, img_w, img_h)) 354 | 355 | # insert all sprite metadata 356 | for obj in layer_rects: 357 | stroutput += ("%s\n rotate: false\n xy: %d, %d\n size: %d, %d\n orig: %d, %d\n offset: 0, 0\n index: -1\n" % (obj.name, obj.pack_x, obj.pack_y, obj.width, obj.height, obj.width, obj.height)) 358 | 359 | # export filename 360 | outputname = '%s.atlas' % (filename) 361 | 362 | # export coordinate variables to textfile 363 | outputfile = file(outputname, 'w') 364 | outputfile.write(stroutput) 365 | outputfile.close() 366 | return 367 | 368 | def write_spriteatlas_css(filename, filetag): 369 | 370 | stroutput = "/* GIMP SpriteAtlas plug-in %s by Bas de Reuver 2023 */\n" % ATLAS_PLUGIN_VERSION 371 | 372 | # insert all sprite metadata 373 | for obj in layer_rects: 374 | stroutput += ".%s {\n" % obj.name 375 | stroutput += "\tbackground: url('%s.png') no-repeat -%dpx -%dpx;\n" % (filetag, obj.pack_x, obj.pack_y) 376 | stroutput += "\twidth: %dpx;\n" % obj.width 377 | stroutput += "\theight: %dpx;\n" % obj.height 378 | stroutput += "}\n" 379 | 380 | # export filename 381 | outputname = '%s.css' % (filename) 382 | 383 | # export coordinate variables to textfile 384 | outputfile = file(outputname, 'w') 385 | outputfile.write(stroutput) 386 | outputfile.close() 387 | return 388 | 389 | 390 | def write_spriteatlas_xml(filename, filetag): 391 | 392 | stroutput = ('\n' % filetag) 393 | stroutput += '\t\n' % ATLAS_PLUGIN_VERSION 394 | 395 | # insert all sprite metadata 396 | for obj in layer_rects: 397 | stroutput += '\t\n' % (obj.name, obj.pack_x, obj.pack_y, obj.width, obj.height) 398 | stroutput += '\t\n' 399 | 400 | stroutput += '\n' 401 | 402 | # export filename 403 | outputname = '%s.xml' % (filename) 404 | 405 | # export coordinate variables to textfile 406 | outputfile = file(outputname, 'w') 407 | outputfile.write(stroutput) 408 | outputfile.close() 409 | return 410 | 411 | def create_spriteatlas(image, filetag, foldername, outputtype, padding): 412 | global pixel_space 413 | 414 | # create list of all layers 415 | layers = image.layers 416 | numLayers = len(layers) 417 | 418 | # add 1 pixel padding 419 | pixel_space = 1 if padding else 0 420 | 421 | # Clear any selections on the original image to esure we copy each layer in its entirety 422 | pdb.gimp_selection_none(image) 423 | prepare_layers_metadata(layers) 424 | 425 | # export filename(s) 426 | outputname = '%s\\%s' % (foldername, filetag) 427 | 428 | # compile image 429 | calc_layers_packing() 430 | img_w, img_h = render_spriteatlas(layers, outputname, filetag) 431 | 432 | # write to output file 433 | if outputtype == 1: 434 | write_spriteatlas_jsonarray(outputname, filetag, img_w, img_h) 435 | elif outputtype == 2: 436 | write_spriteatlas_jsonhash(outputname, filetag, img_w, img_h) 437 | elif outputtype == 3: 438 | write_spriteatlas_libgdx(outputname, filetag, img_w, img_h) 439 | elif outputtype == 4: 440 | write_spriteatlas_css(outputname, filetag) 441 | else: # outputtype == 5 442 | write_spriteatlas_xml(outputname, filetag) 443 | 444 | # Register the plugin with Gimp so it appears in the filters menu 445 | register( 446 | "python_fu_create_spriteatlas", 447 | "Create a sprite texture image from the layers of the current image.", 448 | "Create a sprite texture image from the layers of the current image.", 449 | "Bas de Reuver", 450 | "Bas de Reuver", 451 | "2023", 452 | "Create SpriteAtlas", 453 | "*", 454 | [ 455 | (PF_IMAGE, 'image', 'Input image:', None), 456 | (PF_STRING, "fileName", "Export file name (without extension):", "sprites"), 457 | (PF_DIRNAME, "outputFolder", "Export to folder:", "/tmp"), 458 | (PF_RADIO, "fileType", "Export file type:", 1, (("JSON-TexturePacker Array", 1), ("JSON-TexturePacker Hash", 2), ("libGDX TextureAtlas", 3), ("CSS", 4), ("XML", 5))), 459 | (PF_BOOL, "addPadding", "Pad one pixel between sprites:", TRUE) 460 | ], 461 | [], 462 | create_spriteatlas, menu="/Filters/Animation/") 463 | 464 | main() -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------