Miniature/Development

(Project status)
(Get involved)
Line 56: Line 56:
* Spread the Miniature love among your Chess friendly contacts
* Spread the Miniature love among your Chess friendly contacts
* 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]
* 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]
 +
* Fix an open bug in the [[Miniature/Development/Backlog|Backlog]], for instance an [https://bugs.maemo.org/buglist.cgi?keywords=easyfix&query_format=advanced&keywords_type=allwords&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Miniature&classification=Extras easyfix].
* Help planning and implementing [[Miniature/Wishlist|new features]]
* Help planning and implementing [[Miniature/Wishlist|new features]]
* Help porting Miniature to more platforms
* Help porting Miniature to more platforms

Revision as of 23:26, 24 August 2011

The Berlin Defence, as seen in Miniature

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 news

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.

Project status

Tasks for the next release get a HIGH priority. All the rest falls in the Backlog.

Miniature 0.4 release

IDSummary (13 tasks) SeverityPStatus
12341Filter buttons for FICS seeks could be simplerenhancementHighNEW
12356Miniature should remeber the value used the last timeenhancementHighNEW
12376Miniature should be able to resume adjourned FICS gamesenhancementHighNEW
12411OnlineBoard: Implement game end dialog for abort during move 1enhancementHighNEW
12421Vibration or sound notification if opponent movesenhancementHighNEW
12367Seek search filters don't workmajorHighNEW
12424[Discussion] OnlineBoard: Implement a better game's end dialogmajorHighNEW
12434SeekGame doesn't filter Atomic gamesmajorHighNEW
12525Clock keeps running after finishing a gameminorHighNEW
12380Miniature doesn't handle "unseek"normalHighNEW
12414OnlineBoard: Implement dialog for abort requestsnormalHighNEW
12433End game confirmation dialogs should lead to gameoverDialognormalHighNEW
12524Chat is cut when a game is finishednormalHighNEW

Backlog

IDSummary (20 tasks) SeverityPStatus
8142Chess games logs need to be stored somewhereenhancementLowNEW
12346Miniature needs a proper repositorynormalMediumNEW
12348Miniature for MeeGo CE doesn't show TextFieldmajorMediumNEW
12354List of games: Show available game offers onlynormalMediumNEW
12360List of games: Function of the Back-Arrow unclear. Confirmation Dialogue needed?normalMediumNEW
12392Show how much material is left for each playerenhancementLowNEW
12396Implement dialog for challangesenhancementMediumNEW
12410OnlineBoard: Implement item "abort" in back menuenhancementMediumNEW
12413The chat log doesn't show the last line when the local user postsnormalMediumNEW
12422Show application close button in the upper right cornerminorLowNEW
12423Extend chat featureenhancementMediumNEW
12427Miniature doesn't handle adjourn requestsnormalMediumNEW
12431SeekGames: Do not show more than 50 games in the list at once (was: Implement "clear list" function)enhancementMediumNEW
12439Enable breadcrumbs in the wiki (miniature-chess.org)enhancementMediumNEW
12443FICS Setting: Implement an option to send game notation after a game endsenhancementMediumNEW
12469Initial value of localSide.rating == 0 for Miniature registered usersminorLowNEW
12504after failed login, VKB pops up even if in info screenenhancementMediumNEW
12539Installation on the N900 failscriticalUnspecifiedNEW
12583No hint that starting new games is impossible (number of adjourned games to high)majorUnspecifiedNEW
12592qtquickcompat is needed, but not listed as DependsnormalUnspecifiedNEW

Get involved

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

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:

Gave a big hand:

Special thanks: