Skip to content
Pablo Mayobre edited this page Mar 25, 2015 · 12 revisions

Welcome to the Material-Love wiki!

Logo Material - Love

Material-Love is a set of libraries to use some of the features described in the Google Material-Design spec, in your LÖVE projects.

Animation of Material - Love working

Material-Love takes the overhead of generating some of the fancy effects described in those docs, like shadows, paper and ripples. It also facilitates the access to some other stuff like the Roboto Fonts, the color palettes, and even provides an icon font with 670 icons you can use in your project!


It is NOT a UI library nor is it intended to be, if you want you can use it with any other GUI library like Thranduil, DOMinatrix, Quickie or, with some serious effort, Love Frames.

Note: None of them are really supported by this library. And as such it is not guaranteed to work.


What is required?

If you want to use this libs be sure that you have some knowledge on LÖVE and Lua.

You need to have LÖVE installed and a basic project set up with the material-love folder in it and the main.lua file with this basic code:

love.load = function ()
end

love.update = function (dt)
end

love.draw = function ()
end

You can delete the images folder since those images are just for documentation or Demos.

Note: You can rename the folder to whatever you like, but be consistent through all your project

|

Note: This is the base requirement. If you have an already working game, made with LOVE, then you can also use that. If you use some library, that gives you some other functions, you can adapt material-love to work with it.

What should I read first?

I recommend you take a look at the Material Design spec before reading this, this will help you get an idea of what you need to create a Material Designed app.

You can begin almost everywhere, each page tells you if you need to know something else before you continue, so start wherever you like.

Check the features you may want to use in your project. Sometimes you don't need all of them, so you may prefer not to include all the libraries in this repository.

You can go to any page using the links of the tables of content at the right, which lists all the pages in this wiki.

Contributing

Check the CONTRIBUTING.md file for a Guide on how to contribute to this project.

It tells you how to format your Issues and Pull Request so that is easier for me to help you.

You may also ask simple questions in the LÖVE forums!

Credits

I must give credit to Robin (gvx) for the roundrect.lua library which I used as a base for my own roundrect.lua

Also thanks to Mrmaxmeier for fixing some issues in the nine.convert function and the image.lua file.

License

This set of libraries is Licensed under MIT License

Copyright(c) 2015 Pablo Ariel Mayobre (Positive07)

The Material Design Icon font is Licensed under SIL Open Font License 1.1 (The License file can be found here)

Some of the icons are designed by Google and are under Copyright CC-BY