User Tools

Site Tools


modtools:revieweditor

The Magazine Review Editor

The in game magazine offers a number of interesting features, but probably the most used one is the Magazine Reviews System. The review system is completely editable, and works much like a MadLibs™ game. Where as inside the main body of the review blank variables are placed that are later filled in with sentences or words based on the vehicle's ratings.

While the reviews do not directly effect the vehicle sales, many users enjoy reading about how great or bad their vehicles are. There is much room for improvement in the default game's reviews.

Files And How It Works

Upon starting a new game, the reviews.xml file is saved into the save game file. When the player opens the in game magazine for the first time (that turn) the game will generate a new “issue” of the magazine, and populate the reviews and other data.

A review is made up of a base review text which is loaded from the Localization files (Word #???). Then individual reviews segments for the 11 categories are loaded from the save game file based on the ratings of the vehicle being reviewed.

Each category has its own review segements, and these segments in turn have a value range in which the segment can be selected. If the rating for the specific category falls between the segment's values it will be eligible to be used in the review. The game will pick at random from the selection if more than one review segment are in range.

After the game has selected 11 reviews segments for each category, it will piece them together into a review. It will use specific information about the vehicle and apply it to the review segment text based on the variables embedded into the review segments. The variables are called in the text with this symbol {#} where # is the number of the variable.

The Editor

The edit is broken down into a series of tabs much like other editors in the mod tools. Each tab represents a category. The buttons at the very top are for managing the review file, including opening, and saving the file. The upper list, just below the tabs, are the reviews segments already added to reviews file, the bottom text box is where you will edit the text of the review segment. In between the list are the range of values the review segment is used for. Which rating is used for the category is described below in Review Categories. On the right are the individual variables that must go into the review segment. A description of what each variable is, is located on the button and also below. Each variable on the side MUST be in the review segment, or the game may crash. Finally, on the bottom is the add and remove buttons that allow you to add or remove the review segment from the list.

Magazine Review Editor

  1. Creates a new Review.xml file by clearing out any data currently in the mod tools.
  2. Opens an existing Review.xml file. See File Locations for possible locations.
  3. Save data in the editor to a Review.xml file.
  4. Return to the main menu or previous editor.
  5. Category tabs, each tab represents a dynamic part of the review that uses the ratings of the vehicle. See Review Categories for details on each category.
  6. List of the reviews for the selected category that are already loaded into the editor. Selecting a review from this list will load the data below.
  7. Minimum value for this category before this review segment can be selected by the game.
  8. Maximum value for this category that this review segment can be selected by the game.
  9. If selected, the text of the review will be in the localization file with the localization id corresponding with the number in the text box.
  10. This is the where you enter the text of the review segment. The review segment must contain at least one of each of the variables on the right hand side (labeled with #11) . If the review is to be localized, enter the ID number of the localization text.
  11. These are the variable buttons which contain sub review segments or specific information about the vehicle. The review segment must contain at least one of each variable. Clicking on a button will but the variable entry (the {#}) into the end of the review text.
  12. This adds the review segment to the list of reveiws.
  13. This removes the selected review segment from the reviews.

Review Categories

The following are images of each review segment category, which rating is used for the category, and a listing of their variables and what they effect.



Introduction

This is the introduction for the reviews. It is selected based on the specific vehicle rating. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
Vehicle TypeThis is the type of vehicle being reviewed.
Leading CompetitionThis is the marque/model name name of the best vehicle currently for sale in the vehicle class.
Worst CompetitionThis is the marque/model name name of the worst vehicle currently for sale in the vehicle class.



Performance

This review segment is about the performance of the vehicle. It is selected based on the performance rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
HPThis is the horse power rating of the vehicle in Horse Power units.
Top SpeedThis is the top speed of the vehicle in mph and kmh
0-60This is the acceleration time in seconds, from 0 to 60 mph.
EngineThis is the name, displacement, layout, and cylinder count of the engine.
Vehicle TypeThis is the type of vehicle being reviewed.
Power ReviewThis inserts the power review segment.
Driveability ReviewThis inserts the driveability/handling review segment.



Driveability

This review segment is about the handling of the vehicle. It is selected based on the driveability rating of the vehicle, and is loaded from the performance review segment. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
Vehicle TypeThis is the type of vehicle being reviewed.
RatingThis inserts an adjective based on the Driveability rating.



Luxury

This review segment is about the luxury of the vehicle. It is selected based on the luxury rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
Luxury AdjectiveThis inserts an adjective based on the Luxury rating.



Safety

This review segment is about the safety of the vehicle. It is selected based on the safety rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.



Fuel

This review segment is about the fuel economy of the vehicle. It is selected based on the fuel rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
City Fuel ConsumptionThis is the fuel consumption numbers for city driving.
Highway Fuel ConsumptionThis is the fuel consumption numbers for highway driving.



Power

This review segment is about the power of the vehicle. It is selected based on the power rating of the vehicle, and is loaded from the performance review segment. You must use each of the following variables at least once:

NameDescription
TorqueThis is the amount of torque the engine has in ft-lbs and nm.
Towing weightThis is the maximum amount of weight that the engine/chassis/gearbox is able to pull. Even if the vehicle is not used for towing, this is a good indication of engine torque, vehicle traction, and structural integrity of the vehicle.



Cargo

This review segment is about the cargo capacity of the vehicle. It is selected based on the cargo rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
Cargo Space SpecThis is the amount of cargo and passenger space in both L and CI in the vehicle.



Quality

This review segment is about the quality of the vehicle. It is selected based on the quality rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.



Dependability

This review segment is about the dependability of the vehicle. It is selected based on the dependability rating of the vehicle. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.



Overall

This review segment is about the overall final thought about the vehicle. It is selected based on the overall rating of the vehicle. You should conclude your review with this review segment. You must use each of the following variables at least once:

NameDescription
BrandThis is the name of the vehicle Marque.
ModelThis is the model name of the vehicle being reviewed.
Vehicle TypeThis is the type of vehicle being reviewed.



Examples

Videos coming some day.



Troubleshooting

My New Review or Changes Are Not in the Game

Start a new save game. Reviews are stored inside the save game file, thus any changes require a new save game to go into effect.

Game Crashes

Most likely you are missing one of the required variables for a review segment. Double check the reviews segments. Each review segment must have the variables on the right of the editor at least once.

Review doesn't generate

Either you are missing one of the required variables for a review segment, or you did not escape a single quote character. ('), as of v1.22, reviews should have an escaped single quote character (two single quote characters) so that the information can be properly saved into the save game file. In future builds (hopefully v1.23) we will remove the character escaping requirements.

modtools/revieweditor.txt · Last modified: 2017/07/13 15:21 by admin