Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/globalcitizen/svglover

Library to import and display simple SVGs in LÖVE.
https://github.com/globalcitizen/svglover

Last synced: 2 months ago
JSON representation

Library to import and display simple SVGs in LÖVE.

Awesome Lists containing this project

README 

        
# svglover



A pure lua library to import and display simple SVGs in [LÖVE](http://love2d.org/).



Tested up to love-11.3 (Mysterious Mysteries).



Note that because it is specifically written for LÖVE, it is probably not useful

for other [Lua](http://www.lua.org/) environments.



If you really want to squash your SVGs, try running them through

[SVGO](https://github.com/svg/svgo) and/or gzipping them.



The latest code can always be found at

[Github](https://github.com/globalcitizen/svglover).



## Alternative SVG libraries



* [lvg](https://github.com/Bananicorn/lvg) is a relatively simple SVG renderer (in pure lua, like svglover)

* [tove2d](https://github.com/poke1024/tove2d) a non pure lua love2d library for SVG support which includes multiple renderers and animation features, based on the unmaintained [nanosvg](https://github.com/memononen/nanosvg) C library



## News



* 2019-03-26:

    [v1.1.1](https://github.com/globalcitizen/svglover/releases/tag/v1.1.1) released! 

  - Fix typo



* 2019-03-19:

    [v1.1.0](https://github.com/globalcitizen/svglover/releases/tag/v1.1.0) released! Major work from @nasso, thanks!

  - Add support for the following elements: ``, `` and ``.

  - Add support for the following attributes: `href`, `xlink:href`, `d`, `viewBox`, `(stroke|fill)-opacity`.

  - Add support for many more color formats.

  - Improved support for the `transform` attribute.

  - Improved support for opacity-related attributes.

  - Various XML parsing improvements.

  - Removed `tableshow.lua` - I don't know why it was there but I'm pretty sure it isn't needed for `svglover` to work since it wasn't used at all.

  - Changed the demo code to show all the new features.

  - Some bug fixes.



* 2017-05-30:

    [v1.0.5](https://github.com/globalcitizen/svglover/releases/tag/v1.0.5)

    released!

  - Normalize internal function naming / reduce potential namespace collision

      issues



* 2016-10-02:

    [v1.0.4](https://github.com/globalcitizen/svglover/releases/tag/v1.0.4)

    released!

  - Fix compatibility issue by moving from basic Lua IO functions to 100% Love

      filesystem functions



* 2016-10-02:

    [v1.0.3](https://github.com/globalcitizen/svglover/releases/tag/v1.0.3)

    released!

  - Allow automatic / transparent loading of gzip compressed SVG files

  - Add zoom feature



* 2016-10-02:

    [v1.0.2](https://github.com/globalcitizen/svglover/releases/tag/v1.0.2)

    released!

  - Fix Lua logic error that was stopping fill-related scaling from working

      properly



* 2016-09-27:

    [v1.0.1](https://github.com/globalcitizen/svglover/releases/tag/v1.0.1)

    released!

  - Add `` support (when circles are not drawn as ``)

  - Slightly hardier parsing

  - Improved documentation



* 2016-09-27:

    [v1.0.0](https://github.com/globalcitizen/svglover/releases/tag/v1.0.0)

    released!

  - Basic functionality



## Features



* Supports the following elements:

  - ``

  - ``

  - ``

  - `` (no support for ArcTo yet)

  - ``

  - ``

  - ``

  - ``



* Supports the following attributes:

  - `id`, `href`, `xlink:href`, `x`, `y`, `width`, `height`, `cx`, `cy`, `r`,

      `rx`, `ry`, `d`, `points`

  - `transform` (with support for `translate`, `rotate`, `scale`, `skewX`,

      `skewY` and `matrix`)

  - `viewBox`

  - `stroke`

  - `stroke-opacity`

  - `stroke-width`

  - `fill`

  - `fill-opacity`

  - `opacity`



* Supports the following color syntaxes:

  - `#1e90ff`

  - `#621`

  - `dodgerblue` (or any other valid CSS color name)

  - `rgb(12%, 56%, 100%)`

  - `rgb(30, 144, 255)`

  - `rgba(12%, 56%, 100%, 0.5)`

  - `rgba(30, 144, 255, 0.5)`



Demo screenshot



## Why?



* SVGs are scalable, which is useful in today's era of vastly differing device

screen resolutions

* SVGs are small

* Vector images look cool

* With a little more coding you can probably animate their bits



## Usage

First import the library with require



```lua

svglover = require('svglover')

```



You should normally load your SVGs straight away in the `love.load()` function

to prevent duplicate reads. The syntax for doing this is as follows:



```lua

vector_image = svglover.load('some.svg')

```



You then specify where you want them displayed using:



```lua

svglover.display(vector_image,topleft_x,topleft_y,width,height,completely_fill_region,border_color,border_width,zoom)

```



... where `completely_fill_region`, `border_color`, `border_width` and `zoom`

are optional.



Finally, you should add the `svglover.draw()` call to the end of your

`love.draw()` function.



A complete example:



```lua

function love.load()

    vector_image = svglover.load('some.svg')

    svglover.display(vector_image,100,100,100,100,true,{255,0,0,255},1,1)

end



function love.draw()

    -- draw any scheduled SVGs

    svglover.draw()

end

```



## Development



Feel free to hack, fork, create issues, or send pull requests.

It should be possible and not too difficult to add advanced features like text

and post-draw handles for dynamic manipuplation of the resulting images to

support things like transitions. However, I am personally happy with the

existing functionality and will not be adding features in the near future.



## Motivation



I wanted to place SVG vector images in a roguelike game I was making,

[Zomia](https://github.com/globalcitizen/zomia), but there was no pre-existing

library. I first built [a proof of concept in perl,

svg2love](https://github.com/globalcitizen/svg2love), but then wanted to load

files direct from SVG in Lua instead of an intermediate format.



This is my first Lua library, so it probably ignores many best practices.