Miniature/Development
| Line 14: | Line 14: | ||
== Project status == | == Project status == | ||
| - | |||
* 2011-08-15: New Miniature UX concepts integrated to the master branch - the new engine gets a UI ([http://wiki.maemo.org/images/2/25/2011-08-12_16-25-47.png screenshot]). | * 2011-08-15: New Miniature UX concepts integrated to the master branch - the new engine gets a UI ([http://wiki.maemo.org/images/2/25/2011-08-12_16-25-47.png screenshot]). | ||
* 2011-08-13: Miniature can be developed using Qt Creator ([https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk instructions]). | * 2011-08-13: Miniature can be developed using Qt Creator ([https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk instructions]). | ||
| Line 23: | Line 22: | ||
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 involved == | == Get involved == | ||
Contributions are welcome! This is how you can get started: | Contributions are welcome! This is how you can get started: | ||
| - | * Download or build Miniature, and tell us what | + | * [[Miniature#Download|Download]] or [[#SDK instructions|build]] Miniature, and [[Miniature#Contact us|tell us]] what you think |
| - | * Spread the Miniature love among your Chess friendly contacts | + | * Spread the Miniature love among your Chess friendly contacts |
| - | * Test & file/fix bugs | + | * Test the game and [https://bugs.maemo.org/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=Miniature&content=file/fix bugs] |
| - | * Help planning and implementing new features | + | * Help planning and implementing [[Miniature/Wishlist|new features]] |
| + | * Help porting Miniature to more platforms | ||
=== Localization === | === Localization === | ||
| - | The localization | + | The localization work 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 === | === 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. | 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. | ||
| Line 54: | Line 52: | ||
== Contributors == | == Contributors == | ||
| - | |||
Maintainers: | Maintainers: | ||
* [http://maemo.org/profile/view/mikhas Michael Hasselmann]: lead developer | * [http://maemo.org/profile/view/mikhas Michael Hasselmann]: lead developer | ||
Revision as of 20:26, 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 you think
- Spread the Miniature love among your Chess friendly contacts
- Test the game and bugs
- Help planning and implementing new features
- Help porting Miniature to more platforms
Localization
The localization work 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:
- Michael Hasselmann: lead developer
- Quim Gil: UX & documentation
Gave a big hand:
- Dennis Stötzel: chess logics
- Mathias Hasselmann: veteran programmer
- Dariusz Mikulski: P2P telepathy integration
Special thanks:
- kittykat: game icon
- Colin M.L. Burnett: free piece set used by Wikipedia