Skip to content

Commit

Permalink
Update readme images
Browse files Browse the repository at this point in the history
  • Loading branch information
Edvinas01 committed Oct 6, 2023
1 parent 6c3c873 commit 92bbe1a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions Packages/com.chark.game-management/Documentation~/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,27 @@ This will import:
- [Default Game Manager Prefab] - prefab which can be used as a template for your game manager prefab.
- [Default Game Manager Settings Profile] - asset which defines how the [Default Game Manager] should load.

After importing, open the [Game Manager Settings] asset (located at `Assets/Settings/GameManagerSettings.asset` by default) and add [Default Game Manager Settings Profile] to the **Profiles** field. Also make sure this profile is active.
After importing, open the [Game Manager Settings] asset (located at `Assets/Settings/GameManagerSettings.asset` by default) and add [Default Game Manager Settings Profile] to the **Profiles** field. Also make sure this profile is active:

<p align="center">
<img hspace="2%" src="game-manager-settings.png"/>
</p>

Run the game!

## Game Manager Settings

[Game Manager Settings] asset will be created automatically for you when you install this package. The default location is at `Assets/Settings/GameManagerSettings.asset` but you can move it anywhere in your project. [Game Manager Settings] asset defines which [Game Manager] should load and how. If there are more than one profiles added to this asset, the first profile which is active will be used. If no profiles are active or the list is empty, a no-op default profile will be utilized.
[Game Manager Settings] asset will be created automatically for you when you install this package. The default location is at `Assets/Settings/GameManagerSettings.asset` but you can move it anywhere in your project.

[Game Manager Settings] asset defines which [Game Manager] should load and how. If there are more than one profiles added to this asset, the first profile which is active will be used. If no profiles are active or the list is empty, a no-op default profile will be utilized.

When you create this asset for the first time, it will have no **Profiles** added. To override the defaults you'll need to define a custom [Game Manager Settings Profile] asset, configure it and add to this list. You can create [Game Manager Settings Profile] assets the following way:

- Right-click anywhere in the _Project Window_ and select _Create/CHARK/Game Management/Game Manager Settings Profile_.
- Add it to the [Game Manager Settings] asset **Profiles** list.

<p align="center">
<img hspace="2%" width="30%" src="game-manager-settings.png"/>
<img hspace="2%" width="30%" src="game-manager-settings-profile.png"/>
<img hspace="2%" src="game-manager-settings-profile.png"/>
</p>

Available properties for customization on [Game Manager Settings Profile]:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 92bbe1a

Please sign in to comment.