lövector - LÖVE-ly vector graphics

lövector is a pure-lua vector graphics processing and rendering library for the LÖVE game framework. It isn't tied to any particular vector graphics format: implementations of various vector graphics formats (SVG, EPS, PDF, custom...) are welcome, but for now, lövector only has an SVG implementation.

Example code

local lovector = require "lovector"

local house = nil
local tiggie = nil

-- You first create the vector graphics images once:
function love.load()
    --- Example: Build a path
    -- Create a path
    -- Most methods return "self", so you can chain method calls
    local roof_path = lovector.PathBuilder()
        :move_to(50, 140)
        :line_to(150, 60)
        :line_to(250, 140)
        :close_path()

    --- Example: Build a house
    -- Create a vector graphics image with "Graphics"
    -- It dynamically generates a LÖVE draw function we can use later
    -- Most methods return "self"
    house = lovector.Graphics()
        -- Set line width
        :set_line_width(10)

        -- Wall
        :rect(75, 140, 150, 110)
        :stroke_path()

        -- Door
        :begin_path()
        :rect(130, 190, 40, 60)
        :fill_path()

        -- You can also use a manually created Path!
        :stroke_path(roof_path)

    --- Example: Load an SVG
    -- It just does all the work for you, but it's a lovector.Graphics too!
    tiggie = lovector.SVG("demo_files/ghostscript-tiger.svg")
end

-- Then, you can draw them anywhere, as many times as you want!
function love.draw()
    --- Example: Drawing stuff!

    -- Arguments are:
    -- 1. x_pos (default = 0)
    -- 2. y_pos (default = 0)
    -- 3. x_scale (default = 1)
    -- 4. y_scale (default = x_scale)

    house:draw(0, 0)
    tiggie:draw(300, 0, 10)
end

Demo

The main.lua file at the root contains a demo code, showing some of the features of lövector. You can move the camera and zoom-in as much as you want.

Features

• Path tracing with move_to, line_to and other <canvas>-like commands. Supports cubic and quadratic Bézier curves, and elliptical arcs.
• Entirely written in Lua, making it available on every platform where LÖVE is.
• < 100 KB

Here's a summary table of what lövector does and doesn't support for now:

Note: This table is for the SVG 1.1 specification. Some SVG 2 features (such as "arcs" joins) might not be implemented yet.

SVG

• The following elements are implemented: circle, defs, ellipse, g, line, path, polygon, polyline, rect, svg, use
• Most commonly used attributes

Contributing

Feel free to fork, hack, make changes and merge/pull requests! Though, try to follow these coding style guidelines as much as possible:

All languages

As a rule of thumb, try to keep the coding style consistent with what's already there!

• Indent with 4 spaces.
• Always have a trailing newline at the end of every file.

Lua coding style

• No trailing whitespace at the end of a line.
• "Class" names must be in PascalCase.
• Variables, functions, methods must be in snake_case.
• Modules must have a shortname, onlylowercase and with nothing between words.
• Constants must be in ALL_CAPS_WITH_UNDERSCORES.
• Avoid inlining blocks, control structures, for statements and function definitions, unless it makes the code more clear.
• Never have a space character before a ,.
• Always have a space character after a ,.
• Always have a space character before and after =, + and -.
• Having a space character before and after * and / isn't mandatory if they're part of a mathematic expression where they have an implicit higher precedence than other operators. Example: a*b + c*d, a * b + c * d, a * b + c*d are okay, but a*b * c isn't.
• Refer to the Lua style guidelines for everything else.

Markdown coding style

• No trailing whitespace at the end of a line, unless it's an explicit line-break.
• A line must never be longer than 80 characters! If you're reading the Markdown source for this file, that means not writing anything longer than this line.
• Don't have a non-significant line-break in the source code for a paragraph unless the line would exceed 80 chars without it:

  Assume that the 80 chars limit is right here: ----------------------------->
  
  This is bad.
  Really bad.
  Don't do that.
  It's weird.
  
  Instead, you can do this. It makes the Markdown source code look more like
  the HTML it produces.  
  You are still allowed to have _explicit_ line-breaks in a paragraph, by
  having two-spaces at the end of a line, like the previous one.

• Use * for first-level lists and - for every other level of nesting.
• Always have a fenced code-block have a corresponding language identifier when possible.

License

lövector is licensed under the MIT license:

MIT License

Copyright (c) 2019 nasso <nassomails ~ at ~ gmail {dot} com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.