Skip to content

Commit

Permalink
chore(release): 2.0.0 [skip ci]
Browse files Browse the repository at this point in the history
# [2.0.0](v1.0.1...v2.0.0) (2024-03-27)

### Bug Fixes

* **quest inspector:** cleaned up display bugs in the task display ([cc23082](cc23082))

### Features

* **quest database:** quests are now separate ScriptableObjects independent of the database ([9c64eb5](9c64eb5))
* **quest events:** quest collection now has event hooks ([c535109](c535109))
* **quests and tasks:** default quest and task definition can now be excluded from inspectors ([359ba7b](359ba7b))

### BREAKING CHANGES

* **quest database:** Breaks all existing quest implementations. It is recommended to not upgrade to this
version if you're on 1.X.
  • Loading branch information
semantic-release-bot committed Mar 27, 2024
1 parent fb55d52 commit 484898c
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 3 deletions.
7 changes: 7 additions & 0 deletions Assets/com.fluid.quest-journal/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [1.0.1](https://github.com/ashblue/unity-quest-journal/compare/v1.0.0...v1.0.1) (2021-11-28)


### Bug Fixes

* **builds:** prevents a crash by removing accidentally included editor only code ([b163656](https://github.com/ashblue/unity-quest-journal/commit/b16365679b7a23c848271325e8a5e6d90a07f016))

# 1.0.0 (2021-09-03)


Expand Down
35 changes: 35 additions & 0 deletions Assets/com.fluid.quest-journal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and Th
* Customizable drop in example prefab to easily get a quest GUI up and running in minutes
* Save / load support out of the box
* Heavily tested with TDD
* Includes event hooks to distribute rewards, update UI, and other game logic

**Support**

Expand Down Expand Up @@ -105,6 +106,34 @@ Found in `Assets/Examples/DebugQuestPrint/DebugQuestPrint.scene`. A useful scene

## Recipes

### Event Hooks

You can hook into quest state changes with the following hooks. This is extremely useful for granting rewards, detecting task changes, updating UI, and other game logic.

NOTE: Make sure you remove the event listener when the listening object is destroyed to prevent memory leaks.

```c#
// Triggers when a quest is added to the collection. Generally useful for UI updates
QuestJournalManager.Instance.Quests.EventQuestAdd.AddListener((quest) => {
// Your logic here
});

// Triggers when a quest is completed due to running out of tasks. Useful for quest completion post processing events
QuestJournalManager.Instance.Quests.EventQuestComplete.AddListener((quest) => {
// Your logic here
});

// Triggered when a quest has a task change. A good place to update your UI if you are displaying quest progress
QuestJournalManager.Instance.Quests.EventQuestUpdate.AddListener((quest) => {
// Your logic here
});

// Triggers whenever a task is completed with the corresponding quest and task instance. Useful to fire post processing events with completed tasks.
QuestJournalManager.Instance.Quests.EventQuestTaskComplete.AddListener((quest, task) => {
// Your logic here
});
```

### Save And Load

Unity Quest Journal supports save and load functionality out of the box. You can execute a save of your current quest states as so.
Expand Down Expand Up @@ -169,6 +198,12 @@ var taskDefinition = QuestJournalManager.Instance.Quests
.Definition as MyCustomTaskDefinition;
```

### Hiding Default Quest and Task

If you've written your own custom tasks you probably don't want the default ones to show up in the inspector. You can hide them by clicking the following checkboxes in your settings object.

![Hide default quest and task](docs/hide-default-quest-and-task.png)

## Releases

Archives of specific versions and release notes are available on the [releases page](https://github.com/ashblue/unity-quest-journal/releases).
Expand Down
2 changes: 1 addition & 1 deletion Assets/com.fluid.quest-journal/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "com.fluid.quest-journal",
"version": "1.0.1",
"version": "2.0.0",
"displayName": "Unity Quest Journal",
"description": "A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and The Witcher 3's task managment system.",
"unity": "2020.1",
Expand Down
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# [2.0.0](https://github.com/ashblue/unity-quest-journal/compare/v1.0.1...v2.0.0) (2024-03-27)


### Bug Fixes

* **quest inspector:** cleaned up display bugs in the task display ([cc23082](https://github.com/ashblue/unity-quest-journal/commit/cc230826a167ce0b5e5d9b0c0a41baec313cbae4))


### Features

* **quest database:** quests are now separate ScriptableObjects independent of the database ([9c64eb5](https://github.com/ashblue/unity-quest-journal/commit/9c64eb5f200b34cd93f132e841150c16067b16e9))
* **quest events:** quest collection now has event hooks ([c535109](https://github.com/ashblue/unity-quest-journal/commit/c5351092340b6a538d170834217822185b94b141))
* **quests and tasks:** default quest and task definition can now be excluded from inspectors ([359ba7b](https://github.com/ashblue/unity-quest-journal/commit/359ba7be8fa19cc44493e601c26622d3b8c1b2a1))


### BREAKING CHANGES

* **quest database:** Breaks all existing quest implementations. It is recommended to not upgrade to this
version if you're on 1.X.

## [1.0.1](https://github.com/ashblue/unity-quest-journal/compare/v1.0.0...v1.0.1) (2021-11-28)


Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "com.fluid.quest-journal",
"version": "1.0.1",
"version": "2.0.0",
"unity": "2020.1",
"displayName": "Unity Quest Journal",
"description": "A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and The Witcher 3's task managment system.",
Expand Down

0 comments on commit 484898c

Please sign in to comment.