Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 3.09 KB

README.md

File metadata and controls

79 lines (58 loc) · 3.09 KB
Raw

PopTracker

Powerful open progress tracker is a project to offer a universal, scriptable randomizer tracking solution that it is open source, runs everywhere and supports auto-tracking.

Getting started

This is work in progress. Some pre-existing packs work, some do not.

Download a binary release or build from source.

Copy or unpack tracker packs to EXEDIR/packs, HOME/PopTracker/packs, Documents/PopTracker/packs or CWD/packs. On Windows it will also find packs installed in EmoTracker. On macOS EXEDIR is inside the app bundle.

Use the Load button in the top left corner to load a pack.

Do not load untrusted packs until some sort of fuzzing is done.

Binary release is Windows 64bit and macOS 64bit only at the moment (see Download prebuilt exe or app),
should compile on most unix-like OS (see Building from source).
WASM support still needs a lot of work.

Check BUILD.md, CONTRIBUTING.md, doc/OUTLINE.md and doc/TODO.md if you want to join in on the development journey.

Check doc/PACKS.md if you want to write a gamepack for this tracker.

Upstream URL is https://github.com/black-sliver/PopTracker/

Screenshot

Screenshot

Download prebuilt exe or app

Head over to releases and unfold "Assets" of the latest release or pre-release.

Building from source

See BUILD.md.

Supported/tested packs

more to be tested

Join the Community Discord to find pack repositories, follow updates and get support.

Auto-tracking

SNES Games

Requires SNI or QUsb2Snes (flash cart, emu, snes mini) or usb2snes (flash cart only). See their respective documentation.

PC Games

We do not allow direct access to process memory or sockets from Lua. Instead UAT can be used to recieve "variables".

Archipelago Multiworld

Archipelago allows connecting to a Multiworld as a tracker. An Archipelago client is included. Click on the grey "AT" to connect to a server if the pack supports it. See doc/AUTOTRACKING.md for more details.

Other systems

No work has been done for other systems yet.

Version Numbering

  • Major update (X.0.0) may break everything
  • Minor update (0.X.0) may change render output (i.e. window captures break)
  • Revisions (0.0.X) should only fix bugs and add non-breaking features