Miniature/Development
Line 92: | Line 92: | ||
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]]! | 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 110: | Line 112: | ||
* [http://www.freechess.org/ freechess.org] Website of the Free Intrnet Chess Server (FICS) | * [http://www.freechess.org/ freechess.org] Website of the Free Intrnet Chess Server (FICS) | ||
** [http://www.freechess.org/Help/AllFiles.html commands reference] | ** [http://www.freechess.org/Help/AllFiles.html commands reference] | ||
+ | |||
+ | == 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. |
Revision as of 00:19, 23 August 2011
Contents |
Intro
Miniature is a chess board that is always with you, ready to let you play and learn wherever you go.
Miniature is based on the official Qt 4.6 for Maemo and its Graphics View framework. Most of our work focuses on developing a UI layer optimized for mobile touch devices. When it comes to the backend we want to recycle as much as possible from existing chess engines.
The development is guided by the roadmap and is organized by phases bringing new features to our users. The organization of the roadmap is based on a pragmatical implementation of the Miniature concept taking into account features missing in Maemo, existing chess projects and the requests from current and potential users.
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.
- Phase 0: Project setup - DONE
- Currently working on the roadmap item Play Games Online, divided in 3 phases:
- Phase 1.0: Offline chess basics - ONGOING
- Phase 1.1: Online chess basics - NOT STARTED
- Phase 1.2: Online chess advanced - NOT STARTED
- Also starting parallel development on Real-time P2P chess
Download
Currently, there are only unstable packages that can be obtained from Maemo5's extras-devel repositories.
The sources are available at gitorious.org
Development channels
- The developer discussion happens in the project mailing list.
- We also follow the more user-oriented Talk discussion thread: 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.
Roadmap
Work in progress, like all roadmaps.
- Play games online (this milestone will be reached with miniature-0.2)
- Chess game basics, demonstrated off-line.
- Online chess basics, targeting http://www.freechess.org/ first
- Online chess advanced
- Real-time P2P chess
- Chat with your opponent
- Customization
- Download and select different boards and pieces.
- Download and select different engines.
- Asynchronous P2P chess (via email or SMS?)
- Learn chess lessons with moves + text
- Play local tournaments e.g. via Telepathy Tubes
- Play against computer
- Basic need covered by pre-installed Chess app.
- Default engine selection.
- Chess variants
- Display games by you or others, live or stored
- Low priority: Chessmonk is concentrating on this for Maemo 5 => not that urgent for Miniature)
- History of an opening.
- Take a picture of a printed game, process the notations with OCR and display it.
- Display several games at a time.
- Watch game via webcam stream
Proposals
Add your proposals here. Remember to sign them so we know where do they come from. Just explain the brief concept. If you have further explanations post them somewhere and link from here. Thank you!
- Chess clock only function: It would be great to use the N900 as a chess clock only if there is a real board and a "real" opponent is available. The functionality will be in the apllication so a nice UI for this function is all what is needed.--jukey 21:57, 9 November 2009 (UTC)
- Chat via freechess.org should work as plugin for the messages application (xmpp/skype/googletalk/...) at the moment. How could this be done?--jukey 15:21, 18 December 2009 (UTC)
Integrated in the roadmap:
- Possibility to play a game human vs. human offline. In this case the board should flip 180° between two moves.--jukey 21:57, 9 November 2009 (UTC)
- savegame feature for human vs computer and human vs human games cause the game tends to take quite a while.
Architecture
See the Miniature architecture wiki page.
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 instructions to setup your Miniature development environment. Also, do not forget to install the more hildonized Qt4 for Maemo5 package from extras-devel!
There are some policies that we follow in the project.
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.
References
- Crafty is a free, open-source computer chess program.
- EBoard and Crafty for the N810/N800/N770 - OS2007 Downloads page.
- Knights aimed to be the ultimate chess resource for the K Desktop Environment... years ago.
- pacaq is a chess game visualizing and analysis tool done with the Maemo 4.1 Qt4 port - Talk thread.
- From all programs on this list, this is the only one were reading the code is worth your time.
- SCID, a chess database application for Windows, Linux and Mac OS operating systems.
- See also SCID Pocket
- Xboard is a graphical user interface for chess in all its major forms.
- freechess.org Website of the Free Intrnet Chess Server (FICS)
Contributors
- Michael Hasselmann: lead developer.
- Dennis Stötzel: chess logics.
- Mathias Hasselmann: veteran programmer.
- Dariusz Mikulski: P2P telepathy integration.
- Quim Gil: documentation.
- Ekaterina Gerasimova: Game icon.
Special thanks to Colin M.L. Burnett for his free piece set used by Wikipedia.