Support

Follow TweetDuck on Twitter  |  Support via PayPal  |  Support via Patreon

Build Instructions

Setup

The program can be built using Visual Studio 2017 or newer. Before opening the solution, please make sure you have the following workloads and components installed (optional components that are not listed can be deselected to save space):

• .NET desktop development
  • .NET Framework 4 – 4.6 development tools
  • F# desktop language support
• Desktop development with C++
  • (VS 2017) VC++ 2017 version 15.9 v14.16 latest v141 tools
  • (VS 2019) MSVC v142 - VS 2019 C++ x64/x86 build tools (v14.20)

After opening the solution, right-click the solution and select Restore NuGet Packages, or manually run this command in the Package Manager Console:

PM> Install-Package CefSharp.WinForms -Version 67.0.0
PM> Install-Package WindowsAPICodePack-Shell -Version 1.1.1

Debug

The Debug configuration uses a separate data folder by default (%LOCALAPPDATA%\TweetDuckDebug) to avoid affecting an existing installation of TweetDuck. You can modify this by opening TweetDuck Properties in Visual Studio, clicking the Debug tab, and changing the Command line arguments field.

While debugging, opening the main menu and clicking Reload browser automatically rebuilds all resources in Resources/Scripts and Resources/Plugins. This allows editing HTML/CSS/JS files without restarting the program, but it will cause a short delay between browser reloads. An F# compiler must be present when building the project to enable this feature: C:\Program Files (x86)\Microsoft SDKs\F#\10.1\Framework\v4.0\fsc.exe

Release

Open Batch Build, tick all Release configurations with x86 platform, and click Rebuild. Check the status bar to make sure it says Rebuild All succeeded; if not, see the Troubleshooting section.

After the build succeeds, the bin/x86/Release folder will contain files intended for distribution (no debug symbols or other unnecessary files). You may package these files yourself, or see the Installers section for automated installer generation.

The Release configuration omits debug symbols and other unnecessary files, and it will automatically generate the update installer if the environment is setup correctly. You can modify this behavior by opening TweetDuck.csproj, and editing the <Target Name="AfterBuild" Condition="$(ConfigurationName) == Release"> section.

If you decide to publicly release a custom version, please make it clear that it is not an official release of TweetDuck. There are many references to the official website and this repository, especially in the update system, so search for chylex.com and github.com in all files and replace them appropriately.

Troubleshooting

Error: The command (...) exited with code 1

• This indicates a failed post-build event, open the Output tab for logs
• Determine if there was an IO error from the rmdir commands, the custom MSBuild targets near the end of the .csproj file, or in the PostBuild.fsx script (Encountered an error while running PostBuild)
• Some files are checked for invalid characters:
  • Resources/Plugins/emoji-keyboard/emoji-ordering.txt line endings must be LF (line feed); any CR (carriage return) in the file will cause a failed build, and you will need to ensure correct line endings in your text editor

Error: The "EmbedAllSources" parameter is not supported by the "Csc" task

1. Open C:\Program Files (x86)\Visual Studio\2017\<edition>\MSBuild\15.0\Bin\Roslyn\Microsoft.CSharp.Core.targets in a text editor
2. Remove line that says EmbedAllSources="$(EmbedAllSources)"
3. Hope the next Visual Studio update fixes it...

Installers

TweetDuck uses Inno Setup for installers and updates. First, download and install InnoSetup QuickStart Pack (non-unicode; editor and encryption support not required) and the Inno Download Plugin.

Next, add the Inno Setup installation folder (usually C:\Program Files (x86)\Inno Setup 5) into your PATH environment variable. You may need to restart File Explorer for the change to take place.

Now you can generate installers by running bld/GEN INSTALLERS.bat. Note that this will only package the files, you still need to run the release build in Visual Studio!

After the window closes, three installers will be generated inside the bld/Output folder:

• TweetDuck.exe
  • This is the main installer that creates entries in the Start Menu & Programs and Features, and an optional desktop icon
• TweetDuck.Update.exe
  • This is a lightweight update installer that only contains the most important files that usually change across releases
  • It will automatically download and apply the full installer if the user's current version of CEF does not match
• TweetDuck.Portable.exe
  • This is a portable installer that does not need administrator privileges
  • It automatically creates a makeportable file in the program folder, which forces TweetDuck to run in portable mode

The installers are built for GitHub Releases, where the main and portable installers can download and install Visual C++ if it's missing, and the update installer will download and apply the full installer when needed. If you plan to distribute your own installers via GitHub, you can change the variables in the installer files (.iss) and in the update system to point to your repository, and use the power of the existing update system.

Notes

When opening Batch Build, you will also see x64 and AnyCPU configurations. These are visible due to what I consider a Visual Studio bug, and will not work without significant changes to the project. Manually running the Resources/PostCefUpdate.ps1 PowerShell script modifies the downloaded CefSharp packages, and removes the invalid configurations.

There is a small chance running GEN INSTALLERS.bat immediately shows a resource error. If that happens, close the console window (which terminates all Inno Setup processes and leaves corrupted installers in the output folder), and run it again.

Running GEN INSTALLERS.bat uses about 400 MB of RAM due to high compression. You can lower this to about 140 MB by opening gen_full.iss and gen_port.iss, and changing LZMADictionarySize=15360 to LZMADictionarySize=4096.