Libgdx Community Wiki

Anything libgdx related goes here!

Libgdx Community Wiki

Postby radioking » Tue Aug 09, 2011 2:07 pm

Please check out our work in progress Community Wiki for libGDX.

http://code.google.com/p/libgdx-users/

We have added a core repo and will be adding more examples, expanded documentation and more.

All contributions are very welcome! Join the community here:

http://code.google.com/p/libgdx-users/wiki/JoinUp


Proudly announcing 60th contributor to libgdx-users community project! *yay* :)


Background for this community Wiki for libGDX:

1.) Informations were spread on various places.

2.) There was a kind of glossary missing for:
+ technical terms in graphics and their equivalent name in the libgdx world (in case they differ)
+ techniques used by libgdx with their relationships and dependencies
+ common tasks / use cases, enriched with code snippets

3.) There was no document providing a high-level overview for libGDX?

4.) Mindmaps or graphics "worth a thousand words" (in flavor of http://code.google.com/p/libgdx/wiki/Gr ... lsViewport serves well) were missing to support understandability.
Last edited by radioking on Thu Nov 24, 2011 3:11 pm, edited 4 times in total.
Please "give sth. back" to community and contribute your knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
Please see Mario's note on User Wiki 2.0: http://www.badlogicgames.com/wordpress/?p=2411
radioking
 
Posts: 284
Joined: Wed Aug 03, 2011 10:28 am

Re: Documentation: Glossary for libgdx features

Postby yatayata » Tue Aug 09, 2011 3:36 pm

agreed - theres a lot of info but it could be better organized.
do you have any suggestions where to start?

part of the issue is the info is all different types:

- blog tutorials
well written long articles with images. we really want to keep this as easy for mario to write as possible so there is more of this raw info. perhaps tho the info could be re-organized or linked from a central place later?
also blog is only searchable via google...

- forum
interactive threads. works well with embedded code samples but its not an easy entry point

- java docs
are automatically generated, but very sparse.
if there were a way to add examples here, that stuck to the auto generated docs, this might be a good central place for people to contribute their knowledge... if it could be organized to hang off the API. so eg around Action, someone could add a tutorial and examples, other people could fill in ways to use the APIs. same for box2d stuff etc... then the info is at least structured.
not sure if some web app exists to kind of have an "annotated API" - as we would want to be able to edit a wiki that would be "sticky" on the right node of constantly updated javadocs underneath.

- wiki
is mostly tutorials. if more people had edit rights, this could also be a crowdsource way to add info. but wiki is so unorganized it will end up being a huge mess and impossible to update for new versions of the API etc.
but it is very flexible way to add info of all different types from tutorials to API clarification
we could then cross link from the API javadocs i guess, or maybe even generate some kind of template skeleton Wiki from the javadocs

I also was thinking something like faqme.com could make a nice Beginners guide to libgdx, but there would have to be a way for crowds to update the FAQ easily + quickly.

I would be up for contributing some time to this - what do other people think is a good way to go ahead?
Please "give something back" to the community and contribute your
knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
-> Just PM me your Gmail address so that I can add you as contributor
yatayata
 
Posts: 50
Joined: Mon Aug 01, 2011 2:01 pm
Location: tokyo

Re: Documentation: Glossary for libgdx features

Postby radioking » Tue Aug 09, 2011 4:41 pm

Just to throw some more thoughts on this in, unsorted:


In the "information spread list" missing:
++++ comments on blog entries, there might be information buried, too



A screenshot for each example test would be nice to see what the test is all about.
Sometimes a screenshot is enough to judge if the techniques used by the test serves your pupose.
This way you don't need to put everything in Eclipse and care for the sideeffects and settings.


Another difficulty I encountered:
It's hard to decide which feature is already usable and to which extent.
Libgdx is actively developed and fast growing- which is perfect!

But beginners read older posts / blog entries and start testing- sometimes
on an old base.
A timeline of features or a roadmap with milestones (graphic?) might help.

I only found blog posts describing the "red line" in development:
http://www.badlogicgames.com/wordpress/?p=1059
http://www.badlogicgames.com/wordpress/?p=1092
http://www.badlogicgames.com/wordpress/?p=1105
http://www.badlogicgames.com/wordpress/?p=1110
http://www.badlogicgames.com/wordpress/?p=1945
http://www.badlogicgames.com/wordpress/?p=2013
http://www.badlogicgames.com/wordpress/?p=2093

and this overview (February 2011):
http://code.google.com/p/libgdx/wiki/GoalsFeatures
Please "give sth. back" to community and contribute your knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
Please see Mario's note on User Wiki 2.0: http://www.badlogicgames.com/wordpress/?p=2411
radioking
 
Posts: 284
Joined: Wed Aug 03, 2011 10:28 am

Re: Documentation: Glossary for libgdx features

Postby yatayata » Tue Aug 09, 2011 5:45 pm

another way might be to create a libgdx StackExchange, so the Q&A can be more organized... but if it splits the community between here and there that would be no good...
Please "give something back" to the community and contribute your
knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
-> Just PM me your Gmail address so that I can add you as contributor
yatayata
 
Posts: 50
Joined: Mon Aug 01, 2011 2:01 pm
Location: tokyo

Re: Documentation: Glossary for libgdx features

Postby mzechner » Thu Aug 11, 2011 2:35 am

Not sure why you think the JAvadocs are sparse, but oh well :)

I'm all for a community wiki. So far i didn't have the time to set one up. The Google Code Wiki will be for contributors only i'm afraid.

I'd also rather gather messages and threads here instead of having 2-3 places for me to visit and answer questions at.

If one of you wants to take on the creation of a community wiki i'll try to support you as much as possible.
mzechner
Site Admin
 
Posts: 4879
Joined: Sat Jul 10, 2010 3:50 pm

Re: Documentation: Glossary for libgdx features

Postby yatayata » Thu Aug 11, 2011 10:46 am

@radioking >
maybe we can chat this over on IRC? A wiki would be an easy way to get started and throw up devnotes as we go along. worried its a bit unstructured tho.

questions/discussion should be kept in the forum here, and just resolved "howtos"/annotated docs can go to the wiki with linkbacks to forum and/or API javadocs.

Not sure why you think the JAvadocs are sparse, but oh well

they're awesome, but still its hard to learn how to use a feature just by looking at the javadocs.

for example the 2D UI stuff has voluminous javadocs, but I couldnt find a cross-reference to TableLayout. maybe digging through the docs directories is better than relying on the breadcrumbs.

http://libgdx.l33tlabs.org/docs/api/com ... ayout.html
http://libgdx.l33tlabs.org/docs/api/com ... l#expandX()

even then, not sure quite yet what expandX() etc are for

So looking through examples helps a lot... I'm sure the community could contribute a lot here, so a Wiki sounds like a good start.
Please "give something back" to the community and contribute your
knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
-> Just PM me your Gmail address so that I can add you as contributor
yatayata
 
Posts: 50
Joined: Mon Aug 01, 2011 2:01 pm
Location: tokyo

Re: Documentation: Glossary for libgdx features

Postby radioking » Fri Aug 12, 2011 11:10 am

After a chat on IRC and discussing the pros and cons, yatayata and I decided to start a community wiki.
With this we can gather examples + focus all the knowhow thats here for using libGDX.

We've started as a googlecode project for this task as it has an associated wiki, but also makes it really easy to check in/out example code using GIT etc.

http://code.google.com/p/libgdx-users/
(just getting going with it...)

One thing about google code is, that we have to manually approve people wishing to join the project- so please give us a note there...
... or you can either msg us on IRC with userID
... or send a mail to libgdx-users@googlegroups.com
... committers will be added to leave comments

@forum admins: sticky? :mrgreen:
Please "give sth. back" to community and contribute your knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
Please see Mario's note on User Wiki 2.0: http://www.badlogicgames.com/wordpress/?p=2411
radioking
 
Posts: 284
Joined: Wed Aug 03, 2011 10:28 am

Re: Documentation: Glossary for libgdx features

Postby cblcz » Fri Aug 12, 2011 1:37 pm

radioking wrote:After a chat on IRC and discussing the pros and cons, yatayata and I decided to start a community wiki.
With this we can gather examples + focus all the knowhow thats here for using libGDX.

We've started as a googlecode project for this task as it has an associated wiki, but also makes it really easy to check in/out example code using GIT etc.

http://code.google.com/p/libgdx-users/
(just getting going with it...)

One thing about google code is, that we have to manually approve people wishing to join the project- so please give us a note there...
... or you can either msg us on IRC with userID
... or send a mail to libgdx-users@googlegroups.com
... committers will be added to leave comments

@forum admins: sticky? :mrgreen:


It sounds perfect.
Thank you.
cblcz
 
Posts: 34
Joined: Sun Jul 31, 2011 1:05 am

Re: Libgdx Community Wiki

Postby mzechner » Sun Aug 14, 2011 6:02 am

Thanks a ton guys, really appreciate your help here. I made the thread sticky, please update the first post with the instructions so people know what/how/where :)

Keep it up!
mzechner
Site Admin
 
Posts: 4879
Joined: Sat Jul 10, 2010 3:50 pm

Re: Libgdx Community Wiki

Postby yatayata » Tue Aug 16, 2011 9:19 am

hiya - thanks very much. radioking > can you edit the top of this thread?

for folks who made it down to here,
please check out our work in progress
Community Wiki for libGDX.

http://code.google.com/p/libgdx-users/

we've added a core repo and will be adding more examples, expanded documentation and more. all contributions are very welcome, join the community here:
http://code.google.com/p/libgdx-users/wiki/JoinUp
Please "give something back" to the community and contribute your
knowledge to our libgdx-users project community wiki:
http://code.google.com/p/libgdx-users/
-> Just PM me your Gmail address so that I can add you as contributor
yatayata
 
Posts: 50
Joined: Mon Aug 01, 2011 2:01 pm
Location: tokyo

Next

Return to Libgdx

Who is online

Users browsing this forum: Google [Bot], MSN [Bot] and 1 guest