Aegisub/README.md

75 lines
3.1 KiB
Markdown
Raw Normal View History

2013-04-22 00:49:30 +02:00
# Aegisub
For binaries and general information [see the homepage](http://www.aegisub.org).
2021-01-16 10:53:09 +01:00
The bug tracker can be found at https://github.com/Aegisub/Aegisub/issues.
2013-04-22 00:49:30 +02:00
Support is available on [Discord](https://discord.com/invite/AZaVyPr) or [IRC](irc://irc.rizon.net/aegisub).
2013-04-22 00:49:30 +02:00
## Building Aegisub
### Windows
Prerequisites:
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.
Building:
1. Clone Aegisub's repository: `git clone https://github.com/TypesettingTools/Aegisub.git`
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
Installer:
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
2021-01-10 08:56:53 +01:00
brew install libass nasm ninja boost zlib icu4c pkg-config ffms2 fftw hunspell gettext cmake
brew link --force gettext
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
pip install meson
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
## 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.