Skip to content

Latest commit

 

History

History
135 lines (103 loc) · 8.15 KB

README.md

File metadata and controls

135 lines (103 loc) · 8.15 KB

LiveSplit AutoSplit CodeQL Lint and build

SemVer Ruff Ruff format Checked with pyright Checked with mypy

Easy to use image comparison based auto splitter for speedrunning on console or PC.

This program can be used to automatically start, split, and reset your preferred speedrun timer by comparing images to a capture region. This allows you to focus more on your speedrun and less on managing your timer. It also improves the accuracy of your splits. It can be used in tandem with any speedrun timer that accepts hotkeys (LiveSplit, WSplit, etc.), and can be integrated with LiveSplit.

Example

Tutorial

To understand how to use AutoSplit and how it works in-depth, please read the tutorial.

Download and open

  • Download the latest version

  • You can also check out the latest dev builds (requires a GitHub account)
    (If you don't have a GitHub account, you can try nightly.link)

  • Linux users must ensure they are in the tty and input groups and have write access to /dev/uinput. You can run the following commands to do so:

    sudo usermod -a -G tty,input $USER
sudo touch /dev/uinput
sudo chmod +0666 /dev/uinput
echo 'KERNEL=="uinput", TAG+="uaccess"' | sudo tee /etc/udev/rules.d/50-uinput.rules
echo 'SUBSYSTEM=="input", MODE="0666" GROUP="plugdev"' | sudo tee /etc/udev/rules.d/12-input.rules
echo 'SUBSYSTEM=="misc", MODE="0666" GROUP="plugdev"' | sudo tee -a /etc/udev/rules.d/12-input.rules
echo 'SUBSYSTEM=="tty", MODE="0666" GROUP="plugdev"' | sudo tee -a /etc/udev/rules.d/12-input.rules
loginctl terminate-user $USER

    All screen capture method are incompatible with Wayland. Follow this guide to disable it.

Compatibility

  • Windows 10 and 11.
  • Linux (still in early development)
    • Should work on Ubuntu 20.04+ (Only tested on Ubuntu 22.04)
    • Wayland is not currently supported
    • WSL2/WSLg requires an additional Desktop Environment, external X11 server, and/or systemd
  • Python 3.11+ (Not required for normal use. Refer to the build instructions if you'd like run the application directly in Python).

Timer Integration

Timer Global Hotkeys

Out of the box, AutoSplit works by listening for keyboard events and sending virtual keystrokes. This makes AutoSplit compatible with any timer by configuring your hotkeys to be the same. See the Timer Global Hotkeys Tutorial.

LiveSplit Integration

The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit. LiveSplit integration is only supported in AutoSplit v1.6.0 or higher. This integration will allow you to:

  • Use hotkeys directly from LiveSplit to control AutoSplit and LiveSplit together
  • Load AutoSplit and any AutoSplit profile automatically when opening a LiveSplit layout.

See the installation instructions.

Known Limitations

  • For many games, it will be difficult to find a split image for the last split of the run.
  • The window of the capture region cannot be minimized.
  • Linux support is incomplete and we're looking for contributors.

Resources

Still need help?

Contributing

See CONTRIBUTING.md for our contributing standards.
Refer to the build instructions if you're interested in building the application yourself or running it in Python.

Not a developer? You can still help through the following methods:

Credits

  • Created by Toufool and Faschz.
  • Harutaka Kawamura for the snipping tool code that I used to integrate into the autosplitter.
  • amaringos for the icon.
  • Zana_G for motivating me to start this project back up and for all of the time spent testing and suggesting improvements.
  • Avasam for their continued work on making an incredible amount of improvements and changes to AutoSplit while I have not had the time/motivation to do so.
  • KaDiWa for the LiveSplit integration.
  • Tyron18 for assisting with Windows 11 testing.

Donate

If you enjoy using the program, please consider donating. Thank you!

paypal