Intermediate Level bbLean Guide

Intermediate Level bbLean Guide
*****Currently a Work in progress*****
*****And has been for a while. I will work on it again when I have more free time.*****

This is a quick guide to an intermediate level of bbLean use.
*Keep in mind this guide is being written by a complete dunce and there are without a doubt more advanced bbLean users them him. If you have anything to tell this moron (advice/criticism/additional information) visit the current /w/ desktop there and ask for Vibex. He has no life and is almost always there.
*Most of the information here was gotten from http://bb4win.sourceforge.net/bblean/docs/bblean.htm. All I have done is explain some of the concepts in more depth and added some additional information/opinions. If you want a direct copy of all the information without any superfluous crap, the sourceforge page is a far better tool.

CTRL + F to get to the different sections.

@0  -  The Basics
@1  -  Menus
@1a -  Advanced menus
@2  -  Sticky Windows
@3  -  broams
@4  -  Plugins
@5  -  Styles
@6  -  Rainmeter

--------------------------------------------------------------------------------------------------------------

@0*** The Basics
If you are looking to just get started with bbLean for the first time this guide may be a little over your head. It's advised that you read the bbLean section on the /w/ pastebin first (http://pastebin.com/W0SsUtEH) as well as the "Overview" on bbLean sourceforge page (http://bb4win.sourceforge.net/bblean/docs/bblean.htm). Afterwards you can return here to get more information.

--------------------------------------------------------------------------------------------------------------

@1*** Menus
The bbLean menu is one of the easiest things to modify in bbLean. It runs on a simple format. This section will go over the basics of editing the menu.rc file. This section only includes the very basics. Check the advanced section for more advanced (for lack of a better word) commands.
[command]  (label)  {data}
The basic menu commands consist of:
[begin] (label)          =  The beginning of the menu structure.
[end]                    =  Ends the menu or submenu.
[submenu] (label)        =  Adds a submenu. These can be used to save space and hide away less frequently used
			    programs.
[include] {filename}     =  This will add items from the specified file
[nop] (label)            =  Adds a separator with a label.
[sep]                    =  Same as [nop] but without a label (easier to ignore and use [nop] instead).


File access commands:
[exec] (label) {.exe}    =  Used to execute an application directly from the menu (They can also be used to
			    execute a broam. These are talked about more in the advanced menus section and
			    the broam category.).
[path] (label) {folder}  =  Used to make a contained submenu made up of the contents of a folder.


Shutdown Commands:
[logoff] (label) 	   =  Logoff current user.
[suspend] (label) 	   =  Suspension mode.
[hibernate] (label) 	   =  Hibernate.
[reboot] (label) 	   =  Reboot the computer.
[shutdown] (label) 	   =  Shutdown the computer.
[lockworkstation] (label)  =  Lock the current user account.
[switchuser] (label) 	   =  Switch users.

*All shutdown commands can be made quiet (Stop the display of a confirmation message) with the addition of -q in the command section. ex. [logoff -q] (Logoff)


Completed Menu Example:
[begin] (Start)
[path] (C) {C:\}
[exec] (bbStyleMaker) {bbstylemaker.exe}
	[submenu] (Goodbye)
		[logoff -q] (Logoff)
		[shutdown] (Shutdown)
	[end]
[end]

--------------------------------------------------------------------------------------------------------------

@1a*** Advanced Menus
The advanced section covers some of the less frequently used but still (occasionally) useful menu commands.
Advanced File Access Comands:
[path] (label) {folder1|folder2}  =  Same as the [path] command but combines multiple folders into one menu.
[run] (label)                     =  Show the run dialog.
[insertpath] {folder}             =  Adds the items of a folder into the current menu.
[workspaces] (label)              =  Adds the workspace menu.
[tasks] (label)                   =  Adds a menu with the currently open tasks.
[icons] (label)                   =  Adds a menu with the currently minimized tasks.


Blackbox commands:
[gather] (label)    =  Gather the open windows to a single workspace.
[reconfig] (label)  =  Re-read the config files.
[restart] (label)   =  Reload plugins (Causes errors with bbWorkspaceWheel).
[exit] (label)      =  Exits blackbox.

*It is often easier to just kill blackbox.exe with task manager or [exit] instead of [restart] or [reconfig]. This is because those commands, while not always, can cause errors.


Edit commands:
[edit] (label) {file} 	  =  Edit the specified file.
[editstyle] (label) 	  =  Edit the current style.
[editmenu] (label) 	  =  Edit menu.rc file.
[editlugins] (label) 	  =  Edit plugins.rc file.
[editextensions] (label)  =  Edit extension.rc file .
[editblackbox] (label) 	  =  Edit blackbox.rc file.

*All the edit commands open the file with the bbLean text editor bbnote.exe unless otherwise specified in the config file.
*These commands are fairly unnecessary. It is much easier to open the files with your file manager. They are just included here on the off chance someone wants them.


broam Commands:
The specific broam commands are talked about in the broam section.
The way to set up a broam command is exactly the same as the [exec] command.
[exec] (label) {broam}
It's quite a simple process, people just seem to forget about them though so I figured I would mention them here.

--------------------------------------------------------------------------------------------------------------

@2*** Sticky Windows
Another simple feature that people forget about. Sticky windows allow a certain program to stay present on all workspaces. This can be used on dual monitor computers to make only one monitors programs change when switching workplaces. It can be quite useful for things like foobar. All you have to do to add windows to the sticky list is add the .exe name to the stickywindows.ini file in the bbLean folder.

--------------------------------------------------------------------------------------------------------------

@3*** broams
Broadcast messages (broams) are used to trigger actions. They can be sent by a [exec] command in the menu, a hotkey in bbKeys or other means like bbInterface (Note: I have no knowledge of bbInterface. If anyone does let me know and I'll add it in.). They can be quite useful and save you a fair amount of time when doing different tasks.
Window Control:
@BBCore.PrevWindow 	         =  Go to the previous window (Current Workspace).
@BBCore.NextWindow 	         =  Go to the next window (Current Workspace).
@BBCore.PrevWindowAllWorkspaces  =  Go to the previous window (All Workspace).
@BBCore.NextWindowAllWorkspaces  =  Go to the next window (Current Workspace).
@BBCore.RaiseWindow 	         =  Raise window to the top.
@BBCore.LowerWindow 	         =  Send window to the bottom of the stack.
@BBCore.ShadeWindow 	         =  Collapses the window into only the titlebar.
@BBCore.StickWindow 	         =  Makes the window a sticky window.
@BBCore.OnTopWindow 	         =  Make the selected window always on top.
@BBCore.MinimizeWindow 	         =  Minimize the selected window.
@BBCore.MaximizeWindow 	         =  Maximize the selected window.
@BBCore.MaximizeVertical 	 =  Sets window to the maximum height.
@BBCore.MaximizeHorizontal 	 =  Sets the window to the maximum length.
@BBCore.RestoreWindow 	         =  Sends the window to its previous position (I think?).
@BBCore.MoveWindow 	         =  Moves your cursor to the current programs titlebar.
@BBCore.ResizeWindow 	         =  Moves your cursor to resize the window.
@BBCore.CloseWindow 	         =  Closes the selected application.
@BBCore.ActivateWindow           =  Selects the window that was last used.
@BBCore.MinimizeAll 	         =  Minimize all windows.
@BBCore.RestoreAll 	         =  Unminimizes all windows.
@BBCore.Cascade 	         =  Cascades windows.
@BBCore.TileVertical 	         =  Tile windows vertically.
@BBCore.TileHorizontal           =  Tile windows horizontally.

*An actual Window manager like AHK (Before you bitch at me, I know AHK isn't actually a window Manager, but you know what I mean.), bug.n or windawesome are recommended over the @BBCore.Cascade,  @BBCore.TileVertical, and @BBCore.TileHorizontal commands. These Window managers can be read about in Shiros pastebin or researched on Google.

*****More to come later******

--------------------------------------------------------------------------------------------------------------

@4*** Plugins
Most plugins only work with 32 bit OS. This is quite stupid and I wish there was something that could be done about it. Unfortunately there isn't. Instead this section will cover the editing of the default plugins that come with bbLean and there different uses.

Ignore these programs and disable them. They are very idiotic and why the hell would you use them.
bbAnalog
bbIconBox
bbSlit (Most of the time. This one is occasionally useful depending on what your doing.)

The useful (default) plugins consist of:
bbLeanbar
bbLeanbar2 (For dual monitors) (You have to make this one yourself. It is talked about more below.)
bbKeys (Optional though highly recommended)
bbColor3dc (Optional for classic themes)
bbWorkspaceWheel (Optional)


bbLeanbar and bbLeanbar2:
To add additional bbLean bars all you have to do is copy and paste the bbLeanbar plugin folder and rename it bbLeanbar2. Then add the new .dll as a new plugin. The only down side to using a second bar on dual monitors is that you can no longer use the CTRL + Right Click menu to change settings for the bars (Technically you can but the changes will take effect on both bars. Not really a big deal though because you can just edit the setting in the bbLeanbar.rc file. Another thing is if you open the .rc file from the CTRL + Right Click menu it will open the .rc file for both bars (some of the time, not always). This method can be repeated as many times as you see fit to cover all your monitors. In the rainmeter section I talk about how to get the bbLean bar working with rainmeter skins like bb-bar.


bbKeys:
bbKeys is one of the most useful plugins for bbLean. It allows you to easily navigate windows, workspaces, execute programs, or use broams. The keys command line is very simple. The format is
KeyToGrab(),        WithModifier(),         WithAction()
The first input is for the base key press. This is the name of most keys. A very simple input.
*You can use keys like Win here, but you must specify LWIN or RWIN.
*I'm currently unaware of the keyname for Numpad up, down, left, and right. If you happen to know the key titles please let me know.

The  second section is for a modifier. While these aren't necessary they are recommended in most cases. These can be Win, Shift, Ctrl, Alt in most cases, but any key should work in theory. You can use multiple modifiers by using "key 1" + "key 2".

The third section is what actually occurs because of these keypresses. This can be a broam or an exec command. An example of a finished key setup would be
KeyToGrab(1),        WithModifier(Win),      WithAction(Workspace1)


bbColor3dc:
*This section was stolen from Shiro's pastebin, for I am far to lazy to write my own synopsis. Also I have no experience with 3DCC.

-Using Windows Classic + 3DCC Themes for Bblean-
What is 3DCC?
3DCC is a small tool which allows you complete control over your windows color schemes,
much more than available through the standard windows display preferences.

Installation:

  1. Put bbColor3dc.dll somewhere in the blackbox\plugins folder.
  2. Load it from the plugin-config menu, or add it's relative path
     to "plugins.rc".

To use 3DCC Themes with bblean, make a folder in your bblean/styles directory named "3dc".
Create a theme with the program, and save the file with the same name as your style.
For example, bb_crim.3dc to work alongside bb_crim.style
You can then apply the theme by loading your style via the bblean menu.
This only works well with windows classic as a visual style.
Note: The folder MUST be named "3dc" to work properly.
A readme can be found in your bblean/plugins/bbColor3dc folder.

Download: http://dl.dropbox.com/u/1840925/3dcc4-en.zip
Color Pack: http://pixelfuckers.org/submissions/934


bbWorkspaceWheel:
Not much to say on this one. It allows you to scroll through your workspaces with the scroll wheel while hovering over the desktop. It should allow you to scroll both up and down and reach different workspaces. Occasionally it doesn't work properly. To fix this kill bbLean and reload it. You cannot use commands like restart when also using bbWorkspaceWheel. This will cause errors that will disable bbWorkspaceWheel.

--------------------------------------------------------------------------------------------------------------

@5*** Styles
Styles are a very simple thing to make in bbLean. First open the bbStylemaker. Second change the colors to match your style. Third... nothing your already done. If you need a base to start off, because your incompetent, try bb_crim (http://apathyrecharge.deviantart.com/art/bb-crim-318532742).

--------------------------------------------------------------------------------------------------------------

@6*** Rainmeter
While rainmeter is not actually a part of bbLean they are often run together. The most common skin is bb-bar by hora-hora (http://hora-hora.deviantart.com/#/d5f01s0). Another skin used by many is systemcombo by, you guessed it, hora-hora (http://hora-hora.deviantart.com/gallery/#/d4zzp8y). A fairly new addition to the bb series of scripts is bb_RainPower (http://demonessyume.deviantart.com/art/bb-RainPower-1-0-354718015), by our good friend Shiro/demonessyume/Whatever other names he is using. While these are the only three real "published" skins that work with bbLean, there are many custom ones that people have made.
To use a skin install it like you would any rainmeter skin. Then edit the bb_bg_bar to the proper proportions of your bbLeanbar. Load it on position normal. Next edit bb_bar (or whatever you are using) to your hearts content. Now load bb_bar at positon normal and load order 1. Now you have to edit the width of your bbLeanbar so that it doesn't overlap with the rainmeter. Change the width percent with the Ctrl+right click menu (or in the .rc file if you have multiple bars). Now your done. A very simple addition but adds a lot of possibilities.

--------------------------------------------------------------------------------------------------------------

Credits:
Written and Maintained by Vibex !FL2K7hnbFY.
Helped by Shiro !i.Neko0OEM(format, original idea, and stole some of the info off of his pastebin.)

Special thanks to:
Ling for reminding me I was going to write this guide.
Whoever the fuck created bbLean.
And all of /w/, except for you. You were entirely useless.