Skip to content

Conversation

@Trouffman
Copy link
Contributor

@Trouffman Trouffman commented Jun 19, 2025

Description

This (re)-add the support for Windows Portable installs.

  • Build windows-portable package with expected folder structure
  • Add the artifact to the release

Motivation and Context

By changing the default install path to the ProgramData path (Windows) this needed a specific folder structure, different than previously.
Portable install was no longer an easy "drop-in" unzip/export and confused users.

This is widly based on the work by @CodeYan01 from #143 with slight modification (lowercase files names everywhere)

How Has This Been Tested?

We released DistroAV 6.1.1 with it (prior to the change to enforce lowercase) : https://github.com/DistroAV/DistroAV/releases/tag/6.1.1

Types of changes

CI & Release process

Checklist:

  • My code has been run through clang-format.
  • I have read the contributing document.
  • My code is not on the master branch.
  • The code has been tested.
  • All commit messages are properly formatted and commits squashed where appropriate.
  • I have included updates to all appropriate documentation.

@Trouffman Trouffman marked this pull request as draft June 19, 2025 01:23
@Trouffman
Copy link
Contributor Author

This might stay in draft mode until checklist is completed.

Please advise is this is the direction this template is going.

@Trouffman
Copy link
Contributor Author

Documentation / Wiki to update (did not submit until this PR is approved)

Windows Portable

The overall file structure for plugins in Windows Portable mode looks as follows:

obs-studio portable folder
│ ├─ obs-plugins
│ │ |─ bin
│ │ |─ 64nit
│ │ ├─ my-plugin-for-obs.dll
│ │ ╰─ my-plugin-for-obs.pdb
│ ╰ data
│ ├─ obs-plugins
│ ├─ my-plugin-for-obs
│ │ ├─ locale
│ │ │ └─ en-US.ini
│ ╰─ my-plugin-example-file.png

Be mindful of the 64bit directory inside bin that needs to be used for historical reasons.

Caution

This is different to the structure used by plugins installed on a normal OBS Studio. Portable plugins files must be use exclusively on portable OBS Studio and will NOT work on a normal installation.

@PatTheMav
Copy link
Member

For the future please refrain from opening pull requests as "discussion forums" for ideas or suggestions. I understand that GitHub has introduced "Draft PRs" just for that purpose, but OBS Studio uses Fider and the RFCs repository for that purpose.

I'm also closing this because portable mode will be fixed on OBS Studio to support the "correct" plugin format used by the template even in portable mode, as that's the correct fix.

@PatTheMav PatTheMav closed this Jul 13, 2025
@CodeYan01
Copy link

Does OBS portable mode now support the correct plugin format?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants