[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/bbcode.php on line 488: preg_replace(): The /e modifier is no longer supported, use preg_replace_callback instead
[phpBB Debug] PHP Warning: in file [ROOT]/includes/functions.php on line 4762: Cannot modify header information - headers already sent by (output started at [ROOT]/includes/functions.php:3897)
[phpBB Debug] PHP Warning: in file [ROOT]/includes/functions.php on line 4764: Cannot modify header information - headers already sent by (output started at [ROOT]/includes/functions.php:3897)
[phpBB Debug] PHP Warning: in file [ROOT]/includes/functions.php on line 4765: Cannot modify header information - headers already sent by (output started at [ROOT]/includes/functions.php:3897)
[phpBB Debug] PHP Warning: in file [ROOT]/includes/functions.php on line 4766: Cannot modify header information - headers already sent by (output started at [ROOT]/includes/functions.php:3897)
Chipmunk Physics • View topic - Docs, Demos and Tutorials

Docs, Demos and Tutorials

Official forum for the .

Would you be able/willing to contribute to help write docs/tutorials?

yes
25
69%
no
1
3%
maybe
10
28%
 
Total votes : 36

Docs, Demos and Tutorials

Postby slembcke » Wed Jan 09, 2008 4:56 am

So lately I've been thinking about how lame my docs and demos are, and how I have a serious need for some tutorials.

Documentation:
I haven't been great about keeping the docs up to date, nor complete (what should be considered read-only or opaque, etc). The docs are also very C-centric. At least in the case of my Ruby binding, it would be helpful if there was a Chipmunk primer that gave an overview and then separate C/Ruby docs for the respective APIs. I can imagine that this would be useful for other bindings as well. (Ruby, Python, OCaml, and BlitzMax that I know of)

Demos:
Ideally I should have some very simple demos that can show off the features in a clear way, and another set that just does cool looking stuff. The code for the former should be very short/simple, the code for the latter could be crap IMO. Having some interactive demos would be good too (people are always disappointed by that).

Tutorials:
There should be tutorials on how to do basic things that people want to do with Chipmunk. (moving platforms, spaceships, character movement, buoyancy, vehicles, ropes, etc) These should most definitely be interactive. For clarity, the code should be kept to a couple hundred lines and one source file per tutorial.

Plan:
- I should set up a copy of MediaWiki for doing the documentation. This way people can help out revising the documentation instead of me being the bottleneck. Are people willing to help?
- I don't really have a good reason for sitting on my latest changes instead of making a release. I should do that ASAP. Really I just need to tie up some loose ends and document things.
- Refactor the demo drawing code. Ideally, the demo/tutorial code should only deal with the physics. If I refactored the current demo drawing code a bit, you could simply pass a cpSpace to some space drawing function. While quick and dirty, this would be effective and keep the focus on the physics.
- Write new demos/tutorial. Anyone willing to help here? As long as people are willing to accept me as gatekeeper for what code actually goes in the Chipmunk package, I'd be more than happy to accept help!
Can't sleep... Chipmunks will eat me...
Check out our latest projects! -> http://howlingmoonsoftware.com/wordpress/
User avatar
slembcke
Site Admin
 
Posts: 4164
Joined: Tue Aug 14, 2007 7:13 pm

Re: Docs, Demos and Tutorials

Postby theanzelm » Wed Jan 09, 2008 3:40 pm

As soon as I'm finished with the SDF stuff and integrated chipmunk in my game engine this here will be full of demos and tuts and games and stuffs,
I promise! ^^
theanzelm
 
Posts: 17
Joined: Sun Jan 06, 2008 7:06 am

Re: Docs, Demos and Tutorials

Postby citrys » Thu Jan 10, 2008 9:57 am

If you think it's worth including in the Chipmunk distribution, please feel free to use the very simple text-based Ruby Chipmunk I posted last month.
citrys
 
Posts: 16
Joined: Thu Nov 15, 2007 12:26 am

Re: Docs, Demos and Tutorials

Postby supertommy » Mon Jan 14, 2008 3:00 am

I have a tiny little suggestion for the documentation; There should be an index at the top, and an anchor for each of the chapters. That would let us post links to specific parts of the doc on the forum, instead of having to say "go to the forum and search for this text".
supertommy
 
Posts: 56
Joined: Tue Sep 11, 2007 2:30 pm

Re: Docs, Demos and Tutorials

Postby dirkbj » Thu Jan 17, 2008 6:27 pm

I have written a tutorial on using Chipmunk with Gosu. See http://code.google.com/p/gosu/wiki/Ruby ... ntegration.

Cheers,

Dirk
dirkbj
 
Posts: 7
Joined: Wed Oct 03, 2007 11:56 am

Re: Docs, Demos and Tutorials

Postby Blue Prawn » Tue Jan 29, 2008 12:30 pm

Hi,
For the doc, I don't know if it lacks a lot of things, but I've found it quite good, and I've found only one little minor error in it.
But I think the idea of migrate it to a wiki is a good idea. wiki things are known to work!

For the demos, another kind of demos that I think that could be helpful would be test demos that test every feature of chipmunk, it would help to check everything works as it should, maybe for people that would try to hack chipmunk, and also it would help in my case when writing a binding to check that all the features work as expected through the wrapper.

For tutorials IMO I find it a very good idea to make a mix between demo and tutorial, as a demo with a lot of comments, as it is the case for moon-buggy. Because often when we read a tutorial we are willing to see it work to understand better the explanations, and it is quite boring to do copy/past to test the code, that is often not complete and doesn't work.

For the interactive demos, it would indeed help because it is not so easy when one is not used to physics, to figure what is the best way to model different things.

As you say that people are disappointed not having some interactive demos, but there is the Moon-Buggy that I found very nice ! Other like this would be wellcome. The only critic I can do about it is that there is no Makefile :)

