Repository navigation
Releases: forumcopilot/xenforoapp
Release list
Add-on 1.12.0 — the forum's name and icon, thread tags, member titles and the "Last edited" line
Forum Copilot XenForo add-on 1.12.0. Upload ForumCopilot_1_12_0.zip in Admin CP → Add-ons → Install/upgrade from archive. Any 1.6.0 or later install can upgrade straight to 1.12.0. Requires XenForo 2.2.0 or newer.
This release adds what the new app version shows about forums, threads and posts. Apps built for earlier add-ons keep working: everything new comes as new reply fields.
Added
- The forum's name, address and icon in
getConfig(boardTitle,boardUrl,boardIcon,siteId), so the app can add a forum from its address alone. - Threads: their tags, as the thread page lists them, and whether the member's watch also sends emails (
tags,emailSubscribe), so the app's Watch sheet needs no extra call. - Posts and direct messages: the title under the member's name, as the website shows it (custom title, group title or title ladder;
authorTitle). Posts also carry XenForo's "Last edited" line (lastEditDate,lastEditByModerator; like the website, it never names the editor).
Fixed
- Media embeds in posts as HTML link to the media's own page for every media site XenForo ships. 1.11.0 sent no link for Vimeo, Facebook, Flickr, Reddit and Bluesky and a wrong one for GIPHY, TikTok and links with a start time; posts on X now link to x.com.
Notes for site owners
- No new options, permissions, upgrade steps or tables.
- Verified by building this archive with XenForo's packer and upgrading 1.11.0 to it on XenForo 2.2.19 and 2.3.7 test forums: the file health check passes, and the live API suites pass on both (basic 49/49, interface 100/100).
Full details: CHANGELOG.md.
Add-on 1.11.0 — every API method reviewed: XenForo's checks, ignore members, posts as HTML
Forum Copilot XenForo add-on 1.11.0. Upload ForumCopilot_1_11_0.zip in Admin CP → Add-ons → Install/upgrade from archive. Any 1.6.0 or later install can upgrade straight to 1.11.0. Requires XenForo 2.2.0 or newer.
This release fixes permission and privacy problems in earlier versions of the add-on: all forums should upgrade promptly.
Every API method was reviewed against XenForo's own pages and services, and now follows the same permission checks and follow-up steps as the website. Apps built for earlier add-ons keep working: new behaviour comes as new reply fields and optional parameters, plus three new methods for ignoring members.
Added
- Ignore a member from the app:
ignoreUser,unignoreUser,getIgnoredUsers(App Store guideline 1.2). - Posts and direct messages rendered as HTML by XenForo, on request (
contentHtml: true): custom BBCodes, media sites, smilies and censored words as on the website. - Thread lists sort and filter like XenForo's forum page; new threads with tags, custom thread fields, a poll and a thread type; each forum says what it requires and whether the member watches it.
- Question and suggestion threads: type, solution and votes. Signatures, by the member's "show signatures" choice.
- Alerts can be listed without marking them read, and marked read or unread one by one or all at once.
getConfigsends the forum's notices, help and policy pages, and whether updated terms must be accepted.- Machine-readable error codes on every error (
errorCode), and form errors by field.
Fixed
- Each method now applies XenForo's own permission and privacy checks, for example who may reply in a direct message, edit a profile, see a member's online status or profile fields, and attach files.
- Search runs on XenForo's search (its index, limits and permissions) instead of scanning posts.
- Members can report posts; "Subscribed forums" works; alerts load past the first page; locked threads show as locked.
- Replies, new threads, edits and direct messages run XenForo's spam and flood checks and delete their drafts; editing a post or message that has attachments works again.
- Thread pages and lists load in a few database queries instead of several per row, and page sizes are capped.
- Errors are readable in the app, and unexpected errors are written to the server error log with a reference instead of being shown.
Notes for site owners
- New option App two-step trust (days) (default 365) and a daily cron entry that removes stale app device registrations. Two class extensions (User, UserProfile) remove a member's push registrations when their password changes or they are banned or deleted.
- Verified by upgrading 1.10.0 to this archive on XenForo 2.2.19 and 2.3.13 test forums (file health check passes on both) and with an API test suite of about 830 checks on each.
Full list: CHANGELOG.md.
v1.0.1 — add-on 1.10.0: website sign-up comes back to the app
A patch release: the same app as 1.0 with one fix, and the newer add-on. Ships with bundled ForumCopilot addon v1.10.0 (attached; also on forumcopilot.com). The app works with add-on 1.9.0 too, without the sign-up improvements below.
Add-on 1.10.0
- Website sign-up comes back to the app. A member who signs up on the forum's website from the app, including with Google or another connected account, now comes back to the app signed in.
- "Not you? Sign out" on the page that confirms an app sign-in.
- Two-step members stay signed in. After the app's session lapses, members with two-step verification are signed back in instead of being signed out.
- In-app sign-up follows the forum's spam protection. It is refused whenever the forum shows guests a captcha (the app sends them to the website instead), for discouraged IP addresses, and until XenForo's registration timer has run.
- Waiting for confirmation or approval. Members waiting for email confirmation or approval can sign in on forums that guests cannot view, and the add-on adds a
resendEmailConfirmationmethod (this app does not use it yet).
App
- A topic row without a preview of its first post no longer fails to draw. XenForo with this add-on always sends a preview, so this mattered only for other sources and older add-ons. From the official app.
The full list is in CHANGELOG.md.
Updating a fork
- Nothing to change in your app: no new config fields or build steps.
- Install add-on 1.10.0 on your forum (Admin CP → Add-ons → Install/upgrade from archive). No database changes.
v1.0.0 — the official app's 1.0, with add-on 1.9.0
The 1.0 release: the same app as the official Forum Copilot app 1.0, for one XenForo forum. Ships with bundled ForumCopilot addon v1.9.0 (attached; also on forumcopilot.com). The features that need it stay off with an older add-on.
Highlights since 0.10.2
- Your forum's look. Home opens with the forum's own header (logo, name, a line about the forum, stats, its banner, a search field), and the app takes the forum's colours and logo. A forum's page has a header too, with its description, counts and compact sub-forum rows.
- Reading and replying. Threads have a quick reply bar and a floating navigator; Reply on a post quotes it. Conversations have a reply bar and bring in new messages while open. Drafts are kept on the forum, shared with the web editor.
- Reactions. A tap likes, a long press picks a reaction; one footer for posts and direct messages shows the emoji used and the count.
- Sign-in. Two-step verification with "Trust this device", passkeys on the phone or from another phone by QR code, and sign-in on the forum's website for members who use Google, Facebook or another way the website offers.
- Account and notifications. Delete account in Settings (App Store guideline 5.1.1(v)); Android notifications in four channels.
- Material 3 and polish. Material 3 defaults, labelled bottom tabs, about 330 more strings translated in all 11 languages, and the fixes from reviewing every screen on a Pixel 4a and an iPhone 17.
The full list is in CHANGELOG.md.
Updating a fork
- Install add-on 1.9.0 on your forum (Admin CP → Add-ons → Install/upgrade from archive).
- For sign-in on the website, set
browserLoginSchemeinlib/config/app_forum_config.dart, put the same scheme inAndroidManifest.xml, and add it to the add-on option App sign-in schemes (README, Configure your forum). - For passkeys on iOS, put your forum's host in both
ios/Runner/Runner.entitlementsandios/Runner/Info.plist(README, step 5 of the checklist).
Versioning from here
From 1.0, a minor release keeps a fork's config and build steps working, and anything a fork must change is a major release (RELEASING.md).
Add-on 1.9.0 — sign in through the website, account deletion, shared drafts
XenForo add-on ForumCopilot 1.9.0, for Forum Copilot app 1.0. Install or upgrade via Admin CP → Add-ons → Install/upgrade from archive. Requires XenForo 2.2.0+.
Added
- Sign in through the forum's website. Members who sign in on the website with Google, Facebook, a passkey or two-step can sign the app in the same way: a public
forumcopilot-app-loginpage hands the app a one-time code. The app's URL scheme must be listed in the new option App sign-in schemes (defaultforumcopilot, the official app's). - Delete account in the app (App Store guideline 5.1.1(v)). On by default; turn it off with the new option Members can delete their account in the app.
- Drafts shared with the web editor. Replies and direct-message replies written in the app are kept in XenForo's own drafts, so the website's editor and the app share them.
- Notification channels. Each push names its kind (messages, replies, reactions, other), so the app can file it in its own Android channel.
- The forum's colours and logo.
getConfigsends the default style's colours and logo, so the app can use them.
Fixed
- The direct-message list returned the wrong page from the second load onwards.
- Direct messages posted in the same second now get their own numbers.
- Changing the password from the app keeps the app signed in.
After upgrading
No database changes. Two new options under Options → ForumCopilot Options. The new features appear in Forum Copilot app 1.0 and later; earlier app versions ignore them. Any 1.6.0 or later install can upgrade straight to 1.9.0.
Verification
The release ZIP (195 files) was installed as an upgrade from 1.8.12 on XenForo 2.2.19 and 2.3.7 test forums. Every add-on file matches hashes.json on both, forumcopilot.php in the web root matches the archive, and getConfig reports 1.9.0 with the new fields. Live API suites on both: basic 49/49, interface 100/100.
Source: https://github.com/forumcopilot/xenforoapp/tree/addon-v1.9.0/plugins/FC_XenForo2
Add-on 1.10.0 — website sign-up comes back to the app, safer in-app sign-up
XenForo add-on ForumCopilot 1.10.0. Install or upgrade via Admin CP → Add-ons → Install/upgrade from archive. Requires XenForo 2.2.0+.
Added
- Sign up on the website and come back signed in. When a member creates an account on the forum's website from the app (the register form, or Google or Facebook), XenForo's "Thanks for registering" page now shows Continue in the app, which signs the app in. This also works when a member starts from the app's sign-in and chooses Register.
- Not you? Sign out on the website's "Sign the app in as {name}?" page, for signing the app in with another account.
- Resend the confirmation email from the app (
resendEmailConfirmation), at most once every ten minutes. - New members waiting for email confirmation or for approval can sign the app in on forums that guests cannot view. Until their account is ready, the app is told why the forum stays closed to them.
Fixed
- Members with two-step verification who signed the app in on the website were signed out of the app after a few hours idle. The app now gets the same "trusted device" cookie as when it signs in with its own form.
- The app's own sign-up form no longer skips the forum's spam protection. Forums that show guests a captcha now send in-app sign-ups to the website. XenForo's registration timer and "prevent discouraged IP addresses from registering" apply to the rest.
- The app's sign-up form asks only for the policies the forum has, so a forum with only terms and rules can be joined. Policy links are full addresses, which also work on forums installed in a folder.
- Sign-up errors say which field they are about, and the messages are XenForo's own, in the forum's language. The email choice also sets the activity summary email, as on the website. When the forum sets no minimum age, none is reported. Fields that members may not edit are no longer listed.
After upgrading
No database changes and no new options. Adds one template modification (register_complete) and a class extension on XenForo's register controller. On forums that show guests a captcha, the app's own sign-up form is no longer offered; the app opens the forum's register page instead. Any 1.6.0 or later install can upgrade straight to 1.10.0.
Verification
The release ZIP (197 files, identical to upload/ in the source) was installed as an upgrade from the published 1.9.0 on XenForo 2.2.19 and 2.3.7 test forums. Every add-on file matches hashes.json on both, forumcopilot.php in the web root matches the archive, and getConfig reports 1.10.0. Each change was exercised on both forums through the API and the web pages, including two-step website sign-in surviving a lapsed session, the sign-up hand-back, and the in-app sign-up checks. Live API suites on both: basic 49/49, interface 100/100.
Source: https://github.com/forumcopilot/xenforoapp/tree/addon-v1.10.0/plugins/FC_XenForo2
Add-on 1.8.12 — replies and threads held for approval are reported as moderated
XenForo add-on ForumCopilot 1.8.12. Recommended for forums that moderate new posts or threads. Install or upgrade via Admin CP → Add-ons → Install/upgrade from archive. Requires XenForo 2.2.0+.
Fixed
- Replies and threads waiting for moderator approval. When a member's reply or new thread was held for approval, the add-on told the app it had been published, because XenForo lets authors see their own held content. It now reports the post's and thread's real moderation state, so the app can tell the member their post is waiting for approval instead of treating it as live.
After upgrading
No database changes and no new options. The "waiting for approval" notice appears in Forum Copilot app 0.10.4 and later; earlier app versions ignore the flag and behave as before. Any 1.6.0 or later install can upgrade straight to 1.8.12.
Verification
The release ZIP (the same 191 files as 1.8.11) was installed as an upgrade from 1.8.11 on XenForo 2.2.19 and 2.3.7 test forums. XenForo's file health check passes for every add-on file on both, and forumcopilot.php in the web root matches the archive. On 2.2.19, as a member in a forum that moderates new content, a held reply and a held thread now report state: 1 (they reported state: 0 with 1.8.11), and a reply in an unmoderated forum still reports state: 0. Live API basic suite on 2.2.19: 49/49.
Source: https://github.com/forumcopilot/xenforoapp/tree/addon-v1.8.12/plugins/FC_XenForo2
Add-on 1.8.11 — who reacted to direct messages on XenForo 2.2, reaction counts
XenForo add-on ForumCopilot 1.8.11. Reaction fixes, recommended for every forum that uses reactions other than Like, and for every XenForo 2.2 forum. It also contains 1.8.10, which was not released separately. No app update is required. Install or upgrade via Admin CP → Add-ons → Install/upgrade from archive. Requires XenForo 2.2.0+.
Fixed
- Who reacted to a direct message, on XenForo 2.2. The list of who reacted to a direct message was always empty on 2.2, so the app could not show who reacted or with what. The add-on only recognised XenForo 2.3's name for the reaction system (1.8.4 fixed the same check for posts) and read an emoji setting that only exists on 2.3. Both now work on 2.2. Direct messages, posts and the reaction picker show the same emoji.
- Reaction counts. The count sent to the app was XenForo's reaction score, which adds up each reaction's score. XenForo's stock Wow, Sad and Angry reactions score 0, so a post or direct message whose only reaction was one of them reported 0 and looked unreacted in the app, and Like + Wow reported 1. The count is now the number of reactions, for posts, threads, search results and direct messages, including the responses to reacting and removing a reaction. Forums that only use Like see no difference.
Added
- For test forums: if
src/config.phpsets$config['forumCopilot']['apiUrl'], the add-on registers, validates its connection and opens sign-in to the Forum Copilot console against that API instead ofhttps://forumcopilot.com/api. Live forums never set it and behave exactly as before. (From 1.8.10.)
After upgrading
No database changes and no new options. Members do not need a new app version: the corrected counts and who-reacted lists show in the app versions they already have. Any 1.6.0 or later install can upgrade straight to 1.8.11.
Verification
The archive was installed with XenForo's own archive installer: on a XenForo 2.2.19 test forum as an upgrade from 1.8.9, on 2.3.7 as a rebuild. Every add-on file, the smart-banner assets and forumcopilot.php in the web root match the archive, and XenForo's file health check passes for the add-on. On a post, a lone Wow now counts 1 (0 before) and Like + Wow counts 2 (1 before); removing them gives 1, then 0. A Wow on a direct message counts 1 and is listed with its emoji on both versions; with 1.8.9 the 2.2 forum listed nobody. Live API suites: 49/49 and 100/100 on 2.2.19 and on 2.3.7.
Source: https://github.com/forumcopilot/xenforoapp/tree/addon-v1.8.11/plugins/FC_XenForo2
Add-on 1.8.9 — watched-thread reply alerts after reading in the app, one push per direct message
XenForo add-on ForumCopilot 1.8.9. Push fixes, recommended for every forum whose members use the app. It also contains 1.8.8, which was not released separately. No app release accompanies it. Install or upgrade via Admin CP → Add-ons → Install/upgrade from archive. Requires XenForo 2.2.0+.
Fixed
- Watched-thread reply alerts after reading in the app. When the app marked a thread read, the add-on looked up the member's read marker by the wrong key. Depending on the forum's data it either moved some other member's read date for some other thread, or failed silently, and it reported success either way. XenForo only alerts a member about a reply in a thread they watch once they have read up to the previous post, so members who read threads in the app stopped getting those alerts, and the pushes that come with them. Marking a thread read now goes through XenForo's own read marking, the same as opening the thread on the website, which also marks the forum read once none of its threads are unread.
- Opening a thread at the first unread post used the same lookup and could land on the wrong post. It now uses XenForo's read date for the thread and its forum, and a member with no read data starts at the opening post, like XenForo's own "unread" link.
- One push per direct message. On XenForo 2.3, a direct message started or answered from the app reached the recipient's phone three times: the message preview, plus "… sent a direct message … to you" twice. Each recipient of a direct message started or answered from the app also got two e-mails, on 2.2 as well. Now every new direct message or reply gives one push and one e-mail on 2.2 and 2.3, including messages sent through XenForo's REST API. The push follows XenForo's own rules: none to a member who turned off push for direct messages, is banned, or ignores the sender.
- On XenForo 2.3, being added to an existing direct message gives one push, sent through the same push settings as every other push. It used to go to the hosted push service even with hosted push turned off, and never reached forums using their own Firebase project.
- With your own Firebase project, two direct messages with identical text no longer collapse into one push.
- XenForo's own browser-push title for direct messages is no longer replaced with the board title.
After upgrading
No database changes and no new options. The upgrade registers one more code event listener, so pushes also cover direct messages sent through XenForo's REST API; there is nothing to configure. Members do not need a new app version. Any 1.6.0 or later install can upgrade straight to 1.8.9.
Verification
Upgraded XenForo 2.2.19 and 2.3.7 test forums 1.8.7 → 1.8.9. With 1.8.7, a member who marked a watched thread read in the app got no alert for the next reply, and marking a thread read could move another member's read date; with 1.8.9 the member's own read date is set, the next reply alerts them, and XenForo's rule of no alert while an earlier reply is still unread still holds. Direct messages created or answered from the app, the website, the REST API and the CLI tools give one push to the hosted service and one through Firebase (with both enabled) on both versions, and one e-mail per recipient. Live API suites on 2.2.19: 49/49 and 100/100. On 2.3.7, run as a regular member: 49/49, and the interface suite passes except its six moderator-only tests.
Source: https://github.com/forumcopilot/xenforoapp/tree/addon-v1.8.9/plugins/FC_XenForo2
Add-on 1.8.7 — app requests honour XenForo's board-wide access checks
XenForo add-on ForumCopilot 1.8.7. Security fix; every forum should upgrade. No app release accompanies it. Install or upgrade via Admin CP → Add-ons → Install/upgrade from archive. Requires XenForo 2.2.0+.
Fixed
- The app now honours XenForo's board-wide access checks. The add-on's endpoint ran each API method directly, so the checks XenForo's own pages make before anything else were skipped for app requests: banned IP, banned, rejected or disabled account, the View the board permission, closed board, required two-step verification and security lock. Forum and thread permissions still applied, but a member who lost View the board (for example when a paid user group expired) or was banned after signing in could keep reading and posting from the app in every forum their other user groups open at node level.
- The endpoint now runs the same checks before every method. The sign-in methods only refuse banned IP addresses, like XenForo's login page, and signing out always works. Refusals use XenForo's own wording (including the ban reason and your closed-board message), so members see the same explanation as on the website.
- Signing in from the app now refuses an account without View the board, with the message "Your account does not currently have access to this forum".
After upgrading
No database changes. The upgrade copies the new forumcopilot.php into your forum's web root, and the fix lives in that file. If your web root is not writable by PHP, the upgrade logs "ForumCopilot: failed to copy entry-point" in ACP → Logs → Server error log; copy src/addons/ForumCopilot/webroot_files/forumcopilot.php to the web root by hand in that case.
Verification
Upgraded 2.2.19 and 2.3.7 test forums 1.8.6 → 1.8.7. On both, a signed-in member whose View the board permission is removed is refused on the forum list, thread view and reply (the 1.8.6 endpoint accepted the same reply), can still sign out, and cannot sign in again; a banned member sees the ban reason; a closed board blocks everyone but admins; guests and normal members are unaffected. Live API suites on 2.2.19: 49/49 and 100/100. On 2.3.7, run as a regular member: 49/49, and the interface suite passes except its six moderator-only tests.
Source: https://github.com/forumcopilot/xenforoapp/tree/addon-v1.8.7/plugins/FC_XenForo2