search

X2CommunityCore / xcom2-launcher

The Alternative Mod Launcher (AML) is a replacement for the default game launchers from XCOM 2 and XCOM Chimera Squad.
GNU General Public License v3.0
347 stars 51 forks source link

Add "readme.md" file extension support for Readme. #230

Closed aggies11 closed 4 years ago

aggies11 commented 4 years ago

Current version only looks for "readme.txt" file to populate the readme section of the mod entry.

Many mods seem to be including "readme.md" files instead. So just added the ability to also look for and load this file in addition to readme.txt

Future versions might want to add a file extension agnostic method of handling readme files (eg. Readme files with any or no extension).

RevZero commented 4 years ago

Thanks for the contribution, I did not notice that until now. Please try to conform to common AML code style (indentation, line breaks, braces etc.) next time.

Readme.md is the default for XCOM Chimera Squad SDK it seems. I have only one of my 300+ X2 mods using that read-me file name. However, I see no reason why we shouldn't just check both files in this way for now. A future improvement would be proper Markdown/BBCode formatting. I will look into that if I find the time.