Skip to content

Commit

Permalink
Merge pull request #436 from PlasticSCM/1001544-update-readme-about-u…
Browse files Browse the repository at this point in the history
…nreal-ofpa

Update README about Unreal 5 OFPA

release:trigger
  • Loading branch information
SRombautsU authored Oct 19, 2022
2 parents bbc9b82 + efe4127 commit b7aa5c8
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ extend it in the future, and we hope it will be useful and convenient to use.
1. Lists your pending changes
2. Allows you to checkin all your pending changes at once
3. Allow to see inline file changes as well as full-file changes compared to the latest changeset
4. Group changes to assets from Unreal Engine 5 One File Per Actor (OFPA) in the "Dirty Unreal Levels" resource group, coalesced under the name(s) of the corresponding map(s)

## Install

Expand All @@ -36,19 +37,22 @@ extend it in the future, and we hope it will be useful and convenient to use.

## Configure

|Name |Type |Description
|-------------------------------------------------|---------|-----------
|`plastic-scm.autorefresh` |`boolean`|Whether the extension should automatically look for changes in the workspace
|`plastic-scm.enabled` |`boolean`|Whether the extension is enabled
|`plastic-scm.cmConfiguration.cmPath` |`string` |Location of the `cm` CLI executable
|`plastic-scm.cmConfiguration.millisToStop` |`number` |Grace time to wait before requesting a shell to closeshell to start
|`plastic-scm.cmConfiguration.millisToWaitUntilUp`|`number` |Time to wait for the shell to start
|`plastic-scm.decorations.enabled` |`boolean`|Whether or not file decorations are enabled
|Name |Type |Description
|-----------------------------------------------------|---------|-----------
|`plastic-scm.autorefresh` |`boolean`|Whether the extension should automatically look for changes in the workspace
|`plastic-scm.enabled` |`boolean`|Whether the extension is enabled
|`plastic-scm.cmConfiguration.cmPath` |`string` |Location of the `cm` CLI executable
|`plastic-scm.cmConfiguration.millisToStop` |`number` |Grace time to wait before requesting a shell to closeshell to start
|`plastic-scm.cmConfiguration.millisToWaitUntilUp` |`number` |Time to wait for the shell to start
|`plastic-scm.decorations.enabled` |`boolean`|Whether or not file decorations are enabled
|`plastic-scm.consolidateUnrealOneFilePerActorChanges`|`boolean`|Whether all changes under Unreal Engine 5 One File Per Actor (OFPA) should be groupped under "Dirty Unreal Levels"

## Commands

We're working to add more! 👷‍♀️👨‍🏭

Have a look at the [list of issues on Github](https://github.com/PlasticSCM/vscode-plasticscm/issues).

### Checkin

You can type in the input field in the SCM view and hit `Ctrl+Enter` to checkin
Expand Down

0 comments on commit b7aa5c8

Please sign in to comment.