HamaIndustries / FEMultiPlayer-V2

Reupload & revamp of FEMP with fresh bugfixes... usually. Check "releases" for download.
http://eliatlarge.github.io/FEMultiPlayer-V2/
GNU General Public License v3.0
27 stars 31 forks source link

app.config is undocumented #159

Open wellme opened 6 years ago

wellme commented 6 years ago

Description:

In app.config, there are several options that would require documentation as their name do not reflect their effect on the game. For instance, "scale" might make sense to someone that is used to FEMP, but to a newcomer, "resolution multiplier" is probably not the first thing that comes to mind. Idem for all the music options and keybinds. There's also the issue that enum-typed parameters are unknown to the end user. The only way a user can know the options for the autocursor is to look directly into the code.

HamaIndustries commented 6 years ago

Honestly, we need to rewrite or redo the intro pdf. It hasn't been updated since we started, and including app.config changes along with stats in a new pdf should keep people from needing to ask the same questions. If nobody is able to pick this up in a week or two, I'll take care of it. Thanks for noting this wellme.

ghost commented 6 years ago

I can't promise an ETA, but it's something I've been slowly chipping at. Emphasis on slowly. Some of it will have to wait until a few of the major PRs are done so I can get screenshots of some additional finalized content that's WIP.

wellme commented 6 years ago

If we're rewriting the manual, it would probably be a good idea to include a section for hosting without port forwarding using a VPN like Hamachi considering how often people have issues hosting a server.