My favorites | Sign in
Project Logo
                
Search
for
Updated Sep 08, 2008 by sgbeal
Labels: Featured, Docs-User
HOWTOGettingStarted  
Getting started with QBoard

HOWTO: getting started with QBoard

This guide gives a brief overview of how to get started with QBoard and how to use its more significant features.

For instructions on compiling QBoard, see the CompilingQBoard page.

First: QBoard Home Directory

To allow us to save relative paths in our data files, we need a common root directory which is portable across platforms. To that end, we request that you store all QBoard-related data files under the QBoard home directory (~/.QBoard). QBoard tries its best to make sure you stay inside the home directory. For example, when loading graphics files for pieces and boards, it uses a path relative to the home, if possible, as this makes the saved data portable to other machines (or if the QBoard home dir changes).

Graphics Files

Before getting started with QBoard, you will need to put some files in the home dir, namely:

You may structure your data however you like under the home directory, with the exception that the subdirectory named QBoard is reserved for use with QBoard-specific application data. If you need some ideas, see the available Gamesets.

Loading Files

Saving

Manipulating items

Most items have a popup menu (accessible via right-clicking). If an item is selected and its menu is activated, many of the menu operations may apply to all selected pieces (e.g. Destroy, Cut/Copy, rotation, etc.). If a piece is not selected, actions taken through its popup menu will affect only that item (and potentially child items).

Explore the menus for the available options. Note that different types of game pieces will have different menus.

Minimaps

QBoard has a main board view and any number of "minimaps", which are simply copies of the board view which start out at a smaller scale. The minimaps can be zoomed in/out to any degree the main map supports by using Ctrl-ScrollWheel while hovering over the view.

However - having any scaled board view active drastically cuts performance of on-board drag operations, especially once a few items are selected. As in "unusably slow". There are two known workarounds:

In any case, try to avoid zooming the main view unless you need it temporarily. There's a hotkey to zoom back to 100% - look in the Board menu of QBoard for the key combination.

If you don't use minimaps, it is normally a good idea to turn on GL mode on the main board, as doing so drastically speeds up any operations when the board is scaled. However, GL mode is known to cause graphics glitches at times (e.g. pieces become temporarily invisible).

Piece style templates

The colorful squares in the bottom/left of the main window are piece style templates. If you click one of those, newly-added pieces will take on that style. Use the right-click menu to edit them. You can also paste items copied from the board into this area, so you can customize your templates in any ways you like, including adding new ones or removing them.

The templates area is saved automatically when QBoard exits. If you have hosed your templates beyond repair and want to start with a new set, close QBoard, delete the file ~/.QBoard/QBoard/persistance/MainWindow/default-templates, then start QBoard. Deleting or replacing the file while QBoard is open will have no effect, as the file will be replaced or overwritten when QBoard exits.

The clipboard

Most in-play objects can be copied, cut, and pasted within the board. When objects are copied or cut, their data is available as text in the Qt clipboard, which means you can paste it into another application (e.g. a text editor). From there, you can edit it, copy it, and paste it back into QBoard. Some people might call that cheating, but this ability is often useful for testing, or even as a poor man's substitute for File-->Save. It's also useful for pasting in sets of pieces which are commonly used.


Sign in to add a comment
Hosted by Google Code