Miniature/Development

(→Download)
Line 24: Line 24:
The Miniature project was born as a proposal sent to the Maemo community on 2009-10-31. Check the [[Miniature/archive|archive]] if you want to dig in the past.
The Miniature project was born as a proposal sent to the Maemo community on 2009-10-31. Check the [[Miniature/archive|archive]] if you want to dig in the past.
-
== Get started ==
 
-
Currently you can build Miniature with the latest Qt SDK (including the Harmattan target) or the Harmattan Platform SDK. The Miniature sources and commit logs are available at https://gitorious.org/miniature/ . Both SDKs come with an emulator for deploying your app. All the better if you have a Nokia N950 or N9 to test on device.
+
== Get involved ==
 +
Contributions are welcome! This is how you can get started:
-
* [https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk Instructions to build Miniature with Qt Creator]
+
* Download or build Miniature, and tell us what to think.
 +
* Spread the Miniature love among your Chess friendly contacts.
 +
* Test & file/fix bugs and enhancement requests.
 +
* Help planning and implementing new features.
-
== Development channels ==
+
=== Localization ===
-
* The developer discussion happens in the project [https://garage.maemo.org/pipermail/chess-developer/ mailing list].
+
The localization task hasn't started yet and as a matter of fact our string are still not L10n ready. It's in our ToDo list, do you want to help?
-
* We also follow the more user-oriented Talk discussion thread: [http://talk.maemo.org/showthread.php?t=33764 Contributors needed: the killer free chess game for Maemo].
+
-
* With some luck you will find us online at #miniature in irc.freenode.net.
+
-
* Code repository at http://gitorious.org/miniature
+
-
* No bugzilla at this point.
+
 +
=== SDK instructions ===
 +
Currently you can build Miniature with the latest Qt SDK (including the Harmattan target) or the Harmattan Platform SDK. The Miniature sources and commit logs are available at https://gitorious.org/miniature/ . Both SDKs come with an emulator for deploying your app. All the better if you have a Nokia N950 or N9 to test on device.
-
== Architecture ==
+
Instructions to set you Miniature development environment:
-
See the [[Miniature/Development/Architecture|Miniature architecture]] wiki page. (outdated)
+
* [https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk Qt SDK]
-
 
+
* Harmattan Platform SDK instructions are currently missing. fwiw the [[Miniature/Development/Instructions|Maemo Platform SDK]] might help since both are based on Scratchbox...
-
== Strings & localization ==
+
-
We don't have stable strings implemented and therefore the localization task hasn't started yet. See [[Miniature/Development/Strings]].
+
-
 
+
-
== Get involved ==
+
-
New contributors are welcome! You can help testing and bugfixing new releases focusing on the current phase or you can pick one item more distant in the roadmap and go ahead with it. No matter what you do we recommend you to stay on focus.
+
-
 
+
-
See the [[Miniature/Development/Instructions|instructions]] to setup your Miniature development environment. Also, do not forget to install the more [[Miniature/Development/Qt4_for_Maemo5|hildonized Qt4 for Maemo5 package from extras-devel]]!
+
-
 
+
-
There are some [[/Policies | policies]] that we follow in the project.
+
=== Send us patches! ===
=== Send us patches! ===
Line 58: Line 50:
* By issuing a merge request: Send us a link to your public git repo (including branch/revision), or use the merge request feature from http://gitorious.org.
* By issuing a merge request: Send us a link to your public git repo (including branch/revision), or use the merge request feature from http://gitorious.org.
-
== References ==
+
=== Architecture ===
-
* [http://www.craftychess.com/ Crafty] is a free, open-source computer chess program.
+
See the [[Miniature/Development/Architecture|Miniature architecture]] wiki page. (outdated)
-
* [http://www.v7f.eu/public/n800/chess/ EBoard and Crafty] for the N810/N800/N770 - [http://maemo.org/downloads/product/OS2007/chess OS2007 Downloads page].
+
-
* [http://knights.sourceforge.net/ Knights] aimed to be the ultimate chess resource for the K Desktop Environment... years ago.
+
-
* [http://pacaq.sourceforge.net/ pacaq] is a chess game visualizing and analysis tool done with the Maemo 4.1 Qt4 port - [http://talk.maemo.org/showthread.php?t=21793 Talk thread].
+
-
** From all programs on this list, this is the only one were reading the code is worth your time.
+
-
* [http://scid.sourceforge.net/ SCID], a chess database application for Windows, Linux and Mac OS operating systems.
+
-
** See also [http://scid.sourceforge.net/scidpocket.html SCID Pocket]  
+
-
* [http://www.gnu.org/software/xboard/ Xboard] is a graphical user interface for chess in all its major forms.
+
-
* [http://www.freechess.org/ freechess.org] Website of the Free Intrnet Chess Server (FICS)
+
-
** [http://www.freechess.org/Help/AllFiles.html commands reference]
+
== Contributors ==
== Contributors ==
-
* [http://maemo.org/profile/view/mikhas Michael Hasselmann]: lead developer.
 
-
* [http://maemo.org/profile/view/kore Dennis Stötzel]: chess logics.
 
-
* [http://maemo.org/profile/view/hasselmm Mathias Hasselmann]: veteran programmer.
 
-
* [http://gitorious.org/~Malcolm Dariusz Mikulski]: P2P telepathy integration.
 
-
* [http://maemo.org/profile/view/qgil Quim Gil]: documentation.
 
-
* [http://maemo.org/profile/view/kittykat Ekaterina Gerasimova]: Game icon.
 
-
Special thanks to [http://en.wikipedia.org/wiki/User:Cburnett Colin M.L. Burnett] for his free piece set used by Wikipedia.
+
Maintainers:
 +
* [http://maemo.org/profile/view/mikhas Michael Hasselmann]: lead developer
 +
* [http://maemo.org/profile/view/qgil Quim Gil]: UX & documentation
 +
 
 +
Gave a big hand:
 +
* [http://maemo.org/profile/view/kore Dennis Stötzel]: chess logics
 +
* [http://maemo.org/profile/view/hasselmm Mathias Hasselmann]: veteran programmer
 +
* [http://gitorious.org/~Malcolm Dariusz Mikulski]: P2P telepathy integration
 +
 
 +
Special thanks:
 +
* [http://maemo.org/profile/view/kittykat kittykat]: game icon
 +
* [http://en.wikipedia.org/wiki/User:Cburnett Colin M.L. Burnett]: free piece set used by Wikipedia

Revision as of 20:13, 23 August 2011

Contents

The concept

Miniature is a chess board that is always with you, ready to let you play and learn wherever you go.

  • The main use case is playing online against other players at http://www.freechess.org/ (FICS)
  • Now imagine that you can also chat with the other player.
  • Play P2P games against other players next to you or remotely with your Contacts.
  • Learning is important: watch games live, review stored games and also process offline the lessons offered at FICS.
  • And not only regular chess. Think also on Suicide, Crazyhouse...

Miniature is a Qt application with a C/C++ backend and a QML UI. The architecture is modular, thinking on the addition of different servers and types of interaction.

We are targeting our development on MeeGo Harmattan and the Nokia N9 but we welcome maintainers for other ports e.g. MeeGo upstream, Symbian, Android-Necessitas, Qt powered desktops...

Project status

  • 2011-08-15: New Miniature UX concepts integrated to the master branch - the new engine gets a UI (screenshot).
  • 2011-08-13: Miniature can be developed using Qt Creator (instructions).
  • 2011-08-01: Miniature 0.2.1 released! The new Encore engine and the new QML UI, together for the first time. The game can do real seeks but still no real games.
  • 2011-07-27: New UI targetting MeeGo Harmattan developed in parallel - source & packages for Nokia N9/N950.
  • 2011-07-18: engine refactored around Encore, a GNUChess wrapper. This is the beginning of a rewrite.
  • 2011-07-06: request to port to Meego : http://forum.meego.com/showthread.php?p=25031

The Miniature project was born as a proposal sent to the Maemo community on 2009-10-31. Check the archive if you want to dig in the past.


Get involved

Contributions are welcome! This is how you can get started:

  • Download or build Miniature, and tell us what to think.
  • Spread the Miniature love among your Chess friendly contacts.
  • Test & file/fix bugs and enhancement requests.
  • Help planning and implementing new features.

Localization

The localization task hasn't started yet and as a matter of fact our string are still not L10n ready. It's in our ToDo list, do you want to help?

SDK instructions

Currently you can build Miniature with the latest Qt SDK (including the Harmattan target) or the Harmattan Platform SDK. The Miniature sources and commit logs are available at https://gitorious.org/miniature/ . Both SDKs come with an emulator for deploying your app. All the better if you have a Nokia N950 or N9 to test on device.

Instructions to set you Miniature development environment:

  • Qt SDK
  • Harmattan Platform SDK instructions are currently missing. fwiw the Maemo Platform SDK might help since both are based on Scratchbox...

Send us patches!

Found a bug? Spotted code smell? We glady accept patches! There are three ways to send patches to us:

  • By reporting the bug, and hopefully attaching a patch that solves the stated problem (but just reporting bugs is also appreciated).
  • By using the chess-devel mailing list: A ML-friendly patch can be created with "git format-patch HEAD~n", where n specifices how many commits (starting from HEAD) should be converted to patches;
  • By issuing a merge request: Send us a link to your public git repo (including branch/revision), or use the merge request feature from http://gitorious.org.

Architecture

See the Miniature architecture wiki page. (outdated)

Contributors

Maintainers:

Gave a big hand:

Special thanks:

Retrieved from "http://wiki.maemo.org/Miniature/Development"