LÖVE-API Documentation (as a lua table)

Showcase your libraries, tools and other projects that help your fellow love users.
User avatar
rmcode
Party member
Posts: 454
Joined: Tue Jul 15, 2014 12:04 pm
Location: Germany
Contact:

LÖVE-API Documentation (as a lua table)

Post by rmcode » Tue Mar 24, 2015 11:16 am

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.
Last edited by rmcode on Thu Apr 02, 2015 11:49 am, edited 3 times in total.

User avatar
ejmr
Party member
Posts: 302
Joined: Fri Jun 01, 2012 7:45 am
Location: South Carolina, U.S.A.
Contact:

Re: LOVE-API

Post by ejmr » Tue Mar 24, 2015 1:53 pm

I'm probably missing something obvious, but what is a practical use-case for this?
ejmr :: Programming and Game-Dev Blog, GitHub
南無妙法蓮華經

User avatar
rmcode
Party member
Posts: 454
Joined: Tue Jul 15, 2014 12:04 pm
Location: Germany
Contact:

Re: LOVE-API

Post by rmcode » Tue Mar 24, 2015 2:00 pm

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.

User avatar
ejmr
Party member
Posts: 302
Joined: Fri Jun 01, 2012 7:45 am
Location: South Carolina, U.S.A.
Contact:

Re: LOVE-API

Post by ejmr » Tue Mar 24, 2015 2:03 pm

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.
ejmr :: Programming and Game-Dev Blog, GitHub
南無妙法蓮華經

User avatar
rmcode
Party member
Posts: 454
Joined: Tue Jul 15, 2014 12:04 pm
Location: Germany
Contact:

Re: LOVE-API

Post by rmcode » Tue Mar 24, 2015 2:29 pm

ejmr wrote:Well I'm a game developer too, so procrastination is mandatory right? Otherwise we're not doing it right...
Haha indeed! :awesome:

User avatar
zorg
Party member
Posts: 2859
Joined: Thu Dec 13, 2012 2:55 pm
Location: Absurdistan, Hungary
Contact:

Re: LOVE-API

Post by zorg » Tue Mar 24, 2015 3:42 pm

I could also imagine this being used for an interactive löve demo app, for each function say.
Me and my stuff :3True Neutral Aspirant. Why, yes, i do indeed enjoy sarcastically correcting others when they make the most blatant of spelling mistakes. No bullying or trolling the innocent tho.

User avatar
rmcode
Party member
Posts: 454
Joined: Tue Jul 15, 2014 12:04 pm
Location: Germany
Contact:

Re: LOVE-API

Post by rmcode » Wed Mar 25, 2015 11:43 am

zorg wrote:I could also imagine this being used for an interactive löve demo app, for each function say.
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.

User avatar
rmcode
Party member
Posts: 454
Joined: Tue Jul 15, 2014 12:04 pm
Location: Germany
Contact:

Re: LÖVE-API Documentation

Post by rmcode » Wed Mar 25, 2015 12:27 pm

Updated to 0.9.2! :awesome:

User avatar
zorg
Party member
Posts: 2859
Joined: Thu Dec 13, 2012 2:55 pm
Location: Absurdistan, Hungary
Contact:

Re: LOVE-API

Post by zorg » Wed Mar 25, 2015 1:54 pm

rmcode wrote:
zorg wrote:I could also imagine this being used for an interactive löve demo app, for each function say.
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; :3
Me and my stuff :3True Neutral Aspirant. Why, yes, i do indeed enjoy sarcastically correcting others when they make the most blatant of spelling mistakes. No bullying or trolling the innocent tho.

User avatar
rmcode
Party member
Posts: 454
Joined: Tue Jul 15, 2014 12:04 pm
Location: Germany
Contact:

Re: LÖVE-API Documentation

Post by rmcode » Fri Mar 27, 2015 4:29 pm

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.

Post Reply

Who is online

Users browsing this forum: No registered users and 9 guests