~~META:
creator       = StarHawk
&description abstract = Places a background image behind the console to make it easier to read.
~~
~~NOCACHE~~
====== ConsoleBG (2.2) ======


===== Plugin Information =====

^   Information  ^^
^   Developer:| [[:user/StarHawk|StarHawk]] |
^   Download:| [[http://windower.net/plugins/ConsoleBG.dll | ConsoleBG]]|
^   Download Count:| [dlcount]consolebg[/dlcount] |
^   Support:| [[http://www.windower.net/forums/viewforum.php?f=22 | Click Here]] |
^   Release Date:| August 27th, 2007 |
^   Changelog:| [[:plugins:consolebg:changelog | Click Here]] |

===== What is ConsoleBG =====

This plugin basically puts a configurable background behind the console to make it much easier to read the console text. This helps a great deal when in bright areas.

===== Usage =====

[[ConsoleBG]] can be loaded by opening your Windower console and typing //load consolebg//. [[ConsoleBG]] is autoload friendly, one can add the //load consolebg// command to their **init.txt** file in the **scripts** folder where Windower resides. See the [[#Commands]] section to learn how to configure [[ConsoleBG]].



===== Commands =====

<code>.consolebg command</code>

  * **color** //Alpha Red Green Blue// - To set the color use the numbers 0-255
    * <code>.consolebg color 100 255 255 255</code>
  * **color** //Red Green Blue// - To set the color use the numbers 0-255 excluding alpha channel
    * <code>.consolebg color 255 255 255</code>
  * **position** //X Y// - To set the position of the upper-left corner of the background
    * <code>.consolebg position 10 200</code>
  * **size** //Width Height// - To set the size.
    * <code>.consolebg size 500 200</code>
  * **image** //imagename.extention// - To set a background image set the image you want to use in the same **\Plugins\** directory.  Note that you may need to use the color command and set the color and alpha to 255 for your image to show properly.
    * <code>.consolebg image testimage.jpg</code>
  * **imagerepeat** //WidthRepeat HeightRepeat// - To set the image to repeat, each number represents how many times you want the image to repeat.
    * <code>.consolebg imagerepeat 2 4</code>
  * **fitimage** - To make the console auto-size to the size of the image-- this requires no arguments.
    * <code>.consolebg fitimage</code>