argh-amp
By Andy Dufilie (^Andy)

Note: This readme file will not be updated for a while. There are a lot of changes in the script that I am going to make before doing so.

Sections:

1. Introduction
2. Features
3. "/aamp" Command
4. Keyboard Shortcuts
5. Playlist
6. GUI Editor
7. Sharing Skins
8. Example Skins
9. Screenshot of Example Skins
10. Greetings
11. Website

1. Introduction

Argh-amp was originally made for the "Best picture-window mp3 player" challenge on www.mircscripts.org, with the restriction of it being no bigger than 10k (10240 bytes) in one .MRC file, with no external files.

The reason why the GUI might be a little slow is because I had to cut down the size in order to fit it all in 10k. Speed was sacrificed to save space.

I am currently making adjustments to this script (faster, more features).
If you install mp3stuff also, there will be an option in the argh-amp popup to integrate with mp3stuff (unloading stuffamp is recommended).

The original, slow, challenge-entry version can be downloaded here.
For the newest version of this script, click here.

[Back to top]


2. Features

You can use keyboard shortcuts instead of the popups and buttons on the window.

There is an "Easy Move" option in the popup so you can drag the player window without having to click on the titlebar. This option makes it so you don't have to have a titlebar in the current skin to be able to move the window around.

There's a GUI Editor that you can use to make your own skins and share them with your friends.
You can switch easily between saved skins using the [ and ] keys, and you can change layout or colors individually (see keyboard shortcuts).

Argh-amp has a basic playlist, which lets you add and remove files and directories.
You can also move mp3s up and down in the playlist with the INSERT & DELETE keys (other keys weren't reliable).

You can choose to have the "Eject" button open the playlist instead of opening up the dialog to choose an mp3. In the popup, this option is labeled "Eject opens playlist."

[Back to top]


3. "/aamp" Command

To start the player, type /aamp
If you want to pick a skin in your .skn file, use /aamp <number>
To load the default skin, use /aamp 0
To load a skin that someone wants to share with you, use /aamp <skin definition>

[Back to top]


4. Keyboard Shortcuts

KeyFunctionName in GUI Editor
UP
DOWN		Volume controlVolume
ZJump to previous mp3 in playlistPrev
XPlay from start/UnpausePlay
CPause/UnpausePause
VStopStop
BJump to next mp3 in playlistNext
LChoose an mp3 or open playlist
(depending on current settings)		Eject
OChoose an mp3 to play-
POpen playlist-
[
]		Change entire skin-
SHIFT + [
SHIFT + ]		Change colors without changing layout-
CTRL + [
CTRL + ]		Change layout without changing colors-

[Back to top]


5. Playlist
To open the playlist, select "Open playlist" in the popup, or press P.

Options

Options regarding the playlist can be found in the popup menu.
"Auto-advance" will automatically open the next mp3 in the playlist after a song finishes.
"Random," when enabled, will open a random mp3 in the playlist when you click the "Next mp3" button, or when a song finishes and you have "Auto-advance" enabled.

Adding & Removing Files

To add or remove files or directories, right-click in the playlist window and use the popups.
"+ File" will add single files.
"+ Dir" will sort & add a directory (including files in sub-directories).
"- Sel" will remove the selected mp3s from the playlist.

Sorting the playlist

To sort the playlist by directory & filenames, right-click in the playlist window and click "Sort."

Moving mp3s in the playlist

To move the selected mp3s up, press INSERT.
To move the selected mp3s down, press DELETE.

The reason these keys are used is that most of the other keys might have unwanted effects on the selected lines.


[Back to top]


6. GUI Editor
To open the GUI Editor, select "GUI Editor" in the popup.

Types of lines in GUI Editor window

There are 6 types of lines in the GUI Editor.
The Text.Titlebar line is for the title bar text. Click once on it to edit the text.
Font.* lines are for font face. Click once on them to edit the font face.
FontSize.* lines are for font size. Click once on them to edit the font size.
Option.* lines are for ON/OFF options. Click once on them to toggle the options.
Color.* lines are for colors. Click on them once to change the RGB value. You can enter both formats for RGB colors.
All other lines are for the position & size of controls. Select these, then you can edit them as described below.

Moving controls

To move parts of the layout, select the lines you want to edit, then drag the mouse on the player window.
Note that if you don't want certain controls on the window, you can just move them out of sight.

Changing width & height

To change width and height of controls, hold the SHIFT key while dragging the mouse.
NOTE: There is no code that prevents you from making controls have negative size, so if you make it ugly, it's your own fault.

Volume & position bar can be horizontal or vertical

Both bars can be either horizontal or vertical.
To make one vertical, just make it taller than it is wide, and vice versa for horizontal.

Changing volume & position bar knobs

To change width and height of a knob, hold the CTRL key while dragging the mouse.

Arrow keys

When the player window is active, you can use the arrow keys instead of the mouse to nudge controls by 1 pixel.
SHIFT and CTRL are also supported when using the arrow keys.

Saving your work

To save your work, right-click in either the player window or the editor window, and select "Save."
This will save a copy of the current skin without overwriting any existing skin.

Deleting saved skins

To delete unwanted skins, simply right-click in the player window after loading the unwanted skin, and click on "Delete."
To drop all changes and revert to a saved skin, select "Reload" in the popup.

Lines in GUI Editor

LineDescription
Width/HeightWidth and height of main window
TitlebarPosition & size of titlebar
MinimizePosition & size of "Minimize" button
ClosePosition & size of "Close" button
PrevPosition & size of "Previous mp3" button
PlayPosition & size of "Play" button
PausePosition & size of "Pause" button
StopPosition & size of "Stop" button
NextPosition & size of "Next mp3" button
EjectPosition & size of "Eject" button
SongPosition & size of song title display
TimePosition & size of time display
kbpsPosition & size of kbps display
kHzPosition & size of kHz display
VolumePosition & size of volume bar (and size of knob, editable with CTRL)
Position-barPosition & size of position bar (and size of knob, editable with CTRL)
Font.SongFont for song title
FontSize.SongFont size for song title
Font.TimeFont for time display
FontSize.TimeFont size for time display
Font.QualityFont for kbps and kHz
FontSize.QualityFont size for kbps and kHz
Font.TbFont for titlebar text
FontSize.TbFont size for titlebar text
Text.TitlebarText to display in the titlebar (can be blank)
Option.Center-Title1 = Center the titlebar text
0 = Draw the text starting from the left side of the titlebar
Option.Main-Border1 = Display a border around the main window
0 = Don't display the border
Option.Alt-Borders1 = Display alternate borders for buttons, edits, etc.
0 = Default borders
Option.Label-Move1 = Labels move when buttons are pressed
0 = Labels don't move
Color.Button-LabelButton label color
Color.Button-Label2Button label color when pressed
Color.ButtonButton face color
Color.Button2Button face color when pressed
Color.MainMain window color
Color.FrameBorder color, usually black
Color.ShadowBorder color, usually dark gray
Color.3DLightBorder color, usually light gray
Color.HilightBorder color, usually white
Color.TitlebarActive titlebar color
Color.Titlebar2Inactive titlebar color
Color.Titlebar-TextActive titlebar text color
Color.Titlebar-Text2Inactive titlebar text color
Color.EditBackground color for song title, time display, kbps, kHz, Volume, and Position-bar
Color.SongColor of the song title
Color.TimeColor of the time display
Color.QualityColor of the kbps and kHz text
Color.KnobColor of the knob on Volume and Pos-bar
Option.Knob-Border1 = Show a border around knobs
0 = No border


[Back to top]


7. Sharing Skins

To share skins with your friends on IRC, right-click in the argh-amp window, and click on "Copy to clipboard."
Paste it into mIRC, and your friends can type "/aamp <what you pasted>" to view the skin.
They can then save the skin by right-clicking in the argh-amp window and selecting "Save."

[Back to top]


8. Example Skins

You can copy any of the following commands to view example skins for argh-amp.
Note: I asked fubar if I could include this in the readme, and he said it was ok as long as the script didn't read the file, the user has to copy it.

^Andy:

[Copy]
[Copy]
[Copy]
[Copy]
[Copy]
[Copy]
[Copy]
[Copy]
[Copy]
[Copy]
[Copy]

nacitar:

[Copy]
[Copy]
[Copy]
[Copy]

Magnus:

[Copy]
[Copy]
[Copy]
[Copy]

EvilXeroX:

[Copy]
[Copy]

oS\2:

[Copy]


[Back to top]


9. Screenshot of Example Skins

This screenshot displays all of the example skins above.

[Back to top]


10. Greetings

adidos, Avalanche, besouro, B1z, cHIN^, crazy2k, Dark_Greg, Deleted, dephekt, dohcan, Eric^^, eXonyte, fubar, fxd, gzerod, IRN-BRU, jreg, Kamek, Ken, Lisa^B, Lord-aZ, Magnus, mast`, Matrix, m0rph, nacitar, nimper, Nuke, nukem, oMri^^, Oracel, oS\2, sedative, Shikkie, sh0cknock, SirNo3DfX, spion, Stevon, tabo, Tiernan, Tig0ti, ^TwoSock^, vague, Variant, wshs, xdxc, xenu, yermom, Yardiff, Ymar, ...

P.S. nacitar is buggy, i no can fix

[Back to top]


11. Website

http://pages.cthome.net/pdufilie/

[Back to top]