diff --git a/docs/gui_skinnig_howto.txt b/docs/gui_skinnig_howto.txt index 66f05a88..548fab62 100644 --- a/docs/gui_skinnig_howto.txt +++ b/docs/gui_skinnig_howto.txt @@ -1,36 +1,38 @@ ++++++++++++++++++++++++++++++++++++++++ -How to skinning PokerTH GUI +How to create a skin for PokerTH ++++++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++ 1. Game Table Styles +++++++++++++++++++++++ -1.1 Start building a game table --------------------------------- -The best way to start building a custom PokerTH game table is to take a look into defaulttablestyle.xml. -You will find this file in the source code or into your >= 0.6.5 installation path of PokerTH in subfolder data/gfx/gui/table/default/. +1.1 Creating a game table +----------------------------- +The best way to start building a custom PokerTH game table is to take a look at the file "defaulttablestyle.xml". +You can find this file in the source code in the installation path of PokerTH >= 0.6.5 in the subfolder data/gfx/gui/table/default/. The defaulttablestyle.xml is the control center of your style. The file also contains comments which describe the use of the controls. -Maybe you like to play around with the default table to see how the controls will work. Therefore you should copy the whole -data/gfx/gui/table/default/ directory to another place. For better overview in "game table styles" list in settings please at first change - to . Maybe you also like to rename the -defaulttablestyle.xml to mycustomstyle.xml or something similar and directory name "default" to "mycustomtable" or something similar. -Now you can start tweaking color values or change/edit gfx files. +Maybe you would like to play around with the default table to see how the controls will work. To do this, you should copy the whole +data/gfx/gui/table/default/ directory to another place. In order to avoid confusing styles, please first change the description + to (e.g.) . It is recommended to also +rename the defaulttablestyle.xml to mycustomstyle.xml or something similar, and the directory name "default" to e.g. "mycustomtable". +Now you can start playing around with color values or change/edit graphics files. -1.2 Test your style +1.2 Testing your style -------------------------------- -To test your style just load it into PokerTH with "Settings" -> "Style" -> "Game Table Styles" --> "Add ...". -When you have selected your file the value of "StyleDescription" is shown in the list. Select this entry in the list and click "Activate". -Closing the Settings dialog will refresh the style of the game table. +In order to test your style simply load it in PokerTH using "Settings" -> "Style" -> "Game Table Styles" --> "Add ...". +After you have selected your file the value of "StyleDescription" is shown in the list. Select the corresponding entry and +click "Activate". Closing the Settings dialog will refresh the style of the game table. -If you do changes in your mycustomstyle.xml there is no need to re-add it into settings or restart PokerTH. The simplest way is just -to open settings dialog and close it immediately. This will refresh the game table style and show your changes. +If you change your mycustomstyle.xml there is no need to re-add it in the settings or to restart PokerTH. The simplest way is +just to open settings dialog and close it immediately. This will refresh the game table style and show your changes. -1.3 Distribute your style +1.3 Distributing your style ------------------------------- +TODO: Edit this. + When your style is ready to distribute you should complete the style information StyleDescription, StyleMaintainerEMail and Preview. The best way for Preview will be a screenshot of the style running in PokerTH. @@ -49,28 +51,28 @@ every style will be added, but if everything works fine and the legal issues are 2.1 Start building a card deck -------------------------------- -Setup a card deck is not so complex like the game table. The xml file is only used for StyleDescription, StyleMaintainerEMail and Preview. -Going throught the data/gfx/cards/default/defaultdeckstyle.xml you will find the needed infos to set this values. +Setting up a card deck is not as complex as the game table. The xml file is only used for StyleDescription, StyleMaintainerEMail and Preview. +In the file data/gfx/cards/default/defaultdeckstyle.xml you will find all required information to set these values. -Maybe you like to play around with the default card deck. Therefore you should copy the whole data/gfx/cards/default/ directory to another place. -For better overview in "card deck styles" list in settings please at first change -to . Maybe you also like to rename the defaultdeckstyle.xml to mycustomcardstyle.xml -and directory name "default" to "mycustomdeck" or something similar. -Now you can start change/edit gfx files. +Maybe you would like to play around with the default card deck. To do this, you should copy the whole data/gfx/cards/default/ +directory to another place. In order to avoid confusing "card deck styles" please first change the description + to e.g. . +It is also recommended to rename the defaultdeckstyle.xml to e.g. mycustomcardstyle.xml and the directory name "default" to "mycustomdeck" +or something similar. Now you can start changing/editing graphics files. If you take a look into all files from 0.png to 51.png you will see which card value belongs to which number. -It is VERY IMPORTANT to let the filenames untouched. PokerTH will always take 0.png for "diamond 2", 51.png for "club ace" and -24.png for "heart king" for example. Also a flipside image called "flipside.png" have to be into the card deck directory. +It is VERY IMPORTANT to leave the filenames untouched. PokerTH will always take 0.png for "diamond 2", 51.png for "club ace" and +24.png for "heart king" for example. Also a flipside image called "flipside.png" has to be in the card deck directory. -The SIZE for all cards should be 48x76 pixel. If the size of an imgage will not fit 48x76 pixel PokerTH will scale it automatically. -But picture scaling will cause some speed losses when drawing animations and something like this. +The SIZE for all cards should be 48x76 pixel. If the size of an imgage does not fit into 48x76 pixel, PokerTH will scale it automatically. +But this picture scaling might cause speed issues for example when drawing animations. -2.2 Test your deck +2.2 Testing your deck -------------------------------- -To test your deck just load it into PokerTH with "Settings" -> "Style" -> "Card Deck Styles" --> "Add ...". -When you have selected your file the value of "StyleDescription" is shown in the list. Select this entry in the list and click "Activate". -Closing the Settings dialog will refresh the style of the card deck. +In order to test your deck simply load it into PokerTH using "Settings" -> "Style" -> "Card Deck Styles" --> "Add ...". +After you have selected your file the value of "StyleDescription" is shown in the list. Select the corresponding entry and +click "Activate". Closing the Settings dialog will refresh the style of the card deck. If you do changes in your mycustomcardstyle.xml there is no need to re-add it into settings or restart PokerTH. The simplest way is just to open settings dialog and close it immediately. This will refresh the card deck style and show your changes. @@ -78,6 +80,8 @@ to open settings dialog and close it immediately. This will refresh the card dec 2.3 Distribute your deck ------------------------------- +TODO: Edit this. + When your card deck style is ready to distribute you should complete the style information StyleDescription, StyleMaintainerEMail and Preview. Next step is editing the copyright.txt. Here you need to change "Maintainer" to your name and "EMail" to your valid mail address.