Docstoc

RTS Arcade

Document Sample
RTS Arcade Powered By Docstoc
					                 RTS Arcade User Documentation
Background
RTS Arcade was originally created in 2002. It was an application developed out of necessity. I could not
find an application that would allow me to run the MAME ROMs without using a keyboard or a mouse. I
wanted to create an arcade cabinet to house a MAME machine. I found some really nice applications that
would manage and run the ROMs. The problem was that they all required a mouse and or keyboard. None
of them would work with a joystick and a couple of buttons. That’s when I decided to write my own. I took
some input from a couple of friends and started out on my own.

RTS Arcade started out as a simple application to scroll up and down through the list of ROMs. It also
contained the alphabet bar along the bottom to jump to a section of the ROM list. The third thing it allowed
you to do is execute the ROM by pressing a user assignable button.

It has only grown from there.

The RTS Arcade suite consists of two applications:
      RTS Arcade – The ROM launching application
      RTS Config – The configuration application

RTS Arcade still has the same functionality it started out with, but it has a lot more functionality available:
      Show a Title and Screen shot of the selected ROM
      Page through the list of ROMs
      Show detailed information about the selected ROM
      Allow a ROM to be associated with a Hot Key
      Allow emulators other than MAME (NES, SNES, N64, …)
      Allow other emulators to be dynamically added
      Optionally show the Flyers, Marquees, & Cabinet images
      Allow RTS Arcade to shutdown the computer

This document will describe the basic usage of these two applications.




Page 1                                RTS Arcade User Documentation                                  12/27/2005
RTS Arcade




This screen shot shows the basic interface of RTS Arcade. It consists of 4 areas:
       ROM List              The list of ROMs in the center of the screen
       ROM Information The left hand side of the screen that shows the information for the selected
                             ROM
       ROM Images            The optional cabinet and flyer images for the selected ROM
       Alphabet Bar          The alphabet shown at the bottom of the screen

The user scrolls up and down with the Player 1 joystick in order to highlight a ROM. As the ROM is
selected, the detailed information about the ROM is shown on the left pane. The optional cabinet and flyer
images are also shown on the right. If the “Mode” key is pressed while moving up and down, the ROM list
will page up and down respectively.

Once the ROM is highlighted, the user can press the “Select” button to run the game. Pressing the “Quit”
key will exit the RTS Arcade application. The “Quit” key is generally the same key that is used to exit out
of MAME, although not required.

By pressing the joystick right and left the selection on the alphabet bar will change. When the letter of
choice is highlighted, pressing the “Select” key will jump the current selection to the first item that starts
with the selected letter.
Page 2                                 RTS Arcade User Documentation                                  12/27/2005
The ROM list can also be sorted. Guess what, this is done by pressing the “Sort” key. The ROM list can be
sorted in three ways:
        Description – Orders the ROM list alphabetically.
        Last Played – Orders the most recently played ROMs at the top of the list
        Time Played – Puts the ROMs that have been played the most at the top of the list.

If there are multiple emulators configured then the “Change Game Type” button will switch between ROM
lists. When this key is pressed, the ROM list changes to the next emulator. When the last emulator list is
shown, it will roll around to the first emulator.

RTS Arcade also has the ability to shutdown the computer. When the “Shutdown” key is pressed, it will
exit RTS Arcade and then shutdown the computer. Depending on the operating system, it will shutdown a
little differently. In Windows XP it will delay 2 seconds before shutting down. For all other Windows
operating systems, it will shutdown immediately.

There are also 6 optional Hot Keys that can be configured. These Hot Keys can be used to run any game.
When one of the Hot Keys is pressed, the ROM associated with the Hot Key will automatically be run.




Page 3                               RTS Arcade User Documentation                              12/27/2005
RTS Config
RTS Config is the application that is used to set all of the configuration parameters for RTS Arcade. RTS
Arcade and RTS Config cannot be run at the same time. Most of the RTS Config parameters are not saved
until you click “Ok”. The only thing that is saved when it is done is adding an emulator. The emulator
name is automatically committed to the preferences file.

Path Settings
The Path Settings page is used to specify to RTS Arcade where to find the files necessary to run MAME
ROM's.




 MAME Exe - Use the button next to the MAME Exe field to choose the directory and executable to run
 for the MAME system.
ROM Directories - Use the button next to the ROM Directory field to set
the ROM path. The ROM path can include 1 or more directories to search for
the ROMs. This path is used with the MAME command line argument
"-rompath".
When selecting multiple paths to add to a search path you use the Set
Directories dialog. This allows you to Add, Edit, & Delete directories to the
search path.



Samples Directories - Use the button next to the Samples Directory field to set the sample path. The
Sample path can include 1 or more directories to search. This path is used with the MAME command line
argument "-samplepath". The samples are the extra sounds that a ROM may use during game play.
Artwork Directories - Use the button next to the Artwork Directory field to set the artwork path. The
Artwork path can include 1 or more directories to search. This path is used with the MAME command line
Page 4                              RTS Arcade User Documentation                              12/27/2005
argument "-artwork_directory". The artwork is the extra art that is sometimes found on the game cabinet
that can overlay the physical screen.
Screen Shot Directory - Use the button next to the Screen Shot Directory field to set the screen shot
path. The Screen Shot path is used by the RTS Arcade application to show a preview of the game to the
user. The name of the screen shot must be the same as the ROM or Clone name. The 2 types of file
extensions supported are .JPG and .PNG. The screen shot is the image that shows on the bottom of the
RTSArcade launcher. The screen shots can exist in a zip file or as individual files. The zip file name is
configured on another tab. The screen shots can exist in a zip file or as individual files. The zip file name is
configured on another tab.
Title Directory - Use the button next to the Title Directory field to set the title image path. The Title
path is used by the RTS Arcade application to show a preview of the games title screen to the user. The
name of the image must be the same as the ROM or Clone name. The 2 types of file extensions supported
are .JPG and .PNG. The title image is the image that is shown above the screen shot image in the
RTSArcade launcher. The title images can exist in a zip file or as individual files. The zip file name is
configured on another tab.
Cabinet Directory - Use the button next to the Cabinet Directory field to set the cabinet image path. The
cabinet images are optional and the path can be left blank. The Cabinet path is used by the RTS Arcade
application to show a preview of the games original cabinet to the user. The name of the image must be the
same as the ROM or Clone name. The 2 types of file extensions supported are .JPG and .PNG. The cabinet
image is shown to the right of the ROM list. The cabinet images can exist in a zip file or as individual files.
The zip file name is configured on another tab.
Flyer Directory - Use the button next to the Flyer Directory field to set the flyers image path. The flyer
images are optional and the path can be left blank. The Flyer path is used by the RTS Arcade application to
show a preview of the games original flyer to the user. The name of the image must be the same as the
ROM or Clone name. The 2 types of file extensions supported are .JPG and .PNG. The flyer image is
shown to the right of the ROM list. The flyer images can exist in a zip file or as individual files. The zip
file name is configured on another tab.
Marquee Directory - Use the button next to the Marquee Directory field to set the marquee image path.
The marquee images are optional and the path can be left blank. The Marquee path is used by the RTS
Arcade application to show a preview of the games original marquee to the user. The name of the image
must be the same as the ROM or Clone name. The 2 types of file extensions supported are .JPG and .PNG.
The marquee image is shown above the title and snap image to the left of the ROM list. The marquee
images can exist in a zip file or as individual files. The zip file name is configured on another tab.




Page 5                                RTS Arcade User Documentation                                 12/27/2005
MAME Zip Files
The Zip Files tab is used to set the optional names of the zip files that contain the various images. These
files must be located in the associated directory specified on the MAME Path Settings tab.




Screen Shot Zip Name – Type the name of the zip file that contains the files for the screen shots. The file
names in the zip file must match the name of the ROM and have a .png or .jpg extension.
Title Zip Name – Type the name of the zip file that contains the files for the title images. The file names in
the zip file must match the name of the ROM and have a .png or .jpg extension.
Cabinet Zip Name – Type the name of the zip file that contains the files for the cabinet images. The file
names in the zip file must match the name of the ROM and have a .png or .jpg extension.
Flyer Zip Name – Type the name of the zip file that contains the files for the original games flyer. The file
names in the zip file must match the name of the ROM and have a .png or .jpg extension.
Marquee Zip Name – Type the name of the zip file that contains the files for the cabinets marquee. The
file names in the zip file must match the name of the ROM and have a .png or .jpg extension.




Page 6                                RTS Arcade User Documentation                                12/27/2005
MAME System Settings
The MAME System Settings page is used to specify to RTS Arcade how to launch MAME.




Screen Shot Type - These radio buttons indicate to the RTS Arcade what the preferred extension is for the
screen shots.
Screen Shot Scale - This is the image scale multiplier for the screen shot and title images. Depending on
the resolution of your monitor, this should be set appropriately. For a resolution of 640x480 a good value
would be approx 0.5.
MAME System Parameters - This is a freeform entry field that allows a user to specify additional
command line parameters. These parameters are used regardless of what other settings are specified for the
system level as well as the ROM settings.
Skip Disclaimer - This sets the "-skip_disclaimer" command line parameter for MAME. It suppresses the
"type OK" screen in MAME.
Skip Game Info - This sets the "-skip_gameinfo" command line parameter for MAME. It suppresses the
game info shown by MAME.
Use Resolution Setting - This tells MAME to use the "-r <horz res>x<vert res>" option. This is used to
override the ROM's preferred resolution to match what the system is capable of handling.
Horizontal Resolution - The horizontal resolution to use.
Vertical Resolution - The vertical resolution to use.




Page 7                              RTS Arcade User Documentation                              12/27/2005
General
The General tab currently specifies which ROMs to include and exclude.




Show Adult ROMS - The ROM database has the ability to mark a ROM as adult oriented. If this field is
not checked then those ROMs that are adult oriented will not appear in the main launcher. The ROM tab
has the capability to categorize ROMs as “Adult / Mature”. A ROM can also be manually set as “Adult”.
By unchecking this option those Adult ROMs will not be shown.
Show Clone ROMS – If the “Show Clone ROMS” field is checked then all ROMs that are clones of
another ROM will be shown in RTS Arcade. If this field is not checked then the clone ROMs will not be
shown. Pretty simple, huh.




Page 8                             RTS Arcade User Documentation                             12/27/2005
Key Assignments
The Key Assignment tabs are used to set the keys associated with the various capabilities of RTS Arcade.
All key assignments must be unique. The only exception is that the “<None>” key can be assigned to
multiple functions. All keys are optional, but it is highly recommended that you assign a key for the
“Select” and “Exit” keys.


General
The general tab is where the main functionality of RTS Arcade is configured.




Select Key - This key is used to start a ROM or select an item on the alphabet bar. This key is the
equivalent of using the mouse to select an item or pressing the enter key on a command line.
Exit Key - This key is used to exit out of RTS Arcade.
Mode Key - The mode key currently allows the user to page up and down through the ROM list instead of
scrolling one at a time. By pressing this key and the Up or Down key at the same time, it pages through the
ROM list.
Sort Key - Allows the user to sort the ROM list based on three criteria:
     • Description
     • Last Played Time
     • Number of Times Played
Change Game Type Key – This key is used to cycle through the various emulators. When the last
emulator is reached, it will start back with the MAME emulator. If there are no dynamic emulators
configured then this key can be set to “<None>”.
Shutdown Windows - The Shutdown Windows key is used to exit RTS Arcade and Shutdown the
operating system.
Up Key - Allows the user to navigate up through the ROM list. The selection is moved to the bottom of the
list when the top of the list is reached.


Page 9                               RTS Arcade User Documentation                              12/27/2005
Down Key - Allows the user to navigate down through the ROM list. The selection is moved to the top of
the list when the bottom of the list is reached.
Left Key - Allows the user to move left through the alphabet bar on the bottom of the RTS Arcade. When
the left most letter is reached it moves the selection to the end.
Right Key - Allows the user to move right through the alphabet bar on the bottom of the RTS Arcade.
When the right most position is reached it moves the selection to the beginning.


Hot Keys
The Hot Keys tab is where the optional hot key functionality is configured. There are six possible hot keys
that can be set. The hot key functionality allows the user of RTS Arcade to press a key on the control panel
to launch an associated game.




Hot Key N – The Hot key is the key that is used to launch the game that is specified to the right of the key.
This key must not already be assigned to another capability. If the Hot Key functionality is not going to be
used then set the key to “<None>”.

The area to the right of the key is where the assigned game will show up. This field can be set by pressing
the button. When this button is pressed a ROM selection dialog is shown and allows the user to select a
game.

The     button is used to clear out the previously selected game.




Page 10                               RTS Arcade User Documentation                                12/27/2005
An assigned hot key configuration tab will look something similar to this:




ROMS
The ROMS tab is used to configure the games / ROMs. This tab consists of a list of all ROMs and buttons
to Create/Convert, Categorize, Add, Edit, and Delete ROMs.




Page 11                              RTS Arcade User Documentation                           12/27/2005
Game
The game tab is where the information for any game is configured. This information is the same for all
emulators.




