pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2025-04-05 11:20:55 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: reword sync config explanation

Browse source
This commit is contained in:
daimond113 2025-02-02 15:24:20 +01:00
parent 6ae16a7dac
commit 692ae1521d
No known key found for this signature in database
GPG key ID: 640DC95EC1190354
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/src/content/docs/guides/roblox.mdx
View file

@ -188,10 +188,13 @@ This will cause the `src` directory to be directly synced into Roblox.
In pesde, you should not have a `default.project.json` file in your package.
Instead, you are required to use the `build_files` field to specify a 1:1 match
between Roblox and the file system. pesde forbids `default.project.json` to be
part of a published package, and regenerates it when installing a pesde git
dependency. This allows the consumer of your package to choose the sync tool
they want to use, instead of being constrained to only using Rojo.
between Roblox and the file system. These are given to the
`roblox_sync_config_generator` script to generate the configuration for the sync
tool the user is using. pesde forbids `default.project.json` to be part of a
published package, as well as ignoring them from Git dependencies. This allows
the consumer of your package to choose the sync tool they want to use, instead
of being constrained to only using Rojo as well as preventing broken packages
from being published (for example, if the project is configured as a DataModel).
This has the effect that the structure of the files in the file system ends up
being reflected inside Roblox.