search

WolvenKit / gpm

gpm or Game Package Manager is a tool for downloading, installing, uninstalling, building, and publishing mod packages
GNU Affero General Public License v3.0
7 stars 3 forks source link

[RFC] - I want to ignore files when packaging mods #1

Closed osulli closed 2 years ago

osulli commented 3 years ago

What

As a user, I would like to be able to ignore some file when publishing a mod package.

marius851000 commented 3 years ago

Proposed solution: have a .cpignore file that follow the same specification as .gitignore (https://git-scm.com/docs/gitignore . Didn't read them, just use a library that implement it). potentially use .gitignore by default, but this would exclude compiled content, that we may want to include include in the mod. 2 possibility:

Aelto commented 3 years ago

What is proposed solution to include the .gitignore in the .cpignore? We agreed that .cpignore will always be used by default right? What about an optional parameter to also use the gitignore, something like gpm publish --use-gitignore could work, and it would mean that the CLI would use the gitignore instead of the cpignore (or both?)

marius851000 commented 3 years ago

rather than a --use-gitignore, maybe a --ignore-file <path> that use any specified ignore file rather than the .cpignore one. Maybe we could use some preprocessing to include a gitignore into another, but that seem to be uselessly complicated. Maybe adding a --no-ignore could be usefull, however.

MythicManiac commented 3 years ago

It was noted on Discord that assuming we want to turn the tool into a generic game package manager, we should probably stick to names that aren't related to cyberpunk.

Some proposals:

marius851000 commented 3 years ago

Right now, it ignore file in the .modignore at the root of the mod, in the same format as gitignore, based on the crate ignore.