Game Type – The emulator that this ROM is associated with.
Game Name - The name of the ROM to use
Description - The user description of the ROM.
Manufacturer - The manufacturer of the ROM.
Year - The year that the game was created.
Game Params - The specific game parameters for this ROM.
Adult Oriented Game - Indicates that the ROM has adult content and may not be suitable for children.
The database that is shipped with the installation does not guarantee that all adult oriented games are
categorized.




Page 12                              RTS Arcade User Documentation                              12/27/2005
MAME Options
The MAME Options tab is where the MAME specific options are configured. This information is only
provisionable for MAME ROMs.




Use Game Defaults - Use the resolution defined in MAME for the ROM. These are the values to the right
of the user-defined values. Note - If the MAME defaults are 0 then the values defined on the System tab
will be used unless the Ignore System or Override System values are set.
Use System - Use the resolution set on the MAME System Settings tab for this game.
Override System - Use the resolution set specifically for this ROM.
Ignore System - Do not use the "-r" parameter at all. Let MAME figure out the proper resolution.
Use Mouse - Set the "-mouse" parameter for this ROM.
Use Joystick - Set the "-joystick" parameter for this ROM.
Run in Window Mode - Set the "-window" parameter for this ROM. This will run the ROM in a Windows
Operating System window.
No Bezel - set the "-nobezel" parameter for this ROM. This will run the ROM without the bezel artwork
around the game.
Rotate Game – This is used to specify the “-ror” and “-rol” MAME Options:
        None – Does not add any options
        Left – Adds the “-rol” option
        Right – Adds the “-ror” option




Page 13                            RTS Arcade User Documentation                            12/27/2005
Dynamic Emulators
Emulators can be dynamically added to RTS Arcade. Adding an emulator is done by clicking the “Add
Emulator” button. You will give the emulator a name and the provide all of the specific information about
the emulator. An emulator can also be renamed and deleted. The “Rename Emulator” and “Delete
Emulator” buttons are not enabled unless an added emulator tab is selected. The selected emulator will be
the emulator that the rename and delete actions will take action on.


Emulator Path Settings
The Path Settings tab is where you set the various paths for the new emulator.




<Emulator> Exe - Use the button next to the <Emulator> Exe field to choose the directory and
executable to run for the emulator.
Game Directory - Use the button next to the Game Directory field to set the path to the games for the
emulator.
Screen Shot Directory - Use the button next to the Screen Shot Directory field to set the screen shot
path. The Screen Shot path is used by the RTS Arcade application to show a preview of the game to the
user. The name of the screen shot must be the same as the ROM or Clone name. The 2 types of file
extensions supported are .JPG and .PNG. The screen shot is the image that shows on the bottom of the
RTSArcade launcher. The screen shots can exist in a zip file or as individual files. The zip file name is
configured on another tab. The screen shots can exist in a zip file or as individual files. The zip file name is
configured on another tab.
Title Directory - Use the button next to the Title Directory field to set the title image path. The Title
path is used by the RTS Arcade application to show a preview of the games title screen to the user. The
name of the image must be the same as the ROM or Clone name. The 2 types of file extensions supported
are .JPG and .PNG. The title image is the image that is shown above the screen shot image in the
RTSArcade launcher. The title images can exist in a zip file or as individual files. The zip file name is
configured on another tab.
Page 14                               RTS Arcade User Documentation                                 12/27/2005
Emulator System Settings
The System Settings tab is where the parameters to actually run the emulator are provisioned.




Screen Shot Type - These radio buttons indicate to the RTS Arcade what the preferred extension is for the
screen shots.
Screen Shot Scale - This is the image scale multiplier for the screen shot and title images. Depending on
the resolution of your monitor, this should be set appropriately. For a resolution of 640x480 a good value
would be approx 0.5.
<Emulator> System Parameters - This is a freeform entry field that allows a user to specify the command
line parameters for the emulator. These parameters are used regardless of what other settings are specified
for the system level as well as the ROM settings. At a minimum you must put the %GAME% parameter as
one of the System Parameters. The available parameters are:
        %GAMEPATH% - Substitute the Game Directory from the Path Settings tab
        %GAME%                 - Substitute the Game Name
        %GAMEPARM% - Substitute the Game Params from the “Edit ROM” dialog.

An example of a System Parameter for the MESS emulator that emulates NES might be:
       nes -cart "%GAMEPATH%%GAME%" -nonu -skip_disclaimer -skip_gameinfo
This would translate into a command line of:
C:\mess\mess.exe nes -cart "c:\roms\mario" -nonu -skip_disclaimer -skip_gameinfo




Page 15                              RTS Arcade User Documentation                              12/27/2005

				
DOCUMENT INFO