https://github.com/jegor377/godot-gdgifexporter

Gif exporter for Godot made entirely in GDScript
https://github.com/jegor377/godot-gdgifexporter

gif gif-library godot godot-engine

Last synced: 3 months ago
JSON representation

Gif exporter for Godot made entirely in GDScript

• Host: GitHub
• URL: https://github.com/jegor377/godot-gdgifexporter
• Owner: jegor377
• License: mit
• Created: 2020-07-04T17:56:26.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-11T22:47:05.000Z (7 months ago)
• Last Synced: 2024-01-24T08:53:40.234Z (5 months ago)
• Topics: gif, gif-library, godot, godot-engine
• Language: GDScript
• Homepage:
• Size: 8.84 MB
• Stars: 105
• Watchers: 3
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-godot - GDGIFExporter - GIF exporter made entirely in GDScript. (Plugins and scripts / 3D)
• awesome-godot - GDGIFExporter - GIF exporter made entirely in GDScript (Godot 3.2). (Plugins and scripts / Video tutorials)
• awesome - jegor377/godot-gdgifexporter - Gif exporter for Godot made entirely in GDScript (GDScript)

README

        
# Gif exporter for Godot made entirely in GDScript

This is gif exporter for godot made entirely using GDScript. This is based on [godot-gifexporter](https://github.com/novhack/godot-gifexporter).

The version on master is for Godot 4.x. If you want to use version for Godot 3.x, then please pull changes from branch 3.x. :)



	

		

	



## Example

```gdscript

extends Node2D

# load gif exporter module

const GIFExporter = preload("res://gdgifexporter/exporter.gd")

# load quantization module that you want to use

const MedianCutQuantization = preload("res://gdgifexporter/quantization/median_cut.gd")

func _ready():

	var img := Image.new()

	# load your image from png file

	img.load('res://image.png')

	# remember to use this image format when exporting

	img.convert(Image.FORMAT_RGBA8)

	# initialize exporter object with width and height of gif canvas

	var exporter = GIFExporter.new(img.get_width(), img.get_height())

	# write image using median cut quantization method and with one second animation delay

	exporter.add_frame(img, 1, MedianCutQuantization)

	# when you have exported all frames of animation you, then you can save data into file

	# open new file with write privlige

	var file: FileAccess = FileAccess.open('user://result.gif', FileAccess.WRITE)

	# save data stream into file

	file.store_buffer(exporter.export_file_data())

	# close the file

	file.close()

```

## Quantization methods

Addon supports two quantization methods:

- Median Cut

- Uniform (with small color adjustment)

Both method files are stored in gdgifexporter/quantization directory.

## Error Codes

Some methods give error codes. These are used error codes and their meaning:

- OK = 0 (Everything went okay)

- EMPTY_IMAGE = 1 (Passed image object has no data in it)

- BAD_IMAGE_FORMAT = 2 (You are using different image format than FORMAT_RGBA8)

# Contributors

If you want to contribute to this code then go ahead! :) Huge thanks to Kinwailo and novhack. This project wouldn't work without their help! Moreover the update to Godot 4.x wouldn't be possible without the contribution of OverloadedOrama, so huge respect for him! :D

# Used external libs

- [godot-gif-lzw](https://github.com/jegor377/godot-gif-lzw)