186 lines
14 KiB
Raw Normal View History

2022-07-27 02:00:23 +02:00
## arch1t3cht's Aegisub "fork"
Go [here](#branchfeature-list) for the new features.
### Don't we have enough Aegisub forks already??
2022-09-27 22:40:04 +02:00
We absolutely do, and I'm aware that adding another one [doesn't sound like]( a [good idea on paper]( However,
2022-07-27 02:00:23 +02:00
- None of the existing forks are completely satisfying at the moment:
- [wangqr's fork]( is actively maintained, but focussing more on stability. It's missing most of the modern features.
- [AegisubDC]( has the most modern features (in particular video-panning), but is Windows-only and not actively maintained anymore.
- [The TypesettingTools fork]( is the one that will one day become the upstream version and builds relatively effortlessly on all operating systems, but at the moment it's not moving much. It's the base for this fork, and I hope to one day merge most of these additions into it.
- Only PR'ing the changes in here to various forks would cause even more chaos
- ~~I try to convince myself that this isn't really a "fork" in the traditional sense - one which aims to provide extended support and stability fixes. It's a collection of new feature additions which I built myself, together with some of the most important new features floating around other forks.~~ At this point it's probably too late to still be saying this. Still, the general mission hasn't changed. This fork collects new features and critical bugfixes, but won't be putting extra time into maintenance aspects like cleanup and refactors. Partly, this is also because any big refactors would make it harder to pull these changes into upstream repositories or future forks.
2022-07-27 02:00:23 +02:00
While this is usually also the version of Aegisub I'm currently using, I make no promises on stability. **Don't** use this version if you're just looking for any version of Aegisub - this is mostly intended for typesetting and other advanced usage.
2022-07-27 02:00:23 +02:00
### Organization
Being a collection of different feature additions, this repository consists of a set of branches for different features, so that they can easily be merged into other repositories. The [`feature`]( branch merges together all the features I deem as currently usable. Due to the structure of the repository, I will be force-pushing to this branch and some of the individual branches very frequently, so they're not ideal for basing further branches on.
The `cibuilds` branch makes some CI builds of snapshots of `feature` at relevant points in time.
### Branch/Feature list
This list is for navigating the repository. Go to the [release page]( for a more structured changelog.
2022-07-27 02:00:23 +02:00
- [`folding`]( Add the ability to visually group and collapse lines in the subtitle grid
- [`lua_api`]( Add new functions to the Lua automation API, like controlling the selection or cursor in the text edit box
2022-07-27 02:00:23 +02:00
- [`vector_clip_actions`]( Make the different modes of the vector clip tool (lines, bezier curves, adding points, etc) bindable to hotkeys
- [`color_picker_fix2`]( Add an option (under "Interface") to restrict the color picker to the window, which fixes the color picker on Linux in a lot of cases.
2022-08-16 20:54:49 +02:00
- [`avisynth`]( Reenable Avisynth support on Windows and enable Avisynth on Linux
- [`bestsource`]( Add BestSource audio and video source. This source is slower than others by multiple orders of magnitude, but in exchange it can guarantee exact seeking.
2022-08-17 02:59:15 +02:00
- [`vapoursynth`]( Add Vapoursynth audio and video source
2022-08-16 20:54:49 +02:00
- [`bugfixes`]( Various fixes necessary for compilation. Most branches are based on this.
2022-09-27 22:40:04 +02:00
- [`workarounds`]( Same as `bugfixes`, but these are hacky fixes that probably shouldn't be pulled without more work.
2022-08-16 20:54:49 +02:00
- [`fixes`]( Miscellaneous bugfixes
- [`misc`]( Other miscellaneous additions
- [`wangqr_gui`]( Merge wangqr's changes regarding the GUI. In particular, add high-DPI compatibility.
2022-07-30 03:36:33 +02:00
- [`misc_dc`]( Miscellaneous changes taken from AegisubDC
2022-09-27 22:40:04 +02:00
- [`xa2-ds`]( Add XAudio2 backend and allow stereo playback for some other backends, by wangqr and Shinon.
- [`stereo`]( Add multi-channel support for the other audio backends where possible.
2022-11-02 23:08:36 +01:00
- [`video_panning_option`]( Merge [moex3's video zoom and panning](, with several bugfixes and more options to control zoom behavior
2022-07-27 02:00:23 +02:00
- [`spectrum-frequency-mapping`]( Merge EleonoreMizo's [spectrum display improvements](, and also make Shift+Scroll vertically zoom the audio display
- [`wangqr_time_video`]( Merge wangqr's feature adding a tool for timing subtitles to changes in the video
2022-07-27 02:00:23 +02:00
### Troubleshooting
I'll gladly take any bug reports, but if you encounter an issue, please check first if it occurs only on my fork, or also on [earlier TSTools builds](
If it wasn't introduced by my fork, I can still take a look, but I can't promise anything.
You can find me for support on various servers, including the cave and the TSTools server linked below.
2022-07-27 02:00:23 +02:00
#### Aegisub on Linux doesn't recognize my GTK theme
This is probably because you're building with wxgtk2. Building with wxgtk3 fixes this, but causes some problems of its own (notably the broken color picker, occasional crashes when opening file dialogs from automation scripts, and general layouting issues).
2022-09-27 22:40:04 +02:00
The exact way of switching depends on your Linux distribution, but essentially you need to ensure that `wx-config` or the next best variant of it points to wxgtk3. If it points to wxgtk2 by default and deinstalling wxgtk2 isn't an option, you can also temporarily move it out of the path or use a `native-file` in your meson project. Then, fully reconfigure meson using `meson configure --clearcache` and `meson setup --reconfigure`.
2022-07-27 02:00:23 +02:00
#### I get errors like "Option not found" after merging one of these branches
The changes to `default_config.json` or similar files weren't detected by meson due to missing regen dependencies. You can either merge the `bugfixes` branch or rebuild from scratch.
2022-07-30 01:51:46 +02:00
#### The video is desynced / Frames don't appear at the right time
2022-08-16 20:54:49 +02:00
This is probably due to the ffms2 seeking bug ([#394]( On Windows, this specific regression shouldn't happen anymore. On Linux, you need to install the latest git version of ffms2 - for example the [`ffms2-git`]( AUR package on Arch linux, or just compile it yourself.
If it's not because of this particular bug, you can also try an alternative video source like LSMASHSource via Avisynth or Vapoursynth, or BestSource.
2022-07-30 01:51:46 +02:00
#### On Windows: Aegisub crashes whenever I open a video
If you're compiling yourself, try adding `--force-fallback-for=zlib` to the meson options.
2022-07-27 02:00:23 +02:00
### Compilation
For compilation on Windows, see the TSTools documentation below. Also check the [GitHub workflow]( for the project arguments.
On Arch Linux, there is an AUR package called [aegisub-arch1t3cht-git]( It's not maintained by me but seems to work.
On other distributions or for manual compilation you can use this package or the [TSTools PKGBUILD]( as a reference, in particular for installing the necessary dependencies if you don't want to compile them yourself.
If all dependencies are installed:
- Install Meson
- Clone the repository
- In the repository, run `meson setup build --buildtype=release` for the default configuration. See below for further options.
- `cd` to the `build` directory and run `ninja`
- You'll get an `aegisub` binary in the `build` folder. To install it to a system-wide location, run `ninja install`. To install to `/usr` instead of `/usr/local`, pass `--prefix=/usr` when configuring or reconfiguring meson.
- When recompiling after pulling new commits, skip the `meson setup` setup and just immediately run `ninja` from the build directory - even when the build configuration changed.
#### Compilation flags
Some features are not enabled by default. To enable them, pass `-D<feature>=enabled` with the `meson setup` command:
- `-Davisynth=enabled`: Avisynth support
- `-Dbestsource=enabled`: BestSource
- `-Dvapoursynth=enabled`: Vapoursynth support
You can also disable options that are active by default in the same way. Check the file `meson_options.txt` for all options.
To change the options of an existing build directory, run `meson setup --reconfigure <new arguments>` from inside the `build` directory.
### Dependencies
Apart from the dependencies for the TSTools version, there are some additional dependencies. These are cloned and compiled from scratch if not found, but you might want to install binaries instead:
- `jansson`: For BestSource
- `ffmpeg`: Becomes a direct dependency when compiling with BestSource
- `avisynth` (or `avisynthplus`): Optional run-time dependency for the Avisynth source
- `vapoursynth`: Optional run-time dependency for the VapourSynth source
The following VapourSynth plugins are used by the default scripts set in the default configuration:
- [`lsmas`]( For LWLibavSource
- [`bas`]( For BestAudioSource
- [`wwxd`]( and [`scxvid`]( (depending on settings): For keyframe generation
2013-04-22 00:49:30 +02:00
# Aegisub
For binaries and general information [see the homepage](
2021-01-16 10:53:09 +01:00
The bug tracker can be found at
2013-04-22 00:49:30 +02:00
Support is available on [Discord]( or [IRC](irc://
2013-04-22 00:49:30 +02:00
## Building Aegisub
### Windows
1. Visual Studio (Community edition of any recent version is fine)
2015-07-30 16:07:28 +02:00
2. The June 2010 DirectX SDK (the final release before DirectSound was dropped)
3. Python 3
4. Meson
5. CMake
6. Powershell execution policy set to Unrestricted
2013-04-22 00:49:30 +02:00
There are a few optional dependencies that must be installed and on your PATH:
2013-04-22 00:49:30 +02:00
1. msgfmt, to build the translations
2. InnoSetup, to build the regular installer
3. 7zip, to build the regular installer
4. Moonscript, to build the regular installer
2013-04-22 00:49:30 +02:00
All other dependencies are either stored in the repository or are included as submodules.
1. Clone Aegisub's repository: `git clone`
2021-03-27 19:55:52 +01:00
2. From the Visual Studio "x64 Native Tools Command Prompt", generate the build directory: `meson build -Ddefault_library=static` (if building for release, add `--buildtype=release`)
3. Build with `cd build` and `ninja`
2013-04-22 00:49:30 +02:00
You should now have a binary: `aegisub.exe`.
2014-09-21 17:18:05 +02:00
2014-09-21 17:18:05 +02:00
You can generate the installer with `ninja win-installer` after a successful build. This assumes a working internet connection and installation of the optional dependencies.
2014-09-21 17:18:05 +02:00
You can generate the portable zip with `ninja win-portable` after a successful build.
2014-09-21 17:18:05 +02:00
### OS X
A vaguely recent version of Xcode and the corresponding command-line tools are required.
2021-01-10 08:56:53 +01:00
For personal usage, you can use pip and homebrew to install almost all of Aegisub's dependencies:
2014-09-21 17:18:05 +02:00
pip3 install meson
brew install cmake ninja pkg-config libass boost zlib ffms2 fftw hunspell
export LDFLAGS="-L/usr/local/opt/icu4c/lib"
export CPPFLAGS="-I/usr/local/opt/icu4c/include"
export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig"
2021-01-10 08:56:53 +01:00
Once the dependencies are installed, build Aegisub with `meson build && meson compile -C build`.
2013-04-22 00:49:30 +02:00
#### Build dmg
meson build_static -Ddefault_library=static -Dbuildtype=debugoptimized -Dbuild_osx_bundle=true -Dlocal_boost=true
meson compile -C build_static
meson test -C build_static --verbose
meson compile osx-bundle -C build_static
meson compile osx-build-dmg -C build_static
## Updating Moonscript
From within the Moonscript repository, run `bin/moon bin/splat.moon -l moonscript moonscript/ > bin/moonscript.lua`.
Open the newly created `bin/moonscript.lua`, and within it make the following changes:
1. Prepend the final line of the file, `package.preload["moonscript"]()`, with a `return`, producing `return package.preload["moonscript"]()`.
2. Within the function at `package.preload['moonscript.base']`, remove references to `moon_loader`, `insert_loader`, and `remove_loader`. This means removing their declarations, definitions, and entries in the returned table.
3. Within the function at `package.preload['moonscript']`, remove the line `_with_0.insert_loader()`.
The file is now ready for use, to be placed in `automation/include` within the Aegisub repo.
2013-04-22 00:49:30 +02:00
## License
2014-09-21 17:18:05 +02:00
All files in this repository are licensed under various GPL-compatible BSD-style licenses; see LICENCE and the individual source files for more information.
The official Windows and OS X builds are GPLv2 due to including fftw3.