BVE WORKS
  BVE^ Developer Guide
Contents             Topics:   Preface | Concept | Components | Investigations        
COMPONENTS

This section describes the components (files) that make up the BVE system and how these components are organized and related to one another.

File organization.

BVE folder You can name this folder anything you like.
  BVE files Includes the BVE.exe file and signal files, etc. Do not remove these files. You can rename the BVE.exe file but none of the others. You can substitute for all except the BVE.exe.
  Railway folder Do not remove or rename this folder.
    Route folder Do not remove or rename this folder.
      Routename route file(s) Defines the route. The file name takes the form routename.rw or routename.csv file. Can be located outside the folder. You need at least one route file, and can have more than one.
    Object folder Do not remove or rename this folder.
      Routename folder Segregates the object files by route.
        Routename object files Define visual components along the route such as stations, signs, buildings, and people. Include 3D objects (file types filename.b3d or filename.csv) and 2D surfaces (file type filename.bmp).
    Sound folder Do not remove or rename this folder.
      Routename folder Segregates the sound files by route.
        Routename sound files Provide sounds, such as station announcements, specific to the route. Include file type filename.wav
  Train folder Do not remove or rename this folder.
    Train_name folder Segregates the train files by train.
      Train_name train files Provide train data, such as cab control panel, and power and acceleration characteristics, as well as motor and running sounds specific to the train. Include a variety of file types including filename.bmp, filename.cfg, filename.dat, filename.txt, and filename.wav.

Examine each file. You may want to look at each of the following files or file types.

To make viewing a file quick and easy, keep shortcut icons of Media Player, MSPaint, and other programs on the Desktop. Then drag and drop a file onto the appropriate icon for immediate viewing/listening.

BVE files. The files listed here are for BVE2. You can view BMP files with MSPaint or another paint program, view WAV files with MS Media Player or another audio player program, view JPG files with any browser or photo editor and possibly some paint programs, and view INI and LOG files with Notepad or WordPad. Most of these files can be called from the route file if the developer so chooses.

  • Ats.wav. Bell sounds that go off when the ATS is tripped. They can be substituted for by other sounds specific to the train.
  • Ats.cnt.wav. Bell sounds that go off when the ATS is tripped. They can be substituted for by other sounds specific to the train.
  • BVE.exe. The application file. You can rename it as appropriate (e.g., BVE1.exe, BVE2.exe, etc.) but otherwise don't touch it.
  • Ding.wav. Bell. The route developer inserts calls for the bell in the route file.
  • Eb.wav. Sounds the dead man device. The player has 10 seconds to press the Insert key before the emergency brakes are applied. To reset the device after the train has stopped, the player must press Ctrl+F2 and then Shift+F2.
  • Limit0.bmp thru Limit9.bmp. Limit graphics; appear along the route. The route developer inserts calls in the route file.
  • LimitBg0.bmp thru LimitBg2.bmp. More limit graphics; appear along the route. The route developer inserts calls in the route file.
  • Logo.jpg. BVE logo; appears when you launch BVE.
  • Null.wav. Silence.
  • Relay0.bmp thru Relay3.bmp. Relay graphics; appear along the route. The route developer inserts calls in the route file.
  • Signal0.bmp thru Signal21.bmp. Signal graphics such as green light, yellow light, etc. They appear along the route. The route developer inserts calls in the route file.
  • ST6UNST.LOG. The uninstall log file. It has all the registry settings made by BVE at installation, so they can be removed if BVE is uninstalled. Do not modify or remove this file.
  • Start.wav. BVE startup tune; plays when you launch BVE. You can disable the tune by renaming the file or you can remove the tune all together by deleting the file.
  • Stop.bmp. This is the stop marker that displays at the Stop location identified in the route file. The marker appears as as a white diamond with orange border.
  • String.ini. Initializes BVE at startup. Generally, you shouldn't need to touch this file, though you may at times replace it with updated versions.
  • Unlimit.bmp. This is the end-of-speed-restriction marker (checkered diamond). It is placed where the route file has limit 0 statement (i.e., @limit(0,X) in which X = lateral displacement).

Route files. A given route requires one and only one route file. It can be in either RW or CSV format.

  • routename.rw. Original format. View, maintain, create with Notepad.
  • routename.csv. More recent format. This format is intended to be created, viewed, created, and maintained with Microsoft Excel, but you can also use Notepad if you like.

The CSV format is unique to BVE2, whereas the RW and B3D formats are usable by BVE1 and BVE2. Most add-ons at this point have been produced with the B3D format, thus beginners may find more help available (and examples to look at) if they start with the older B3D format. The new CSV format has some modest advantages that could justify its use.

Object files. Object files represent scenery elements created by the developer and are called by the route file at various places along the route. Object files represent three-dimensional objects by way of a structure of planes defined using spatial coordinates (x, y, and z) and surface textures applied to the planes to make them visible.

Object files can be in two alternative formats: filename.B3D and filename.CSV. You can create them without expensive software by using Notepad (B3D) or Microsoft Excel (CSV). You can view them by inserting them early in a test route and running BVE. The surface components can be colors that are indentified in the object file or bitmap (filename.BMP) files called for by the object files. A bitmap can be made from a photograph or an illustration created in a drawing or painting program. Bitmaps can be viewed with any paint program, such as MSPaint.To summarize:

  • filename.bmp. Original format. View, maintain, create with MSPaint.
  • filename.b3d. Original format. View, maintain, create with Notepad.
  • filename.csv. New format. View, maintain, create with Notepad.

Sound files. Sound files are recorded by the route developer and are called by the route file at various places along the route. Sound files take the format:

  • filename.wav. You can listen to a WAV file by dragging and dropping it on the MSPlayer icon.

To edit a sound file for BVE you need a program like Goldwave (http://www.goldwave.com/) at about 40 USD or Cooledit (http://www.syntrillium.com/) at about 40 USD for the Lite version and 70 USD for the Pro version. The required format is 22.05kHz (mono). The Windows Sound Editor is not suitable for editing BVE sound files.

Train files. Train files are created by the route developer and are called by the route file at various places along the route. They take the following formats:

  • Panel.bmp. Photograph or drawing of cab control panel, saved as BMP file. This file provides the base upon which data in Panel.cfg file applies. View, maintain, or create this file with MSPaint or other paint program.
  • Panel.cfg. Defines cab control panel instruments pictured in Panel.bmp. This file loads when the route is selected. View, maintain, or create with Notepad.
  • Train.dat. Defines train acceleration characteristics. View, maintain, or create with Notepad.
  • train.txt. Defines controller characteristics. View, maintain, or create with Notepad.
  • filename.wav. Train sounds recorded by route developer. These files are called for in the route file at various places along the route.

Top        


Contents             Topics:   Preface | Concept | Components | Investigations        
    BVE WORKS 
  

©2001 Alfred Barten. All rights reserved. Page created 20 July 2001. Last updated 29 March 2006




Web Counter by TrafficFile.com