Hello to the pretty brief guide to using Punduction, please follow these instructions as closely as you can to ensure a smooth process to getting you on your way. If you have any questions you can contact me on twitter
If you'd like to support the project you can donate at https://ko-fi.com/punlife, any donation is appreciated, thank you for your generosity!
Hope you enjoy your time using Punduction!
Punlife
Punduction is a controller for stream overlays that works with some of the available APIs for tournament hosting websites to flexibly populate your overlays, HTML or text based ones.
I've attached a couple of Powered by Punduction logos that you can place on your stream/overlays as a way of supporting the application, this is not in anyway mandatory but it makes me feel warm and fuzzy inside to see the application used across a range of streams. These assets can be found in the brandAssets folder.
You are required to obtain your own API keys to use with Punduction, I am unable to give you access to my personal keys.
You can find the instructions for generating an API key here. (If you are unable to generate the key using these instructions I suggest joining the SmashGG discord and requesting help from the staff there).
You can access the instructions in the Authentication section of the Challonge API documentation.
You can report any bugs you find here (along with suggestions and feedback of any kind)
Make sure you download the prerequisites provided on the release page of the Punduction repository https://github.com/punlife/Punduction-release/releases. Following the instructions provided within that ZIP file then proceed with the instructions below (either written or video)
Loading Challonge data - https://youtu.be/yhR9lXCY65c
Loading SmashGG data or raw data - https://youtu.be/ley9rOr9O8w
I'd recommend placing all the overlays within the overlay folder and making a separate folder for each set of overlays. The example JS script within the folder can be used to populate your HTML overlay files.
In the v1.0, Punduction doesn't have a native way of editing its own internal database of round names, countries, commentators and teams. However, there is still a relatively easy and quick way of editing the database and that is to use DB Browser for SQLite. This tool will allow you to edit PunductionRepository.db file within the application directory which is where the database is stored. Please ensure you don't add any new fields manually as the app will just ignore them, do feel free to request additional information to be added through the suggestions/feedback form linked at the top of this file.
Any of these shortcuts can be changed in the Settings tab. Please do pay attention not to use Shift and any other key as a combination, but you can use Shift+Another modifier (Ctrl/Alt) + Letter/Number/Key without issues. If you do end up using shift Windows throws out an exception and kills the application (you can reset the settings if you do gets stuck with this problem by deleting the settings file itself which is found within the Settings folder).