search

Structed / godot-playfab

A Godot Engine addon/SDK to interface with Azure PlayFab - playfab.com
MIT License
124 stars 14 forks source link

Release package should only contain necessary data for users #127

Open Structed opened 10 months ago

Structed commented 10 months ago

Currently, all release packages contain pretty much all data from the repository. However, that is not necessary for the majority of users. If oner wants to get the full contents, they can clone the repository.

Steps to Reproduce

...to just install necessary files:

Scenario A

  1. Open a new project
  2. Open Asset Lib Tab
  3. Search for godot-playfab
  4. Click Download button
  5. This opens the "Install" modal

Scenario B

  1. On the GitHub Repo page, select the current release
  2. click the Source code (zip) or Source code (tar.gz) link and download the file
  3. Wait for the download to finish
  4. Open the zip/tar.gz file

Expected Behaviour

Scenario A

Only necessary addon/godot-playfab folder and an Example folder (optional) should be shown & selectable

Scenario B

Only necessary addon/godot-playfab folder and an Example folder (optional) should be in the archive

Actual Behaviour

Scenario A

All files are selected and shown. One has to deselect all files except the addons/godot-playfab folder.

Scenario B

All files are included in the archive file. You need to know which files to extract

Structed commented 3 months ago

The examples should be moved to a separate repository.

This would also allow additional examples that would need dependencies on other add-ons. E.g. an example for the Steam Login using godot-steam.

Questions

  1. Should the example project take a dependency on godot-playfab via a submodule, or just install the published project from the repo or as a submodule?
  2. Should examples that take a dependency on other add-ons take those dependencies as submodules?
  3. Should these other examples be separate repositories?