Skip to content

TzurSoffer/FreecadDiscordPresence

Repository files navigation

FreeCAD Discord Rich Presence Addon

This addon integrates Discord Rich Presence with FreeCAD, enabling users to showcase their current FreeCAD activity (such as the active workbench and file being edited) directly in their Discord profile.

If you found this repository useful, please give it a ⭐!.

Showcase

showcase.mp4

Features

  • Workbench Tracking: Displays the current workbench in use.
  • File Monitoring: Shows the name of the file being edited (or "No file open" if no file is open).
  • Real-Time Updates: Automatically updates every second to reflect activity changes.
  • Seamless Integration: Starts and stops automatically when FreeCAD is running.

Installation

Method 1: Install via Addon Manager

  1. This addon is available in the FreeCAD Addon Manager.
  2. Open FreeCAD, navigate to Tools > Addon Manager, and search for DiscordPresence.
  3. Install the addon directly from the Addon Manager.

Manual Installation

1. Clone or download this repository to your local machine:

git clone https://github.com/TzurSoffer/FreecadDiscordPresence

2. Copy the DiscordPresence folder to the Mod folder of FreeCAD:

  • Linux: /usr/share/freecad/Mod/
  • Windows: C:\Program Files\FreeCAD\Mod\
  • macOS: /Applications/FreeCAD/Mod/

3. Restart FreeCAD to activate the addon.

Dependencies (automatically installed by addon manager)

The addon requires the following Python library:
- pypresence: A library for managing Discord Rich Presence.

Note: If you are on Linux and are using the Flatpak packaging of FreeCAD, run

flatpak override org.freecad.FreeCAD --user --filesystem=xdg-run/discord-ipc-0 --filesystem=xdg-run/app/com.discordapp.Discord

to grant FreeCAD the necessary permissions to communicate with Discord.

How it works

  • The addon connects to Discord via the rpc protocol which can be read about on the official discord page
  • The app app fetches data about the current file and workbench through the FreeCAD api, updating your Discord presence to reflect that information.

LICENSE

This app uses LGPL2.1, the full license file can be found in the License File

CREDITS

  • luzpaz for helping with README.md and publication to the FreeCAD addons.

  • chennes for helping with the publication of the package to the FreeCAD addons.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages