RA1 Full Map Preview Generator

[Iran]

https://github.com/Iran/RAFullMapPreviewGenerator

 

This tool generates a preview image of a map using the game's graphics. It's written in c# 2.0 and requires the .Net framework v2.0.

 

This uses code from OpenRA and code that hifi gave me. Thanks go to Mailaender and pchote for helping me with using the OpenRA code and answering questions. Nyerguds also helped with answering my questions, documenting the tile sets ID mappings used by the game and documenting the remap colors stuff for every color remap. Additional thanks go to the FreeCNC documentation of the game's map format and C&C-RAED for showing me how things should somewhat look like.

 

Usage:

ExeFile InputMap [OutputImage] [--DrawVisibleOnly]

 

Example:

RAFullMapPreviewGenerator.exe x.ini derp.png --DrawVisibleOnly

 

The '--DrawVisibleOnly' option only draws the part of the map that's visible in-game.

If 'OutPutImage' is left out the filename + '.png' is used as file name of the output image.

 

 

THIS IS STILL A BETA SO THE TOOL MIGHT CRASH OR GIVE INCORRECT RESULTS

 

https://dl.dropboxusercontent.com/u/21865790/RA%20Full%20Map%20Preview%20Generator.zip

[Nyerguds]

Nyerguds also helped with answering my questions, documenting the tile sets ID mappings used by the game and documenting the remap colors stuff for every color remap.

...none of that really applies to RA1, though

[Matt]

https://github.com/Iran/RAFullMapPreviewGenerator

 

This uses code from OpenRA

 

You need to distribute https://github.com/OpenRA/OpenRA/blob/bleed/COPYING with the source code and binaries to comply with the license.

[Iran]

I've added that file to the git repo now.

[Matt]

I just noticed that you copy & pasted some code https://github.com/Iran/RAFullMapPreviewGenerator/blob/master/FileFormats/Platform.cs#L45 but without the license reminder in each file. You should at least mention https://github.com/OpenRA/OpenRA in the README. Backspaceware is not cool and really demotivates everyone who lives the Open Source idea.

[Iran]

So what do I need to do? re-add the copy header at the top of the files?

[Matt]

That would be the optimal solution. See also https://github.com/zzattack/ccmaps-net/issues/2 as you are not the only one who is not used to how the GNU GPL works.

[Iran]

Well the problem is that some of the files heavily modified OpenRA code, like RenderUtils.cs. I've also changed the TemplateReader and ShpReader classes slightly and added two new functions to the Palette code to make it easier to load a palette with custom remap for a side and for civilians. Do I add myself to the copyright holder list for those files in addition to listing the OpenRA authors? The platform file isn't modified at all so that should have the original openRA copyright header.

[Matt]

You can certainly change the code to your needs and take credit for your modifications. You just need to preserve the original copyright and license. http://www.gnu.org/licenses/gpl-faq.html#IWantCredit It makes sense to do this per-file as you mixed OpenRA source code with stuff gathered from other sources like Nyerguds who seems to prefer a custom WTFPL like attribution without copyleft.

[Iran]

Okay I've added the original header file to the OpenRA code I didn't modify (Format40/Format80/Platform.cs) and I added the following header to the ones I did:

 

#region Copyright & License Information

/*

* Copyright 2007-2012 The OpenRA Developers (see AUTHORS)

* This file is part of OpenRA, which is free software. It is made

* available to you under the terms of the GNU General Public License

* as published by the Free Software Foundation. For more information,

* see COPYING.

*

* Additional modifications were made to this code by Iran.

*/

#endregion

 

Do I need to supply the COPYING text file with binaries?

[Matt]

Do I need to supply the COPYING text file with binaries?

 

Yes, the FSF is pretty strict about this http://www.gnu.org/licenses/gpl-faq.html#WhyMustIInclude not like the Creative Commons ones where an URL is enough.

[Iran]

Thanks for looking into it, I'll update the binary distribution and add the file.

 

Could you take a look at the github repo code now and check if the headers look OK now? I gotta update the C&C preview and RA thumbnail tools too.

[Matt]

Perfect, thanks for the quick fix.

[Iran]

I've updated the binary distributions and source code for the C&C full map preview tool and the RA thumbnail generator too now to comply with the license. Thanks again for bringing it to my attention and also explaining to me what to do with modified OpenRA code files.