Skip to content

Some future-proofing #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 14, 2021
Merged

Some future-proofing #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8817f76
Don't delete XComGame\Published in clean.ps1
robojumper Jun 12, 2021
adf7f69
Use release tags in installation instructions instead of pulling main
robojumper Jun 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Open a command line prompt (cmd or powershell, does not matter) in the `[modRoot
your working tree is clean and run the following command:

```
git subtree add --prefix .scripts/X2ModBuildCommon https://github.com/X2CommunityCore/X2ModBuildCommon main --squash
git subtree add --prefix .scripts/X2ModBuildCommon https://github.com/X2CommunityCore/X2ModBuildCommon v1.0.0 --squash
```

### Your mod does not use git
Download the source code of this repository from GitHub. Unzip it and place so that `build_commom.ps1` resides at
`[modRoot]\.scripts\X2ModBuildCommon\build_common.ps1`.
Download the source code of this repository from the latest release on the [Releases page](https://github.com/X2CommunityCore/X2ModBuildCommon/releases/latest).
Unzip it and place so that `build_common.ps1` resides at `[modRoot]\.scripts\X2ModBuildCommon\build_common.ps1`.

## Ignoring the `BuildCache`
The build system will create a `[modRoot]\BuildCache` folder which is used for various file-based operations (such
Expand Down Expand Up @@ -172,7 +172,7 @@ If you don't use git, simply download the new version and overwrite the old file
If you use git, run the same command as before, replacing `add` with `pull`:

```
git subtree pull --prefix .scripts/X2ModBuildCommon https://github.com/X2CommunityCore/X2ModBuildCommon main --squash
git subtree pull --prefix .scripts/X2ModBuildCommon https://github.com/X2CommunityCore/X2ModBuildCommon v1.0.0 --squash
```

# Configuration options
Expand Down
3 changes: 1 addition & 2 deletions clean.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ $folders = @(
"$srcDirectory\BuildCache",
"$sdkPath\Development\Src\*",
"$sdkPath\XComGame\Mods\*",
"$gamePath\XComGame\Mods\$modName",
"$sdkPath\XComGame\Published"
"$gamePath\XComGame\Mods\$modName"
)

$files | ForEach-Object {
Expand Down