- Using the Package Manager interface
Use the url https://github.com/FellowshipOfTheGame/DialogueModule.git#upm and press add
- Editing the Packages/manifest.json file directly
Make sure this project is in the dependencies list as shown below and open the project as usual:
{
"dependencies": {
"com.fellowshipofthegame.dialoguemodule": "https://github.com/FellowshipOfTheGame/DialogueModule.git#upm"
}
}
- Installing a specific version of the package (Recommended)
If you want to install a specific version of the package follow the instructions above, but replace #upm with the desired version.
The url in the first example would be https://github.com/FellowshipOfTheGame/DialogueModule.git#1.0.4 for version 1.0.4.
The Example sample included in the package has a scene and dialogues with 3 use cases possible, as well as 2 prefabs that can be copied and changed as needed.
The example is based on the FinalInferno use of the package, where we inherit the base Dialogue and OptionsDialogue classes to add extra behaviour when starting/ending dialogue instead of pausing the game.
If the desired effect is the one from Anathema the base classes would suffice, all you need to do is check the pauseDuringDialogue option in the DialogueHandler.
After changes are pushed to the main branch of the repo, a github action will automatically update the upm branch with the proper directory structure for a release. After that it's just a matter of doing a new release pointing to that upm branch.
When creating a new release, it is necessary to update the version number in the package.json file using semanting versioning for the number (major.minor.patch). The tag for the new release must also correspond with this new version number.