aleleba/effectcraft
1
0
Fork 0
mirror of https://github.com/storytold/effectcraft.git synced 2026-10-30 04:57:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: add user docs for EffectCraft

Browse Source 
Adds docs/user/ (published at getartcraft.com/docs/effectcraft), the docs-check
and docs-publish workflows (copied from craft-launcher), and a "User docs" rule
in AGENTS.md. Verified against 0.8.0.

Source notes per page:
- index: README, crates/engine/src/menus.rs, website crafting-apps.ts entry,
  docs/gaps.md (.aep).
- getting-started/install: README Downloads, gh release v0.8.0 assets,
  packaging/windows/effectcraft.wxs (per-machine, Start Menu, desktop shortcut
  box), package.ps1 (portable zip contents), launcher crates/core catalog.rs
  (EffectCraft listed), launcher docs install guide.
- guides/make-a-composition: menus.rs (Composition, Layer, Help), comp.rs
  shortcut, panels/comp_settings.rs (labels, presets, tabs), panels/home.rs,
  engine/src/learn.rs (Animate a title tutorial).
- guides/animate-with-keyframes: learn.rs, panels/timeline.rs (stopwatch, Add
  or remove keyframe), commands/prop.rs (Easy Ease F9), menus.rs (Animation).
- guides/add-an-effect: menus.rs (Effect, Window), panels/effects_presets.rs,
  commands/effect.rs, effects/src/misc.rs (Gaussian Blur parameters).
- guides/render-a-video: panels/render_queue.rs (labels), project
  render_queue.rs (format labels, default H.264, template, supports_alpha),
  commands/render_queue.rs (Cmd+M), README (Lottie).
- guides/import-footage: docs/footage.md, menus.rs, engine/src/prefs.rs
  (Sequence Footage), README (Wayland drop).
- troubleshooting/gpu-not-used: issues #596, #613; prefs.rs (Window Graphics),
  commands/app_more.rs (System Compatibility Report text), ui-egui menus.rs
  (GPU Information dialog text, checked at v0.8.0).
- troubleshooting/footage-missing: docs/footage.md (relink), commands/
  file_more.rs (Find Missing Footage), issue #652 and PR #676.
- faq/after-effects-projects: README "Where it stands", docs/gaps.md.
- faq/price-and-platforms: README (license, platforms, status), LICENSE files.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Fabio Lussi
2026-10-12 04:04:57 +02:00
co-authored by Claude Opus 5.5
parent 67434e9038
commit a6ab6a8f8c
20 changed files with 564 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/getting-started/index.md
+8
View File
@@ -0,0 +1,8 @@
---
title: Getting started
description: Install EffectCraft and make your first composition.
order: 10
---
- [Install EffectCraft](install.md)
- [Make your first composition](../guides/make-a-composition.md)
docs/user/getting-started/install.md
+54
View File
@@ -0,0 +1,54 @@
---
title: Install EffectCraft
description: Download EffectCraft for Windows 11, macOS or Linux, install it, or install it through ArtCraft Launcher.
order: 10
verified: 0.8.0
---
The easiest way is the [EffectCraft page on getartcraft.com](https://getartcraft.com/apps/effectcraft). For a specific file, use the [latest release](https://github.com/storytold/effectcraft/releases/latest) on GitHub. In the file names, `<version>` stands for the version number, for example `0.8.0`.
## Windows 11
1. Open the [latest release](https://github.com/storytold/effectcraft/releases/latest).
2. Download `effectcraft-<version>-windows-x64.msi`. It fits most PCs (Intel and AMD, 64-bit).
3. Run the file and follow the installer. It asks where to install EffectCraft and offers a **Create a desktop shortcut** box.
4. Start **EffectCraft** from the Start menu.
The release also has an `arm64` installer for Snapdragon and other ARM PCs, and an `x86` installer for 32-bit Windows. The installers are code-signed and install for all users. Later versions install into the same folder.
To run it without installing, download `effectcraft-<version>-windows-x64-portable.zip` instead. It contains `effectcraft.exe` and the command-line tool `effectcraft-cli.exe`. The `arm64` and `x86` builds have portable zips too.
## macOS
1. Download `effectcraft-<version>-macos-universal.dmg`. It works on Apple silicon and Intel Macs and is signed and notarized.
2. Open it and drag EffectCraft to Applications.
## Linux
Pick one file from the release. Replace `x86_64` with `aarch64` on ARM.
| File | How to use it |
|-----------------------------------------------|------------------------------------------|
| `effectcraft-<version>-linux-x86_64.AppImage` | Run `chmod +x` on the file, then run it. |
| `effectcraft-<version>-linux-x86_64.deb` | For Debian and Ubuntu. |
| `effectcraft-<version>-linux-x86_64.rpm` | For Fedora, RHEL and openSUSE. |
| `effectcraft-<version>-linux-x86_64.flatpak` | `flatpak install --user <file>` |
| `effectcraft-<version>-linux-x86_64.tar.gz` | Unpack it anywhere. |
There is also a RISC-V 64-bit `.tar.gz` (it needs glibc 2.39 or newer) and a FreeBSD x86_64 `.tar.gz`.
## In the browser
`effectcraft-web-<version>.zip` is the web build. It is a static site that runs in a modern browser and needs to be hosted on a web server. Projects, media and settings stay in the browser and on your computer.
## Install through ArtCraft Launcher
ArtCraft Launcher lists EffectCraft. Click **Install** on its card. See [Install and update Craft apps](https://getartcraft.com/docs/craft-launcher/guides/install-and-update-apps).
## Check the download
`SHA256SUMS.txt` on the release page lists a checksum for every file.
## Next
Open EffectCraft and make something: [Make your first composition](../guides/make-a-composition.md). If you only want to look around, choose **Open Demo Project** on the Home screen.