Q&A

*the above permissions are granted by the following conditions:

• You shall include the license file in your game files.
  Put it in the same .zip, for example, and maybe rename it to RESOLUTIONARY-LICENSE.TXT for clarifying that the license applies only to Resolutionary, not your game.
• You shall credit me by mentioning Resolutionary and me as its creator.
  You could, for example, add something like this to your game's credits:
  • This game uses Resolutionary by Lassi Lehtinen (aka lcl / lclMetal) for multi-resolution support. More info: lclmetal.github.io/Resolutionary/

General guidelines on contributing

Here's some advice for contributing to the project. Notice that the better you explain what you've done and why, the easier it will be to evaluate your contribution. Making the evaluation process easier is likely to increase the chances of your contribution being added to Resolutionary.

1. Adding new actors, animations, global variables or actor variables is not desirable, so try to avoid them if you can. Obviously, sometimes there is no other way than to use them - in such cases you're free to go ahead and do so.
2. All changes to the Global Code page Resolutionary must also be saved to the file Resolutionary.c. This makes it much easier to track any changes made to the code.
3. Document and explain what you do. Any changes in the events of the actors are not easily noticeable, so make sure to write down the changes and/or additions you've made. Explain what you've done and why. If you're contributing on GitHub, this info belongs to the Pull Request message. If you're contributing outside of GitHub, add this info either to the email or to a MESSAGE.txt file which you then include in the .zip.
4. If you make changes to code in the events of the project actors or add new events, please make sure to note which codes you changed and what modifications or additions you made.
5. Please follow the coding conventions of the project:
   • Maximum row length is 98 characters
   • Each indent is 4 spaces wide
   • Use lowerCamelCase
   • Use Allman style braces

     if (contributingToResolutionary)
     {
         useAllmanStyleBraces = 1;
     }

   • Comment functions using the following format:

     // Description of what the function does, can be divided on multiple rows,
     // if required for staying within the maximum row length of 98 characters
     // paramName - what should be given as the argument for the parameter
     // paramName2 - what should be given as the argument for the second parameter
     // returns: what the function returns (if the return type is void, this field is omitted)
     //
     // Example:
     //
     // This function returns the sum of two integer values given as arguments
     // num1 - first integer value
     // num2 - second integer value
     // returns: the sum of the given integers values num1 and num2
     int resSum(int num1, int num2)
     {
         return num1 + num2;
     }

   • Prefix all actor names, animation names, function names, global constant names, actor variable names and global variable names with res followed by a capital letter. Local variable names and struct member names need not be prefixed.