{"id":15722613,"url":"https://github.com/britzl/lumiere","last_synced_at":"2025-06-26T00:06:47.605Z","repository":{"id":62159915,"uuid":"156217907","full_name":"britzl/lumiere","owner":"britzl","description":"A collection of post processing effects for Defold","archived":false,"fork":false,"pushed_at":"2025-02-19T11:35:12.000Z","size":1490,"stargazers_count":44,"open_issues_count":5,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-07T21:45:03.635Z","etag":null,"topics":["defold","defold-library","postprocessing"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/britzl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-11-05T12:55:36.000Z","updated_at":"2025-03-09T20:28:20.000Z","dependencies_parsed_at":"2024-10-24T16:51:03.795Z","dependency_job_id":"46ed3d6f-efb8-4a9b-9c55-2d7d5c901802","html_url":"https://github.com/britzl/lumiere","commit_stats":{"total_commits":52,"total_committers":1,"mean_commits":52.0,"dds":0.0,"last_synced_commit":"0842c0256d492e93ad3251ed33e2170e905b9f59"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/britzl/lumiere","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/britzl%2Flumiere","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/britzl%2Flumiere/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/britzl%2Flumiere/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/britzl%2Flumiere/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/britzl","download_url":"https://codeload.github.com/britzl/lumiere/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/britzl%2Flumiere/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261973726,"owners_count":23238585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["defold","defold-library","postprocessing"],"created_at":"2024-10-03T22:08:38.947Z","updated_at":"2025-06-26T00:06:47.199Z","avatar_url":"https://github.com/britzl.png","language":"Lua","funding_links":[],"categories":["Libraries"],"sub_categories":["Programming Language"],"readme":"# Lumiere - Work In Progress\n\nLumiere is a collection of post processing effects for use in Defold.\n\n## Installation\n\nYou can use Lumiere in your own project by adding this project as a [Defold library dependency](http://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:\n\n\u003chttps://github.com/britzl/lumiere/archive/master.zip\u003e\n\nOr point to the ZIP file of a [specific release](https://github.com/britzl/lumiere/releases).\n\n## Usage\n\nLumiere has to be integrated with your render script to be able to apply effects.\n\n## Effects\n\nLumiere provides a system to apply multiple post-effects to a game.\n\nExamples of effects provided:\n\n* [Blur](lumiere/effects/blur/)\n* [Grain](lumiere/effects/grain/)\n* [Lights](lumiere/effects/lights/)\n* [Chromatic Aberration](lumiere/effects/chromatic_aberration/)\n* [LCD](lumiere/effects/lcd/)\n* [Scanlines](lumiere/effects/scanlines/)\n* [Colorgrade](lumiere/effects/colorgrade/)\n\n## Quick Start\n\n1. Add `/lumiere/lumiere.go` to your collection.\n2. Add an effect you want to use to your collection, e.g. `/lumiere/effects/grain/grain.go`\n3. Integrate Lumiere in the render script.\n4. Add `lumiere.use_effects({})` into your script.\n\nMore precise instructions are below.\n\n## Add lumiere.go\n\nAdd `/lumiere/lumiere.go` to a loaded collection, either the bootstrap collection or a loaded proxy collection. This game object contains a full screen quad to which the final composition of post processing effects is drawn.\n\n## Using effects\n\nEach effect consists of some shader code, a Lua module and a game object. To use an effect the game object for the effect has to be added to a loaded collection, either the bootstrap collection or a loaded proxy collection.\n\n## Render script integration\n\n```lua\n-- require lumiere for use in the render script\nlocal lumiere = require(\"lumiere.lumiere\")\n\n\nfunction init(self)\n    -- initialize lumiere\n    lumiere.init()\n\n    -- the rest of your init code\n    ...\nend\n\nfunction update(self)\n    -- update lumiere each frame\n    lumiere.update()\n\n    -- your render script update code\n    ...\n\n    -- wrap any render.draw() calls that should be affected by lumiere effects\n    lumiere.draw(function()\n        ...\n end)\n\n    ...\nend\n\nfunction M.on_message(self, message_id, message)\n    -- pass messages to lumiere (to detect change in clear color etc)\n    lumiere.on_message(message_id, message)\n\n    -- the rest of your on_message code\n    ...\nend\n```\n\nNote: See the [example.render_script](examples/example.render_script) for a full example.\n\n## Add effects to your script\n\n The Lua module for the effect has to be added to Lumiere in your script:\n\n```lua\nlocal lumiere = require(\"lumiere.lumiere\")\nlocal blur = require(\"lumiere.effects.blur.blur\")\nlocal grain = require(\"lumiere.effects.grain.grain\")\n\n\nfunction init(self)\n    -- use the blur and grain effect (in that order)\n    lumiere.use_effects({ blur, grain })\nend\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbritzl%2Flumiere","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbritzl%2Flumiere","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbritzl%2Flumiere/lists"}