Differences

This shows you the differences between two versions of the page.

--- modtools:revieweditor [2017/07/13 00:16] – admin
+++ modtools:revieweditor [2022/02/15 18:00] (current) – external edit 127.0.0.1
@@ Line 9: / Line 9: @@
 ==== 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 base review is loaded from the Localization files (Word #???), then individual reviews segments for the 11 categories are loaded from the Reviews.xml file. See File Locations for location and file names.
+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.
+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.
@@ Line 21: / Line 22: @@
  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.
+{{ :modtools:magazinereview_overview.png?600 |Magazine Review Editor}}
@@ Line 39: / Line 42: @@
 ==== 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-Vehicle Type
+|Model|This is the model name of the vehicle being reviewed.|
-Leading Competition
+|Vehicle Type|This is the type of vehicle being reviewed.|
-Worst Competition
+|Leading Competition|This is the marque/model name name of the best vehicle currently for sale in the vehicle class.|
+|Worst Competition|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-HP
+|Model|This is the model name of the vehicle being reviewed.|
-Top Speed
+|HP|This is the horse power rating of the vehicle in Horse Power units.|
--60
+|Top Speed|This is the top speed of the vehicle in mph and kmh|
-Engine
+|0-60|This is the acceleration time in seconds, from 0 to 60 mph.|
-Vehicle Type
+|Engine|This is the name, displacement, layout, and cylinder count of the engine.|
-Power Review
+|Vehicle Type|This is the type of vehicle being reviewed.|
-Driveability Review
+|Power Review|This inserts the power review segment.|
+|Driveability Review|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-Vehicle Type
+|Model|This is the model name of the vehicle being reviewed.|
-Rating
+|Vehicle Type|This is the type of vehicle being reviewed.|
+|Rating|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-Luxury Adjective
+|Model|This is the model name of the vehicle being reviewed.|
+|Luxury Adjective|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
+|Model|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-City Fuel Consumption
+|Model|This is the model name of the vehicle being reviewed.|
-Highway Fuel Consumption
+|City Fuel Consumption|This is the fuel consumption numbers for city driving.|
+|Highway Fuel Consumption|This 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:
-Torque
+^Name^Description^
-Towing weight
+|Torque|This is the amount of torque the engine has in ft-lbs and nm.|
+|Towing weight|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-Cargo Space Spec
+|Model|This is the model name of the vehicle being reviewed.|
+|Cargo Space Spec|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
+|Model|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
+|Model|This 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:
-Brand
+^Name^Description^
-Model
+|Brand|This is the name of the vehicle Marque.|
-Vehicle Type
+|Model|This is the model name of the vehicle being reviewed.|
+|Vehicle Type|This 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.