Skin

From ScapeFX Wiki

Jump to: navigation, search

ScapeFX can be customized by writing and adding a skin plugin. This will change the appearance of the user interface of the client. It will modify things such as background images, scrollbars, buttons and menus.

This is the file structure of a custom skin.

/sampleskin
   /buttonUI
      button_left.png
      button_middle.png
      button_right.png
   /commandline
      input_bg.png
   /frameUI
      close_button.gif
      frame_top.png
      icon.gif
      maximize_button.gif
      minimize_butotn.gif
      profileFrameBg.png
   /menuUI
      bottombar.png
      menu_bg.png
      menu_expand_arrow.png
      menu_radio_checked.png
      menu_radio_unchecked.png
      menuitem_bg.png
      menuitem_hover_bg.png
      popup_menu_bg.png
   /scrollBarUI
      scroll_bar.png
      scroll_bg.png
      scroll_down.png
      scroll_up.png
   /statusbarUI
      button_left.png
      button_middle.png
      button_right.png
   /tabUI
      tab_active_left.png
      tab_active_middle.png
      tab_active_right.png
      tab_inactive_left.png
      tab_inactive_middle.png
      tab_inactive_right.png
   /wallpapers
      default.jpg
      default2.jpg

The /wallpapers folder may contain any number of images. The wallpapers are added to the skin with the setWallpapers() method in the ScapeFXPlugin_Skin class. This method should be called in the constructor of your custom skin. The SampleProject should have an example of a custom skin plugin.