Page 1 of 4
LÖVE-API Documentation (as a lua table)
Posted: Tue Mar 24, 2015 11:16 am
by rmcode
The complete API documentation of LÖVE contained in a lua table.
The project was originally started by
Santos who did a majority of the work. He gave his permission to host the project online.
The API information is based on the LÖVE-Wiki, but updated manually. Therefore there is no guarantee that everything is correct and up to date. If you find any errors, outdated information or missing content, please file a bug report or create a pull request.
Contributions are more than welcome!
The code lives at
github and the latest release can be found
here.
Re: LOVE-API
Posted: Tue Mar 24, 2015 1:53 pm
by ejmr
I'm probably missing something obvious, but what is a practical use-case for this?
Re: LOVE-API
Posted: Tue Mar 24, 2015 2:00 pm
by rmcode
ejmr wrote:I'm probably missing something obvious, but what is a practical use-case for this?
Quite obviously: Procrastination!
Jokes aside, I use it to auto-generate a LÖVE-Plugin for IntelliJ IDEA for example.
I also know paulclinger uses it for ZeroBraneStudio.
Re: LOVE-API
Posted: Tue Mar 24, 2015 2:03 pm
by ejmr
rmcode wrote:Quite obviously: Procrastination!
Well I'm a game developer too, so procrastination is mandatory right? Otherwise we're not doing it right...
Jokes aside, I use it to auto-generate a LÖVE-Plugin for IntelliJ IDEA for example.
Ah cool, that makes sense. Thanks for the example. Long ago I wrote a simple LÖVE mode for Emacs, and your example makes me think I could use LOVE-API to improve the functionality of that.
Re: LOVE-API
Posted: Tue Mar 24, 2015 2:29 pm
by rmcode
ejmr wrote:Well I'm a game developer too, so procrastination is mandatory right? Otherwise we're not doing it right...
Haha indeed!
Re: LOVE-API
Posted: Tue Mar 24, 2015 3:42 pm
by zorg
I could also imagine this being used for an
interactive löve demo app, for each function say.
Re: LOVE-API
Posted: Wed Mar 25, 2015 11:43 am
by rmcode
It could definitely be used to generate an interactive documentation. Examples could be taken directly from the wiki too now that I think about it.
Re: LÖVE-API Documentation
Posted: Wed Mar 25, 2015 12:27 pm
by rmcode
Updated to
0.9.2!
Re: LOVE-API
Posted: Wed Mar 25, 2015 1:54 pm
by zorg
rmcode wrote:
It could definitely be used to generate an interactive documentation. Examples could be taken directly from the wiki too now that I think about it.
Yeah, it was talked about in the other thread, but i didn't see any progress with it; maybe i'll take it on me to do something about it after all;
Re: LÖVE-API Documentation
Posted: Fri Mar 27, 2015 4:29 pm
by rmcode
Pushed three small updates:
Code: Select all
#0.9.2c
- Fixed faulty escape sequence in love.filesystem
#0.9.2b
- Added love.filesystem.mount
- Added love.filesystem.unmount
- Added love.filesystem.setSource
- Added love.filesystem.setSourceBaseDirectory
#0.9.2a
- Fixed require statements
If you find more functions which are missing from the documentation please report them here or on github.