RTsoft Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====About====
Proton SDK (aka p+) is a component based C++ framework that is optimized for GL/GLES based mobile cross-platform game development.

It's designed for advanced C++ programmers, if you're new to C++ or programming, this probably isn't the SDK for you!

Warning: Currently, things are designed around the presumption that you want to work from Visual C++ on Windows as your "main" development platform. Most scripts are .bat files. There is no deal-breaking reason why you can't use another platform as your "main" platform, but you'll have to do more work to get it going.  If you do that, you should tell email Seth and contribute any tips/scripts/changes you've made.

====Credits====
Proton SDK was created by Seth A. Robinson. ([[http://www.rtsoft.com|www]]/[[http://www.codedojo.com|blog]]/[[http://www.twitter.com/rtsoft|twitter]]/[[seth@rtsoft.com|email]])

Special thanks to [[http://clanlib.org/wiki/Main_Page|ClanLib]] (Proton uses its vector and matrix math), boost, the Independent JPEG Group, Imagination Technologies Ltd, zlib, [[http://irrlicht.sourceforge.net/|Irrlicht]], [[http://www.fmod.org/|FMOD]], Cocos2D/Cocos-X, and [[http://www.galaxist.net/linearparticle.html|LinearParticle]].

====Why?====
One of the greatest perks of working for yourself is you can give away source code without a second thought.

I enjoy programming engines as much as making games.  It gives me a warm fuzzy feeling to know people across the globe are (maybe) using my stuff and contributing bugfixes and code back.  How cool is that?

-Seth


====Contributing Code====

Do you want to be a part of the magic and contribute your brainpower to the project?  Here's how!

  * Created patches using svn difs.  On Windows with [[http://tortoisesvn.net|TortoiseSVN]] installed, just right click the Proton root folder and choose Create Patch.  On linux from the command line it would be: svn diff > mypatch.diff from the root folder.
  * Post the patches in the [[http://www.rtsoft.com/forums/forumdisplay.php?26-Proton-SDK-Area|forums]], if they don't totally break everything Seth will commit them
  * After you've "proven yourself" with a few patches, Seth will be happy to give you full write access to the svn if you want it
  * All submitted code must be fully compatible with the Proton license (unless it's like a third party library with its own license, like zlib)

Coding rules:

  * Try to follow the existing code style of the file
  * Do not commit breaking changes without talking to Seth first
  * Do not change default behavior of any component/class without to Seth first
  * Feel free to add your name in the credits of the .h file of any class/file you considerably modify/add to
  * Feel free to add comments like "Added this to fix crash on OS X -JoeCoder" in the code, especially if it's not clear why you added something
  * If you want to add an additional build system like Premake, it's cool as long as it doesn't break any existing build stuff

====Contributing Documentation====

This is a wiki, feel free!

====Contributing Art & Music====

Seth sucks at art and would love to have better looking examples, logos, music, etc.  Just make some post on the forums.

====Contributing Cash====

Really?  Well, let Seth know someone would actually do this and he'll set up a paypal link or something.

====Getting a hold of Seth====
Want to chat with Seth about something and email won't do? He hangs out in IRC in #clanlib on irc.freenode.net