Skip to content

About

A Python-based donation tracker for Extra Life streams

Topics

Resources

Contributing

Stars

14 stars

Watchers

3 watching

Forks

Latest commit

 

History

1,016 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lint,PyTest, MyPy, and Coverage Windows Build Documentation Status Upload Python Package codecov

Would you like to be able to update your donations in real-time during a Live Stream or while recording a Let's Play as in the animated gif below?

OBSwithExtraLifeRunning

Read ahead to find out how!

If you find this useful, please consider donating to my Extra Life campagin to raise money for the Johns Hopkins Children's Center.

How To for Users

visit: http://djotaku.github.io/ELDonationTracker/ for video instructions on how to use the program.

If you prefer text instructions, read the documentation at: https://eldonationtracker.readthedocs.io/en/latest/index.html

The quickstart instructions are:

  • Go to releases and the most recent release
  • If you're on Windows:
    • grab the file at the bottom
    • launch it
    • Click on the config button to fill out the config
    • Hit run and it will populate the folder you picked in config with the data you can use in OBS/XSplit for your overlay
  • If you're on Linux:
    • You can use PyPi to install eldonationtracker
    • You can git clone this repo, install the requirements and go from there
    • If you don't need the GUI you can use Docker or Podman with a command that looks like: (check version as there may be a delay between newest version and creation of a container)
    docker run -it -v ./extralifedonationtracker:/root/.config/extralifedonationtracker -v ./testoutput:/root/output djotaku/eldonationtracker:latest
    
    # or
    
     podman run -it -v ./extralifedonationtracker:/root/.config/extralifedonationtracker:Z -v ./testoutput:/root/output:Z djotaku/eldonationtracker:latest

How To for developers

Please see CONTRIBUTING.MD if you wish to contribute.

Modules are well-documented at: https://eldonationtracker.readthedocs.io/en/latest/py-modindex.html

Support

If anything goes wrong, please open a Bug Report under issues.

If you want a new type of output data, fill out a Reequest for New Output Data issue

If there's documentation missing, fill out the Missing Documentation issue

AI Usage

In the 11 or so years (since at least 2015) I've been working on this code, I've written nearly all the code on my own. The only AI I've used was:

  • recently to move the code from PyQT for the GUI to using Pyside6 - which was mostly about figuring out which function signatures had changed - the functionality was identical.
  • Part of the 9.1.0 release to find a bug I was having trouble finding on my own. I still did quite a bit of heavy lifting on those changes.

About

A Python-based donation tracker for Extra Life streams

Topics

Resources

Contributing

Stars

14 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages