Create stories easily.
StoryTailor is developed with Dart and Flutter, with Flame inside.
It is highly not recommended to use StoryTailor for production uses right now, as breaking changes might occur even every commit.
This project has two parts. The editor is licensed in GNU GPLv3, but the runtime library is licensed under GNU LGPLv3
Whether the license of the runtime library should be changed to MIT license for more freedom is still in consideration.
Please see contributing.md
For the most basic setup, You'll only need Flutter. To install, Follow the Flutter documentation.
To build, Run flutter build [target]
. For example, flutter build windows
, flutter build linux
,
and flutter build apk
.
Note
The Flutter build command has to be run once before going through any of the packaging instructions below.
To create an AppImage package, There are two prerequisites, GNU make, and appimagetool
.
You should be able to install make
from your Linux package manager. And for appimagetool
,
You can download the AppImage to compile your AppImage on the appimagetool
GitHub
Releases
There are two Makefile targets:
appimage
: Normal AppImage packaging for x86_64 architectureappimage-signed
: Signed AppImage packaging for x86_64 architecture
But before you run either of the targets, you might need to specify the APPIMAGE_TOOL
variable
if the appimagetool
isn't in your PATH variable. You can set the variable through the make
command. If for example your appimagetool
is inside your Downloads folder, you can run
make appimage-signed APPIMAGE_TOOL=~/Downloads/appimagetool-x86_64.AppImage
to make a signed
package.
The appimage-signed
target will use your default secret key to sign the AppImage. If you wish to
select a different key, You can run make appimage-resources
to make the AppDir
folder, then run
something similar to this pattern:
ARCH=x86_64 [path to appimagetool] -g -s --sign-key [Your GPG key ID] AppDir
To build for arm64 (aarch64), You will need to do a similar thing to the above paragraph, which is to
run make appimage-resources
then run ARCH=aarch64 [path to appimagetool] -g AppDir
(Add parameters
as needed, such as -s
to sign)
StoryTailor uses Inno Setup to create installer applications for Windows.
Inno Setup can be downloaded on its website or installed interactively
through WinGet by running winget install --id JRSoftware.InnoSetup -e -s winget -i
.
After Inno Setup has been installed, You can open the Inno Setup Compiler and open the windows_setup.iss
file located within the root of this project, then you can press Run (F9) to run the setup.