Community development work; the tools & files
Posted: 2010-08-06 06:03:32
Community development work; the tools & files
How to develop theater with several people trying to edit the same files, how to not mess it all up so people are ending up doing overlapping (wasted) work.
CATE
Uses text based CONF files which are easily editable, we can use DIFF on EditPadPro to see different users edits.
However the way PMC development works, is that I will control the CATE work so unless special circumastances arise, I'm the only one editing these files.
CATE CONF files work the same way as Tacedit TCL scripts, we can do small adjustments and tweaks to the theater.L2 file over and over again never losing any work while seeing the end results instantly and covering the whole massive terrain. We must be very very careful on planning when we move from CATE tweaks into Terrainview manual hand editing of the L2 file. There is NO going back to CATE once Terrainview final touches has commenced (well to the point, we can use export segments, what I mean is just generally no going back).
F4Browse
When you edit the database files, they are then set for life for these edits. There is export / import feature to f4e files.
PAK map
It is "raw" image, usually made in Tacedit and edited in paintshoppro / photoshop. I don't know how many users could edit this file simultaneously.
Skins KoreaOBJ
Skins are the <NUMBER>.dds files in FF/OF, one user can edit one skin at the time, we would need to coordinate who wants to edit that <NUMBER> skin. Should be easy. In F4AF they are BMP files which are patched into database with Tex-Man utility.
All photoshop psd source files for all skins should be saved for future edits! This goes for all graphical art work related to theaters. This is very important!
Stations.dat
Red Dog has been PMC airbase / tacan realism guru for years. All airbase work and questions should be re-routed to him.
TacEdit
Export / import feature for objectives, single, selected or all objectives export capability.
Units can be exported to .uni file, I've not actually checked if this is binary or text file, someone people enlighten me.
If several users want to add objectives, they need to request "free OBJ ID range" from me. This means you can use Tacedit Edit -> Base Obj ID, feature to add the ID number from which you can start to add more objectives. Then user of course must stay withing the highest number of assigned free obj id range. Then when he exports the newly created objectives, I can merge them easily with another users additions from his free ID range.
For example user 1 is assigned for OBJ ID's of 2501 - 2600 and user 2 is assigned 2601 - 2700, then if they both fill up the hundred objectives, I can merge the new objectives into full set of 2501 - 2700 objective IDs.
As of campaigns, we use TCL scripts, very simple really. It is the same basic princible as in CATE CONF files, we keep the power of "script" manuscript style in our hands, any changes can be adjusted and tweaked over and over again with instant results and most importantly; no work is ever lost!
TCL's are text files, several users can join to tweak campaigns. For example one user can edit BLUFOR squadrons, another user can do OPFOR helicopters, third user edits BLUFOR ground units... when edited files are ready, they can be sent to each other on the dev team so everyoen has the latest files. All the users edits can be turned on/off as simply as putting # character on one place in the TCL file. It is so beautiful that anyone not understanding it should be spanked hard, twice.
TerrainView
Has segment export / import feature, can select one or several segments at time. This has been documented in PMC Editing Wiki: Falcon 4 Terrain Tiling Tutorial.
The bigger picture problem here arises that the workflow is CATE -> Terrainview, we can do the edits instantly in CATE conf files and re-run them over and over again adjusting and tweaking the files, no work is ever lost with this method. BUT... as soon as we start to edit theater.L2 file in terrainview, we lose the easy CATE L2 changing.
I can quote example of Luk and Tobias Adam working on Europe terrain L2 now, they have apparently worked hard to adjust the terrain so basically any CATE work from me at this point is no-go because it would totally overwrite the hand-made changes by Luk/Tobias. This is very very important to coordinate properly that we should keep away from terrainview editing as long as possible. When all avenues of CATE approach have been exhausted, we can move into final detailing / fixing with terrainview.
Honestly, I'm really sad / scared now as the guys have went to edit L2 manually. I hope the work is good and can be kept for good. This goes for all theaters and all users wanting to edit.
Theater.irc / lcktxtrc.irc
Text file, very easy to separate edits with EditPadPro DIFF feature.
Tiles fartiles.pal
This is no issue because it can be created "on the fly" easily at any time with system like ImageMagik using the existing PCX tiles and nice cmd line.
Tiles Texture.bin
Texture.bin converted to text file is usually handled by me, so if any of the tile artists supply me with new tile-sets to add into the bin, I can do it easily.
I see no reason why several people would need to edit this file.
Tiles Texture.zip
As in the actual tile images, we need to keep them in PCX format which we can convert to dds automatically with SeasonSwitcher, any new edits need to be made to the WHOLE tile-set at once. Clear coordination need to be maintained of who is editing what tile-set.
Trigger files
Text file, very easy to separate edits with EditPadPro DIFF feature.
UI images idx/rsc
Images should be kept in the original TGA file format, I'm personally interested of any photoshop PSD source files for future reference. Coordination should be maintained if more than one user wants to edit for example campmap etc. I guess best artist wins but any larger amount of work for the UI images should be discussed on the forums before starting.
Theater selector logo is only in TGA format, simple to edit for anyone (no need for perl scripts). All photoshop psd source files should be saved!
How to develop theater with several people trying to edit the same files, how to not mess it all up so people are ending up doing overlapping (wasted) work.
CATE
Uses text based CONF files which are easily editable, we can use DIFF on EditPadPro to see different users edits.
However the way PMC development works, is that I will control the CATE work so unless special circumastances arise, I'm the only one editing these files.
CATE CONF files work the same way as Tacedit TCL scripts, we can do small adjustments and tweaks to the theater.L2 file over and over again never losing any work while seeing the end results instantly and covering the whole massive terrain. We must be very very careful on planning when we move from CATE tweaks into Terrainview manual hand editing of the L2 file. There is NO going back to CATE once Terrainview final touches has commenced (well to the point, we can use export segments, what I mean is just generally no going back).
F4Browse
When you edit the database files, they are then set for life for these edits. There is export / import feature to f4e files.
PAK map
It is "raw" image, usually made in Tacedit and edited in paintshoppro / photoshop. I don't know how many users could edit this file simultaneously.
Skins KoreaOBJ
Skins are the <NUMBER>.dds files in FF/OF, one user can edit one skin at the time, we would need to coordinate who wants to edit that <NUMBER> skin. Should be easy. In F4AF they are BMP files which are patched into database with Tex-Man utility.
All photoshop psd source files for all skins should be saved for future edits! This goes for all graphical art work related to theaters. This is very important!
Stations.dat
Red Dog has been PMC airbase / tacan realism guru for years. All airbase work and questions should be re-routed to him.
TacEdit
Export / import feature for objectives, single, selected or all objectives export capability.
Units can be exported to .uni file, I've not actually checked if this is binary or text file, someone people enlighten me.
If several users want to add objectives, they need to request "free OBJ ID range" from me. This means you can use Tacedit Edit -> Base Obj ID, feature to add the ID number from which you can start to add more objectives. Then user of course must stay withing the highest number of assigned free obj id range. Then when he exports the newly created objectives, I can merge them easily with another users additions from his free ID range.
For example user 1 is assigned for OBJ ID's of 2501 - 2600 and user 2 is assigned 2601 - 2700, then if they both fill up the hundred objectives, I can merge the new objectives into full set of 2501 - 2700 objective IDs.
As of campaigns, we use TCL scripts, very simple really. It is the same basic princible as in CATE CONF files, we keep the power of "script" manuscript style in our hands, any changes can be adjusted and tweaked over and over again with instant results and most importantly; no work is ever lost!
TCL's are text files, several users can join to tweak campaigns. For example one user can edit BLUFOR squadrons, another user can do OPFOR helicopters, third user edits BLUFOR ground units... when edited files are ready, they can be sent to each other on the dev team so everyoen has the latest files. All the users edits can be turned on/off as simply as putting # character on one place in the TCL file. It is so beautiful that anyone not understanding it should be spanked hard, twice.
TerrainView
Has segment export / import feature, can select one or several segments at time. This has been documented in PMC Editing Wiki: Falcon 4 Terrain Tiling Tutorial.
The bigger picture problem here arises that the workflow is CATE -> Terrainview, we can do the edits instantly in CATE conf files and re-run them over and over again adjusting and tweaking the files, no work is ever lost with this method. BUT... as soon as we start to edit theater.L2 file in terrainview, we lose the easy CATE L2 changing.
I can quote example of Luk and Tobias Adam working on Europe terrain L2 now, they have apparently worked hard to adjust the terrain so basically any CATE work from me at this point is no-go because it would totally overwrite the hand-made changes by Luk/Tobias. This is very very important to coordinate properly that we should keep away from terrainview editing as long as possible. When all avenues of CATE approach have been exhausted, we can move into final detailing / fixing with terrainview.
Honestly, I'm really sad / scared now as the guys have went to edit L2 manually. I hope the work is good and can be kept for good. This goes for all theaters and all users wanting to edit.
Theater.irc / lcktxtrc.irc
Text file, very easy to separate edits with EditPadPro DIFF feature.
Tiles fartiles.pal
This is no issue because it can be created "on the fly" easily at any time with system like ImageMagik using the existing PCX tiles and nice cmd line.
Tiles Texture.bin
Texture.bin converted to text file is usually handled by me, so if any of the tile artists supply me with new tile-sets to add into the bin, I can do it easily.
I see no reason why several people would need to edit this file.
Tiles Texture.zip
As in the actual tile images, we need to keep them in PCX format which we can convert to dds automatically with SeasonSwitcher, any new edits need to be made to the WHOLE tile-set at once. Clear coordination need to be maintained of who is editing what tile-set.
Trigger files
Text file, very easy to separate edits with EditPadPro DIFF feature.
UI images idx/rsc
Images should be kept in the original TGA file format, I'm personally interested of any photoshop PSD source files for future reference. Coordination should be maintained if more than one user wants to edit for example campmap etc. I guess best artist wins but any larger amount of work for the UI images should be discussed on the forums before starting.
Theater selector logo is only in TGA format, simple to edit for anyone (no need for perl scripts). All photoshop psd source files should be saved!