| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| falcon4:database:editingtutorial [2016/11/04 20:22] – moved images from nekromantix to this domain. snakeman | falcon4:database:editingtutorial [2024/07/31 08:13] (current) – links added. snakeman |
|---|
| ====== Adding, Deleting and Editing ====== | ====== Falcon 4 Database Adding, Deleting and Editing ====== |
| |
| **Database Editing** by ranger822 | [[https://www.pmctactical.org/forum/viewforum.php?f=47|Falcon 4.0 Forum]], [[:falcon4|Falcon 4 Home]], [[falcon4:campaign|Falcon 4 Campaign]], [[falcon4:cockpits|Falcon 4 Cockpits]], [[falcon4:database|Falcon 4 Database]], [[falcon4:file_formats|Falcon 4 File Formats]], [[falcon4:srtm|Falcon 4 SRTM Terrain]], [[falcon4:terrain|Falcon 4 Terrain]], [[falcon4:textures|Falcon 4 Textures]], [[falcon4:tools|Falcon 4 Tools]] |
| | |
| | **Falcon 4 Database Adding, Deleting and Editing** by ranger822 |
| |
| Database Editing is perhaps one of the most interesting and rewarding parts of Falcon development. This is the place where new models, skins, weapons, etc get integrated into the database for use in Falcon. There is nothing quite as satisfying and taking a brand new model with a brand new skin set and being able to take this new aircraft for a test flight. While, there is a lot more this this simple act than simply adding a few things, and database is more than just aircraft, it include, all vehicle types, units, weapons, flight models, parent, models, CTs, radar, and much more. Unfortunately, because Falcon is such a demanding woman - your performance as a database editor must be nearly flawless or things go horribly wrong. While PMC is dedicated to providing support for different Falcon.exe, and the requirements for different executables is slightly different I will only be addressing the specific edits as they apply to FF Cobra.exe and RV.exe. I have limited experience with other Falcon.exe and therefore don't want to provide inaccurate info for those folks choosing to use other Falcon.exe. Perhaps other database developers will be willing to contact me and I will include supplementary instructions as they apply for different exe. In general most of the principles that I layout here should apply almost universally for the other exe's. Also, is should be said that the two most important tools for database editing are LOD Editor (Fred Balding) and F4Browser (Julian Onions). With the advent of RV I would also include DXEdit.exe and DXDBTools.exe, and LODConvert.exe all three of which I will also discuss in some detail. | Database Editing is perhaps one of the most interesting and rewarding parts of Falcon development. This is the place where new models, skins, weapons, etc get integrated into the database for use in Falcon. There is nothing quite as satisfying and taking a brand new model with a brand new skin set and being able to take this new aircraft for a test flight. While, there is a lot more this this simple act than simply adding a few things, and database is more than just aircraft, it include, all vehicle types, units, weapons, flight models, parent, models, CTs, radar, and much more. Unfortunately, because Falcon is such a demanding woman - your performance as a database editor must be nearly flawless or things go horribly wrong. While PMC is dedicated to providing support for different Falcon.exe, and the requirements for different executables is slightly different I will only be addressing the specific edits as they apply to FF Cobra.exe and RV.exe. I have limited experience with other Falcon.exe and therefore don't want to provide inaccurate info for those folks choosing to use other Falcon.exe. Perhaps other database developers will be willing to contact me and I will include supplementary instructions as they apply for different exe. In general most of the principles that I layout here should apply almost universally for the other exe's. Also, is should be said that the two most important tools for database editing are LOD Editor (Fred Balding) and F4Browser (Julian Onions). With the advent of RV I would also include DXEdit.exe and DXDBTools.exe, and LODConvert.exe all three of which I will also discuss in some detail. |
| -File -> Open Model File... | -File -> Open Model File... |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_1.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_1.jpg }} |
| |
| Browser to your finished model and open it. | Browser to your finished model and open it. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_2.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_2.jpg }} |
| |
| You will see this screen below next, play special attention to the detail highlighted in the red block. It is a good idea to write this info down on a separate piece of paper or in Notepad/Wordpad. This is basically telling you what the last known numbers in the database are and it makes it easier to locate your new entry later as you go along. | You will see this screen below next, play special attention to the detail highlighted in the red block. It is a good idea to write this info down on a separate piece of paper or in Notepad/Wordpad. This is basically telling you what the last known numbers in the database are and it makes it easier to locate your new entry later as you go along. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_3.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_3.jpg }} |
| |
| Now, click on th **Edit LOD** button and you will see a screen similar to the one below. Under **Utilities** choose **Model/Texture SetUp** | Now, click on th **Edit LOD** button and you will see a screen similar to the one below. Under **Utilities** choose **Model/Texture SetUp** |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_4.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_4.jpg }} |
| |
| The next screen you see you need to follow these simple steps: | The next screen you see you need to follow these simple steps: |
| - Then click on **OK** | - Then click on **OK** |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_5.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_5.jpg }} |
| |
| Now do the same for the **Append/Select LOD** the menu will ask you to locate the LOD file of your model on your hard drive and after that some distance view information. I am not sure what these numbers really mean so I follow Maddog's advice and type in the number 10000 and click **OK** | Now do the same for the **Append/Select LOD** the menu will ask you to locate the LOD file of your model on your hard drive and after that some distance view information. I am not sure what these numbers really mean so I follow Maddog's advice and type in the number 10000 and click **OK** |
| The distance data can be changed after wards anyway, so don't worry too much about that for now. | The distance data can be changed after wards anyway, so don't worry too much about that for now. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_6.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_6.jpg }} |
| |
| Now click on **Update Parent Record**\\ | Now click on **Update Parent Record**\\ |
| In F4Browse go down to Vehicle folder and click on it to open the sub folders and then click on Aircraft. Now find and existing aircraft that best matches the new aircraft you want to add. In Maddog's example he selected a Mirage -IIIE as his template because he was adding a Mirage IIIR2Z which is quite similar. The selection should try to match up an existing aircraft that is closes in role, performance, etc since it is entirely likely that parts of a/c data entries can be used with less modification. So, Right click on the list listing and choose **Add Copy** | In F4Browse go down to Vehicle folder and click on it to open the sub folders and then click on Aircraft. Now find and existing aircraft that best matches the new aircraft you want to add. In Maddog's example he selected a Mirage -IIIE as his template because he was adding a Mirage IIIR2Z which is quite similar. The selection should try to match up an existing aircraft that is closes in role, performance, etc since it is entirely likely that parts of a/c data entries can be used with less modification. So, Right click on the list listing and choose **Add Copy** |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_7.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_7.jpg }} |
| |
| The new entry will be copied to the bottom of the a/c list. So, scroll down to the bottom and locate your copied template | The new entry will be copied to the bottom of the a/c list. So, scroll down to the bottom and locate your copied template |
| - Click on **Update** | - Click on **Update** |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_8.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_8.jpg }} |
| |
| - Click on Class Table on the left, sort the list by No, then locate the CT Ref No of the template that you copied, in this example it is entry 2500.\\ | - Click on Class Table on the left, sort the list by No, then locate the CT Ref No of the template that you copied, in this example it is entry 2500.\\ |
| - Right click and **Add Copy**. | - Right click and **Add Copy**. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_9.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_9.jpg }} |
| |
| - You new entry will be added, as always to the bottom of the Class Table list so scroll down and locate it\\ | - You new entry will be added, as always to the bottom of the Class Table list so scroll down and locate it\\ |
| - Double click to edit your new CT entry | - Double click to edit your new CT entry |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_10.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_10.jpg }} |
| |
| - Write down the new **CT Ref No** (in this example 3508)\\ | - Write down the new **CT Ref No** (in this example 3508)\\ |
| - Locate your new model and double click to edit it again. | - Locate your new model and double click to edit it again. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_11.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_11.jpg }} |
| |
| - In the CT Recd box enter the CT Ref No you just created in the step before (in this example is was 3508).\\ | - In the CT Recd box enter the CT Ref No you just created in the step before (in this example is was 3508).\\ |
| - This is where those who did not write things down will panic. In Part 1 of this tutorial, when you added the new LOD you needed write down the new LOD number and Parent ID number. Remember the screen see pic below. | - This is where those who did not write things down will panic. In Part 1 of this tutorial, when you added the new LOD you needed write down the new LOD number and Parent ID number. Remember the screen see pic below. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_12.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_12.jpg }} |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_13.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_13.jpg }} |
| |
| In the screen below we have changed the template Parent ID to my new Parent ID (3800_ which contains the reference to the actual LOD model. | In the screen below we have changed the template Parent ID to my new Parent ID (3800_ which contains the reference to the actual LOD model. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_14.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_14.jpg }} |
| |
| If you click on the **Normal** button in the Parent Box (screen above) you will see it takes you to your LOD file you added in Part 1 (in this example it is 6433). You should not have to change anything here. | If you click on the **Normal** button in the Parent Box (screen above) you will see it takes you to your LOD file you added in Part 1 (in this example it is 6433). You should not have to change anything here. |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_15.jpg }} | {{ https://pmc.editing.wiki/images/DB_Tut_15.jpg }} |
| |
| That is basically it for adding a model to the database. If you click on the **3d Viewer** you should be able to view your model. Now that you have added the model to the database lets move to Part 4 which will discuss how to get your model to actually fly. | That is basically it for adding a model to the database. If you click on the **3d Viewer** you should be able to view your model. Now that you have added the model to the database lets move to Part 4 which will discuss how to get your model to actually fly. |
| First fire up F4Browse again - - Click on the CT Tree and scroll down to the Vehicles >>>>Aircraft tab again. Locate Maddog's Mirage IIIE which he used for his example. Open the Mirage IIIE record and you will notice the **Units with this** box on the right side of the Vehicle Data Details window. You will see two Units identified as Fighter 501 and Fighter 500. These are the unit flight and unit squadron | First fire up F4Browse again - - Click on the CT Tree and scroll down to the Vehicles >>>>Aircraft tab again. Locate Maddog's Mirage IIIE which he used for his example. Open the Mirage IIIE record and you will notice the **Units with this** box on the right side of the Vehicle Data Details window. You will see two Units identified as Fighter 501 and Fighter 500. These are the unit flight and unit squadron |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_16.jpg }} | PMCTODO DB_Tut_16.jpg image missing!? |
| | {{ https://pmc.editing.wiki/images/DB_Tut_16.jpg }} |
| |
| - Double Click on each of these Units in turn. When you do you will notice it will bring up the Unit View window. In the upper left corner you will see the CT Index (CT Ind) and then a window with a number. This is the CT Index for the unit. Write this number down (in this example the Fighter 501 = CT2668, and Fighter 500 = CT2667). | - Double Click on each of these Units in turn. When you do you will notice it will bring up the Unit View window. In the upper left corner you will see the CT Index (CT Ind) and then a window with a number. This is the CT Index for the unit. Write this number down (in this example the Fighter 501 = CT2668, and Fighter 500 = CT2667). |
| |
| {{ http://pmc.editing.wiki/images/DB_Tut_17.jpg }} | PMCTODO DB_Tut_17.jpg image missing!? |
| | {{ https://pmc.editing.wiki/images/DB_Tut_17.jpg }} |
| |
| - Now close the Unit View Window and go to the CT Tree view and click on the top of the tree **Class Table**, when you do it will sort the CT list numerically from lowest to highest.\\ | - Now close the Unit View Window and go to the CT Tree view and click on the top of the tree **Class Table**, when you do it will sort the CT list numerically from lowest to highest.\\ |
| - Now in a similar manner to the way you added the vehicle CT, you will need to do the same thing for both unit records. So, lets return to the Units >>>>> Aircraft tab and find the flight and squadron unit records 500 and 501. Now Add Copy both of these to your Units tab. Scroll to the bottom and you will find two newly appended unit record with will contain data identical to your copied records. The new unit records will have a new number (No) (second column). These are the new Unit record numbers. However, you should notice right away that the data values for the CT and record number will conflict with the record from which you copied the data. The old CT number is referenced. This will need to be changed to your new unit CT number. Remember that when you Add Copy any item - it reproduces the old record exactly. So, you will need to go to the new record and edit this so that it isn't in conflict with the record you used as a template to copy from. Also, you need to use the Class Table and locate your recently added CTs and enter in the new unit record numbers. In addition you will need to sort the CT table in various sorting modes to deconflict and determine what values to use for your new unit CT records "Specific" value. How is this done? Easy, simply click on the top row on whatever item you want to sort by - - so if you want to sort the CT's by Class - click the class header, | - Now in a similar manner to the way you added the vehicle CT, you will need to do the same thing for both unit records. So, lets return to the Units >>>>> Aircraft tab and find the flight and squadron unit records 500 and 501. Now Add Copy both of these to your Units tab. Scroll to the bottom and you will find two newly appended unit record with will contain data identical to your copied records. The new unit records will have a new number (No) (second column). These are the new Unit record numbers. However, you should notice right away that the data values for the CT and record number will conflict with the record from which you copied the data. The old CT number is referenced. This will need to be changed to your new unit CT number. Remember that when you Add Copy any item - it reproduces the old record exactly. So, you will need to go to the new record and edit this so that it isn't in conflict with the record you used as a template to copy from. Also, you need to use the Class Table and locate your recently added CTs and enter in the new unit record numbers. In addition you will need to sort the CT table in various sorting modes to deconflict and determine what values to use for your new unit CT records "Specific" value. How is this done? Easy, simply click on the top row on whatever item you want to sort by - - so if you want to sort the CT's by Class - click the class header, |
| |
| 18.jpg | 18.jpg PMCTODO image missing!? |
| |
| If you want to sort by the Sub-Type - click on the Sub-Type header | If you want to sort by the Sub-Type - click on the Sub-Type header |
| |
| 19.jpg | 19.jpg PMCTODO image missing!? |
| |
| Since I don't have Maddog's database with the MirageIIIR example lets use the ITO database as an example to walk thru the step of adding the unit data. First lets return to the Units >>>>> Aircraft tab. Go to the end of the database. If you had just Add Copy the flight and squadron units from the Mirage IIIE - the last two entries in list will be the Add Copy items. What needs to occur now is to have previously identified the CT numbers for the unit and vehicle CTs as well as the new unit and vehicle record numbers. | Since I don't have Maddog's database with the MirageIIIR example lets use the ITO database as an example to walk thru the step of adding the unit data. First lets return to the Units >>>>> Aircraft tab. Go to the end of the database. If you had just Add Copy the flight and squadron units from the Mirage IIIE - the last two entries in list will be the Add Copy items. What needs to occur now is to have previously identified the CT numbers for the unit and vehicle CTs as well as the new unit and vehicle record numbers. |
| |
| 20.jpg | 20.jpg PMCTODO image missing!? |
| |
| 21.jpg | 21.jpg PMCTODO image missing!? |
| |
| Now replace the values so that your new CTs point to the new unit and vehicle records. Once this is done you will then need to rebuild the two unit records. In the case of a/c squadrons you need to delete all the a/c entries that reference the vehicle record for the Mirage IIIE and then replace those with your new vehicle record. Next, you then need to add your new vehicle record to the the two unit records. There are different ways to accomplish this. If you use the original Falcon method, the Flight generally consists of adding the vehicle record to just the first two lines of the unit flight record. In the quantity box you can specify either 1 or 2 a/c. This will determine how many aircraft with be generated for the actual fight. So, if you want a wing man use a quantity of 2 (two) if you want to fly solo use a quantity of 1 (one). | Now replace the values so that your new CTs point to the new unit and vehicle records. Once this is done you will then need to rebuild the two unit records. In the case of a/c squadrons you need to delete all the a/c entries that reference the vehicle record for the Mirage IIIE and then replace those with your new vehicle record. Next, you then need to add your new vehicle record to the the two unit records. There are different ways to accomplish this. If you use the original Falcon method, the Flight generally consists of adding the vehicle record to just the first two lines of the unit flight record. In the quantity box you can specify either 1 or 2 a/c. This will determine how many aircraft with be generated for the actual fight. So, if you want a wing man use a quantity of 2 (two) if you want to fly solo use a quantity of 1 (one). |
| |
| 22.jpg | 22.jpg PMCTODO image missing!? |
| |
| And then taking and randomly adding either 2, 1, or no vehicle record references to the unit squadron record. In most cases I simply repeat whatever the original CT had and it seems to work just fine. Different squadrons may vary - you can have smaller numbers but I haven't tried to add more than whatever the unit originally had. When you have added your vehicles to the unit record you should then see the unit record populated with the new named vehicle. However, you are not nearly done yet. Now it is time to begin updating the rest of the data in the unit records which for the most part will be the same for the Flight and Squadron. Prior to adding your new aircraft, you should have collected up info on your aircraft in order to replace existing data in the unit record's data fields. You will need the to know weights, speed, estimate the radar cross-signature, etc. Some data you will need to make an educated guess on. For example, the radar cross-signature of a B-747 is going to be pretty close to a KC-10 so if you look up what was used for the KC-10, then you should be able to use that value and be in the ball-park. Again, if it just a matter of adding data that is reasonable when you are not sure of the correct values. Another area which requires some guesswork is the area of setting the flags for a vehicle. There is a lot of inconsistency in flags across the data. In general click on the Flag button and then select those items that seem appropriate. The really important data field which you will need to have exact data/info on is the Squadron Stores Data (SSD). When you copy the unit CTs you will be copying the old SSD value. This means that your aircraft will only have access to whatever munitions are allowed by the old SSD value. You will need to change this in order to load the proper munitions. The best thing to do is to perform an Add-Copy of the SSD used by a similar aircraft and then go thru and delete all the munitions in the new SSD record. Save this for later, we will return back to this once we have added the slots to the vehicle record and decided what is going to be carried on the racks/slots. | And then taking and randomly adding either 2, 1, or no vehicle record references to the unit squadron record. In most cases I simply repeat whatever the original CT had and it seems to work just fine. Different squadrons may vary - you can have smaller numbers but I haven't tried to add more than whatever the unit originally had. When you have added your vehicles to the unit record you should then see the unit record populated with the new named vehicle. However, you are not nearly done yet. Now it is time to begin updating the rest of the data in the unit records which for the most part will be the same for the Flight and Squadron. Prior to adding your new aircraft, you should have collected up info on your aircraft in order to replace existing data in the unit record's data fields. You will need the to know weights, speed, estimate the radar cross-signature, etc. Some data you will need to make an educated guess on. For example, the radar cross-signature of a B-747 is going to be pretty close to a KC-10 so if you look up what was used for the KC-10, then you should be able to use that value and be in the ball-park. Again, if it just a matter of adding data that is reasonable when you are not sure of the correct values. Another area which requires some guesswork is the area of setting the flags for a vehicle. There is a lot of inconsistency in flags across the data. In general click on the Flag button and then select those items that seem appropriate. The really important data field which you will need to have exact data/info on is the Squadron Stores Data (SSD). When you copy the unit CTs you will be copying the old SSD value. This means that your aircraft will only have access to whatever munitions are allowed by the old SSD value. You will need to change this in order to load the proper munitions. The best thing to do is to perform an Add-Copy of the SSD used by a similar aircraft and then go thru and delete all the munitions in the new SSD record. Save this for later, we will return back to this once we have added the slots to the vehicle record and decided what is going to be carried on the racks/slots. |
| |
| Now that we have successfully added a new vehicle entity and the two required unit entities lets dig into the the other parts of database editing that will now make the new vehicle entity perform uniquely. You might recall that when you did your add/copy of the vehicle and unit CTs - you also copied all the data that goes with the CT's you copied. Unfortunately, a lot of the data loaded into any given CT is going to need to be adjusted in some way. Further, we will need to take a detailed look at the vehicle data entry and discuss each of the database entry points, what it does, and how it relates to other parts of the database. Just as a side note, parts of the Falcon database are shared across different CTs and records - you must be aware of changes that you make because if you make a change in a record - you must ensure that it doesn't affect other records that might share the data record. This also requires the DB editor (you) to thoroughly review a record prior to editing and identify all the users, if any, of the data record. We will talk a little bit more in depth about this when we talk about squadron stores, radars and flags. | Now that we have successfully added a new vehicle entity and the two required unit entities lets dig into the the other parts of database editing that will now make the new vehicle entity perform uniquely. You might recall that when you did your add/copy of the vehicle and unit CTs - you also copied all the data that goes with the CT's you copied. Unfortunately, a lot of the data loaded into any given CT is going to need to be adjusted in some way. Further, we will need to take a detailed look at the vehicle data entry and discuss each of the database entry points, what it does, and how it relates to other parts of the database. Just as a side note, parts of the Falcon database are shared across different CTs and records - you must be aware of changes that you make because if you make a change in a record - you must ensure that it doesn't affect other records that might share the data record. This also requires the DB editor (you) to thoroughly review a record prior to editing and identify all the users, if any, of the data record. We will talk a little bit more in depth about this when we talk about squadron stores, radars and flags. |
| | |
