Releases: djotaku/ELDonationTracker
v4.3.0 Both User and Developer Features Added!
Installation/Usage Instructions
tl;dr: Windows users grab the zip file below. Linux users use PyPi or git clone.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
-
The default image and sound for the tracker are no longer part of the zip file. If you don't have an image and sound you want to use, you can click a button to grab it from GitHub and it will be placed on your system and the configs will point to it. As a bonus, this means that you don't need to reset the image and sound locations every time there's a new release.
-
There are now buttons in the settings window to validate the participant ID and team ID in case you made a typo.
I will be producing a new set of Youtube videos covering the new features.
Developer-Facing Changes
- There are now str methods on all the classes which may be helpful if you're using this Python package as an API
- The API URL has been moved to init.py so that if the URL changes, I don't have to dig for it in a bunch of places
- A bunch more unit tests were created, bringing coverage up from 68% to 71%. This should help resilience when refactoring.
v4.2.0 You can now change all the colors and the font in the Tracker Window
Installation/Usage Instructions
tl;dr: Windows users grab the zip file below. Linux users use PyPi or git clone.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
- To accommodate the new tracker options, the participant.conf has been changed to version 2. When you launch the GUI you have two options: You can have it automatically grab the latest participant.conf from github (but then you will need to redo all the values) or you can have it keep your values and once you hit "persistent save", your config file will be updated to the 2.0 schema.
- You can now change the font, font color, and background color in the tracker window. See instructions above, but a quick gotcha to know is that if you hit "cancel" in either of the color dialogs, it will set the color to black. Just go back in and pick a color from the left palette OR move the right-most slider from black to white and then pick a color in the big color gradient. Remember that the background color should be one that OBS or XSplit can easily remove with Chroma-key. I recommend the default green, but bluescreen blue should work well as well.
Developer-Facing Changes
- There were a few internal methods added to some classes as well as some external methods, but nothing that should change the API if you were importing this package in Python and accessing the methods. (See the commit diff to see what exactly has changed)
v4.1.3 White Tracker Text!
Installation/Usage Instructions
tl;dr: Windows users grab the zip file below. Linux users use PyPi or git clone.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
The tracker font is now white. This should make it much more useful. And soon I plan to implement issue #14 which will allow you to pick whatever color makes the most sense for your videos.
Developer-Facing Changes
None this time.
v4.1.2 Automated creation of Participant.conf
Installation/Usage Instructions
tl;dr: Windows users grab the zip file below. Linux users use PyPi or git clone.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
If the program cannot find your configuration file (participant.conf), it will create one for you by downloading the latest version from Github. For Linux users it will be at $HOME/.config/extralifedonationtracker and for Windows users it will be at C:\Users\username\AppData\Roaming\config\extralifedonationtracker. (Substitute your username in that path)
Developer-Facing Changes
v4.1.1 BUGFIX! Top Team Participants
A bug snuck in when I was editing for PEP8 and I didn't realize it (need better unit tests!) So please update to this version at your earliest convenience.
Repeating a bit of last time's release notes in case someone misses that. I'll probably be restructuring into another format on the next release.
Since Pyinstaller is not a cross-compiler, it is very particular to the system that runs it. Github CI builds were causing issues on my Fedora system and on my wife's older Ubuntu, it wouldn't even run for lack of a certain version of libC.
If you're a Linux user who liked the GUI, don't panic! You can still use the GUI. Only your "installation" will be different from now on. Follow the instructions at https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-pypi for a PyPi installation or the Commandline instructions https://eldonationtracker.readthedocs.io/en/latest/installation.html#commandline-users-and-or-developers for a Github-based installation.
Windows users - nothing has changed for you.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Enjoy!
v4.1.0 Some Unit Test Updates
Nothing changes for the average user since version v4.0.1, so reproducing those release notes here:
Since Pyinstaller is not a cross-compiler, it is very particular to the system that runs it. Github CI builds were causing issues on my Fedora system and on my wife's older Ubuntu, it wouldn't even run for lack of a certain version of libC.
If you're a Linux user who liked the GUI, don't panic! You can still use the GUI. Only your "installation" will be different from now on. Follow the instructions at https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-pypi for a PyPi installation or the Commandline instructions https://eldonationtracker.readthedocs.io/en/latest/installation.html#commandline-users-and-or-developers for a Github-based installation.
Windows users - nothing has changed for you.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Enjoy!
v4.0.1 No More Linux Pyinstaller Builds
Since Pyinstaller is not a cross-compiler, it is very particular to the system that runs it. Github CI builds were causing issues on my Fedora system and on my wife's older Ubuntu, it wouldn't even run for lack of a certain version of libC.
If you're a Linux user who liked the GUI, don't panic! You can still use the GUI. Only your "installation" will be different from now on. Follow the instructions at https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-pypi for a PyPi installation or the Commandline instructions https://eldonationtracker.readthedocs.io/en/latest/installation.html#commandline-users-and-or-developers for a Github-based installation.
Windows users - nothing has changed for you.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html#via-github
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Enjoy!
V4.0.0 New Menu Items
Added a help menu at the top that will take you to the documentation or let you know if there's a newer version available! I'll add this to the next instructional video I make.
Going forward, if you're using the GUI single executable on Linux or if you're using PyPi to manage installs/upgrades, you'll need to put participant.conf in the persistent location before starting.
I have found one small thing that I'm not sure right now how to fix. If you're using the tracker (pops up picture/sound upon donation) and aren't using persistent settings, after setting the sound you want - you may need to exit out of the program and start it up again to get consistent behavior on the tracker.
If you're using on the commandline, the files have moved one sub-folder deeper.
If you're upgrading from a pre-V3.0 version, please see the release notes for v3.0: https://github.com/djotaku/ELDonationTracker/releases/tag/v3.0
If you're a GUI user:
pyinstaller created releases that will allow you to run this program even if you don't have Python or the necessary libraries installed. Download either Extra.Life.Donation.Tracker.for.Windows or .for.Linux depending on your platform.
If you prefer to use the commandline utilities without the GUI, just download the source code.tar.gz (Linux) or source code.zip file (Windows). (Or clone the repo.)
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Enjoy!
v3.4.1 More PyPi fixes
This version fixes import issues when running from PyPi. If PyPi turns out to be fully working, will be updating the documentation in readthedocs to reflect that.
Going forward, if you're using the GUI single executable on Linux or if you're using PyPi to manage installs/upgrades, you'll need to put participant.conf in the persistent location before starting.
I have found one small thing that I'm not sure right now how to fix. If you're using the tracker (pops up picture/sound upon donation) and aren't using persistent settings, after setting the sound you want - you may need to exit out of the program and start it up again to get consistent behavior on the tracker.
If you're using on the commandline, the files have moved one sub-folder deeper. On the plus side, you should soon be able to just install from PyPi if you wish to use the commandline.
If you're upgrading from a pre-V3.0 version, please see the release notes for v3.0: https://github.com/djotaku/ELDonationTracker/releases/tag/v3.0
If you're a GUI user:
pyinstaller created releases that will allow you to run this program even if you don't have Python or the necessary libraries installed. Download either Extra.Life.Donation.Tracker.for.Windows or .for.Linux depending on your platform.
If you prefer to use the commandline utilities without the GUI, just download the source code.tar.gz (Linux) or source code.zip file (Windows). (Or clone the repo.)
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Enjoy!
v3.4 PyPi Import Fixes
This version fixes import issues when running from PyPi. If PyPi turns out to be fully working, will be updating the documentation in readthedocs to reflect that.
This version has a bug in Linux where it doesn't find the participant.conf in the pyinstaller-created binary. But it works on Windows. So, if you're a Linux user - for now stick with https://github.com/djotaku/ELDonationTracker/releases/tag/v3.3.2 . I'm tracking this fix in issue #67 and will make a v3.4.1 release when I get that working again. This version will work if you are using persistent configs, but I want things working correctly, so I'm not including the Pyinstaller binary.
Otherwise, if you're using the Pyinstaller binaries, nothing has changed https://github.com/djotaku/ELDonationTracker/releases/tag/v3.2.1 .
The usual info:
I have found one small thing that I'm not sure right now how to fix. If you're using the tracker (pops up picture/sound upon donation) and aren't using persistent settings, after setting the sound you want - you may need to exit out of the program and start it up again to get consistent behavior on the tracker.
If you're using on the commandline, the files have moved one sub-folder deeper. On the plus side, you should soon be able to just install from PyPi if you wish to use the commandline.
If you're upgrading from a pre-V3.0 version, please see the release notes for v3.0: https://github.com/djotaku/ELDonationTracker/releases/tag/v3.0
If you're a GUI user:
pyinstaller created releases that will allow you to run this program even if you don't have Python or the necessary libraries installed. Download either Extra.Life.Donation.Tracker.for.Windows or .for.Linux depending on your platform.
If you prefer to use the commandline utilities without the GUI, just download the source code.tar.gz (Linux) or source code.zip file (Windows). (Or clone the repo.)
Please file any bug reports on either the GUI or the commandline! Pull requests welcome on the devel branch.
Enjoy!