Quoted from BrianMadden:I have a favor to ask everyone in this thread.
I'm the maintainer of MPF and related projects (MPF-MC, MPF Monitor, MPF Docs). I still spend many hours a week on it (all unpaid volunteer), literally right now working on updates for MPF 0.57 which will allow it to run on versions of Python newer than 3.9.) jabdoa and I alone wrote about 98% of MPF over many thousands of hours over the past 9 years. We also wrote about 95% of the documentation. (I'm the guy who spent a week of full time work moving the docs to the new platform last month. for example.)
We don't ask for much in return. We don't need credit. We don't need money. We don't need glory. You will not find our names in IPDB or the Pinball HOF.
What we need, and what we plead and beg for, is your help with documentation!
When I originally envisioned MPF, (Fun nostalgic link to the Pinside announcement post from 9 years ago), I thought it would follow the arc of typical open source projects where we'd get lots of contributors and people working on it. That hasn't really happened (though there are a few other people who've written a lot of code for it, Q-Dog and avanwinkle get shout outs). In hindsight I think that's because MPF is geared for "non coders", so by definition the user base doesn't know Python or software engineering, and anyone who both loves writing software and making pinball is probably going to write their own code from scratch and not use MPF. So that's fine. (Though we'd love more help if you are a Python and pinball guru!)
But the bar for writing the documentation is way lower. So, for real, any time you're on the MPF docs site and you figure something out that isn't documented, or you think something could be explained better, or something is confusing, or you just see a typo, I'm begging you, PLEASE click the edit button on the page and add to or fix the page. The changes you make go into a queue and be approved, so there is no chance of breaking anything!
If you don't know where to start or you don't want to deal with it, you can email me the page you want to change ([email protected]) and I'll make the change. (But really it's easy, you can learn!) I put some instructions together which are linked from the bottom of every page on the site. If that's not enough, I can make a video, or walkthrough.. whatever it takes!
This is all we ask. By using MPF, you get access to tens of thousands of hours of work for free. Openhub estimates (using the COCOMO method) the MPF project as worth $2.7m! (Sure we can nit-pick the specifics but the point remains it has been a lot of work!)
We love seeing the hundreds of machines created, and reading through the pages and pages of posts talking about how helpful MPF is. It's immensely satisfying that we actually helped bring more pinball into the world! I have to pinch myself when I walk into Add-a-Ball (down the street from me in Seattle) and see STIrby's Eight Ball Beyond in revenue service on location, knowing that's running MPF!
Awesome, amazing, love it all!!!
All we ask is your help to give back to the community and help everyone by sharing what you learned in the docs. So all these tips and tricks and advice (which you all know better than me since I personally have never actually made a game with MPF), please help get this into the docs!
Thanks, and happing pinball making!!!
Brian