Skip to content

Commit f0f798a

Browse files
Update README.md
1 parent 6969dd6 commit f0f798a

1 file changed

Lines changed: 4 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,10 @@ To install Visual State Machine in your Unity project, follow these steps:
2222

2323
When upgrading to Visual State Machine V2 (VSM2) version 0.9.0-beta, follow these steps to ensure a seamless transition and maintain functionality within your Unity project:
2424

25-
1. **Commit Changes:**
26-
Before starting the upgrade, ensure all your current work is committed to version control. This is an important step as we will need to revert some assets shortly.<br><br>
27-
2. **Add Using Statement:**
28-
You will need to include the following using statement in your custom States in order to support the new [Enter] Attribute.
29-
```csharp
30-
using Nonatomic.VSM2.StateGraph;
31-
```
32-
3. **Update Custom States:** Decorate all OnEnter methods within your custom states with the new [Enter] attribute to align with the updated method handling in version 0.9.0-beta:
33-
```csharp
34-
[Enter]
35-
public override void OnEnter()
36-
{
37-
// Your code here
38-
}
39-
```
40-
4. **Restore StateMachineModel Assets:** Due to changes in the way VSM2 locates entry methods into States, all transitions in your StateMachineModel assets will be invalidated. You will now need to manually restore your StateMachineModel assets from version control.<br><br>
41-
5. **Test the Project:** After restoring the transitions, run your project to ensure all states and transitions function as expected. Check for any errors or unexpected behaviors and address them accordingly.<br><br>
42-
6. **Commit the Upgrade:** Once you have verified that everything is functioning correctly, commit the changes to version control. This final step confirms that your project is stable with the upgraded VSM2 version.
25+
1. **Commit Changes:** Before starting the upgrade, ensure all your current work is committed to version control.>
26+
2. **Update the package:** to the 0.9.0-migration tag.
27+
3. **Run the migration tool:** from Tools -> VSM2 -> Migrate to 0.9.0-beta
28+
4. **Update the package again:** Once the migration has completed update the package to the latest, currently 0.9.6-beta
4329

4430
## Usage
4531
1. **Create a State Machine Asset**

0 commit comments

Comments
 (0)