Cheers
Blue Prawn
 
Posts: 22
Joined: Thu Jan 03, 2008 1:36 pm

Re: Docs, Demos and Tutorials

Postby tucano » Tue Apr 08, 2008 6:55 am

HI, first of all congrats for your beautiful and easy library.
May be there is a small error in the documentation:

In the docs you define this:

cpShape *cpCircleShapeNew(cpBody *body, cpVect offset, cpFloat radius)

But in the library:

cpShape *
cpCircleShapeNew(cpBody *body, cpFloat radius, cpVect offset)
{
return (cpShape *)cpCircleShapeInit(cpCircleShapeAlloc(), body, radius, offset);
}

So you should invert (in the documentation) offset and radius... correct?

Ciao!
tucano
 
Posts: 4
Joined: Fri Apr 04, 2008 8:58 am

Re: Docs, Demos and Tutorials

Postby Michael Buckley » Tue Apr 08, 2008 9:21 pm

I think that the docs are outdated instead of flat-out incorrect. In older versions of the library that was the correct ordering.
Michael Buckley
 
Posts: 46
Joined: Tue Aug 21, 2007 10:30 am

Re: Docs, Demos and Tutorials

Postby tartley » Thu Aug 14, 2008 12:04 am

Hey. I voted 'yes', so I figured I'd post to make my username visible.

I'm actually using Pymunk, but I'm familiar with C and have already made some cosmetic tweaks to the Chipmunk C demos during my investigations, which could possibly be rolled back in. I'm just talking about stuff like subtle re-arrangements of the bodies/shapes that are instantiated on demo initialisation, to make the ensuing animation more pleasing or lengthy, or else drawing static shapes in a different color from regular ones.
Tartley - Jonathan Hartley,
Using Pymunk (Chipmunk's Python bindings) for a game project:
User avatar
tartley
 
Posts: 37
Joined: Thu Jun 12, 2008 5:01 pm
Location: London, England

Re: Docs, Demos and Tutorials

Postby slembcke » Sun Sep 07, 2008 1:34 am

Ok! Now that ScribBall is out on the Mac and submitted to Apple to be on the iPhone, I figured that I should finally get back to working some on Chipmunk. I spent most of the day trying to update the documentation and get it all moved over to the project wiki on the Google code page. I've almost finished with that.

http://code.google.com/p/chipmunk-physi ... umentation

Once that is complete, I plan to try and track down the remaining couple of known issues and make a new (long overdue) release.
Can't sleep... Chipmunks will eat me...
Check out our latest projects! -> http://howlingmoonsoftware.com/wordpress/
User avatar
slembcke
Site Admin
 
Posts: 4164
Joined: Tue Aug 14, 2007 7:13 pm

Next

Return to Chipmunk2D Physics

Who is online

Users browsing this forum: No registered users and 5 guests

cron