FModel/README.md
Rob Trame 7e66c44f90
chore: update identity, branding, and CI for FModel Linux fork (#69)
* chore: update identity, branding, and CI for FModel Linux fork

- README.md: complete rewrite with fork identity disclaimer, upstream
  attribution, updated links, and removal of sponsorship section
- NOTICE: add upstream FModel GPL-3 attribution; update library list
  (add Avalonia/AvaloniaEdit/Svg.Skia/Twizzle.ImGui-Bundle.NET, remove
  AdonisUI/AutoUpdater.NET/CSCore/ImGui.NET/Ookii.Dialogs.Wpf)
- Constants.cs: update ISSUE_LINK and GH_REPO to r6e/FModel-Linux;
  clear DISCORD_LINK pending app registration
- FModel.csproj: add opt-in USE_FMODEL_API build flag
  (-p:UseFModelApi=true) for upstream api.fmodel.app integration
- FModelApiEndpoint.cs: gate all api.fmodel.app calls behind
  #if USE_FMODEL_API; rewrite CheckForUpdatesAsync to use GitHub
  Releases API and return GitHubRelease? for caller-side notification
- GitHubApiEndpoint.cs: add GetLatestReleaseAsync() for /releases/latest
- GitHubResponse.cs: add TagName/HtmlUrl/Body to GitHubRelease; replace
  AutoUpdater.DownloadUpdate with Process.Start(UseShellExecute=true)
- MainWindow.xaml.cs: surface update availability via FLogger [WRN] entry
  at startup when a newer GitHub release is found
- DiscordService.cs: disable RPC (empty APP_ID, early-return guard)
  pending Discord application registration for the fork
- About.xaml: version label reads 'FModel Linux {0}'; dual credit lines
  for Asval (original) and Rob Trame (Linux port)
- AboutViewModel.cs: update description, contributors, and references
  list to reflect current Avalonia-based dependency set
- .github/workflows: target ubuntu-latest, linux-x64, net8.0; remove
  fmodel.app deploy steps; rename artifact to FModel-Linux.zip
- .github/ISSUE_TEMPLATE: update assignee and remove Discord link
- .github/FUNDING.yml: note donation link points to upstream project

* Fix whitespace issues

* chore: address PR review feedback

- NOTICE: remove orphaned MS-PL and BSD 3-Clause license texts; the
  index already lists only MIT and Apache 2.0, and no current dependency
  uses either of those licenses
- GitHubResponse.cs: guard against null Asset/BrowserDownloadUrl in
  Download(); log a warning via Serilog instead of NullReferenceException
  or re-throwing InvalidOperationException
- MainWindow.xaml.cs: run update check in a background Task.Run to
  avoid blocking startup; post FLogger notification back on
  Dispatcher.UIThread; swallow exceptions so a failed check never
  impacts startup
- FModelApiEndpoint.cs: log a warning when the current application
  version string cannot be parsed, matching the existing behaviour for
  an unparseable latest-release tag
- .github/workflows: add `permissions: contents: write` to both
  main.yml and qa.yml (GitHub Advanced Security finding)

* chore: address second round of PR review feedback

- NOTICE: add missing direct NuGet dependencies —
  EpicManifestParser.ZlibngDotNetDecompressor, Serilog.Sinks.Console,
  Serilog.Sinks.File, and SkiaSharp.HarfBuzz — each with their
  respective copyright notice and license (MIT / Apache 2.0)
- FModelApiEndpoint.cs: remove now-unused _applicationView property
  (CheckForUpdatesAsync was refactored to use GitHubApi directly;
  _applicationView is dead code outside of #if USE_FMODEL_API blocks)
- DiscordService.cs: fix DiscordRpcClient being constructed at
  field-init time with an empty APP_ID string; make _client nullable
  and only instantiate when APP_ID is non-empty; update all call sites
  to use null-safe pattern matching (_client is not { IsInitialized:
  true }) so callers are safe without runtime client construction

* chore: address third round of PR review feedback

- MenuCommand.cs: guard Help_Discord action against empty DISCORD_LINK;
  Process.Start with an empty FileName throws at runtime, so the action
  is now a no-op when no Discord server URL is configured
- qa.yml: zip the full publish output directory (./FModel/bin/Publish/)
  rather than just the single executable; --no-self-contained publishes
  companion files (*.deps.json, *.runtimeconfig.json) that are required
  at runtime alongside the PublishSingleFile output
- main.yml: same fix — zip ./FModel/bin/Publish/ so the release artifact
  includes all required publish outputs, not just the executable

* Update FModel/ViewModels/ApiEndpoints/FModelApiEndpoint.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-12 11:13:00 -06:00

2.1 KiB

FModel Linux — Unreal Engine Archives Explorer for Linux

CI Status Latest


This is an unofficial Linux port of FModel, originally created by Asval (4sval) and contributors. It is not affiliated with or endorsed by the upstream project or its maintainers. Please do not report Linux-port-specific issues upstream.

Description

FModel Linux is a Linux port of FModel — an archive explorer for Unreal Engine games. It uses CUE4Parse as its core parsing library, providing robust support for the latest UE4 and UE5 archive formats, along with a comprehensive set of tools for previewing and converting game packages.

This fork replaces the Windows-only WPF UI stack with Avalonia UI and removes other Windows-specific dependencies to enable native Linux support. It is maintained by r6e.

Installation

Installation instructions for the Linux port are available in the project wiki (work in progress).

For the upstream Windows release, refer to the official FModel installation guide.

Supporting the Upstream Project

This fork does not accept donations. If you find FModel valuable, please consider supporting the original FModel project and its contributors.

License

FModel Linux is a derivative work licensed under GPL-3. The original FModel project is copyright © Asval and FModel contributors. Licenses of third-party libraries used are listed in NOTICE.