If you are upgrading from a previous version of the plugin, see the instructions at the bottom.
The main goal of this release is to prepare the code base for adding a 3D version of the generator in the future. The main change is that the majority of classes in the project now have the Grid2D suffix. The transition to this version should be relatively simple as the old classes without the suffix are still present in the codebase and you will get an Obsolete warning in the console with instructions on how to use the new API. It is recommended to fix all the warnings now because, in the next version, the old API will be removed and you will just get a bunch of compilation errors. Also, there will be some additional breaking changes, but hopefully nothing too difficult (see below).
Another goal of this release is to transition to not having alpha/beta keywords in all the versions of the asset. The first release of the v2 branch of the generator is now almost 2 years old and I believe that Edgar is now mature enough to be used in production scenarios.
As always, you are welcome to join our Discord server. So if you have anything to ask, want to share what you are doing with Edgar, or just want to chat about anything, you are encouraged to join us!
🚀 New features
- Custom post-processing logic can now be also implemented as a MonoBehaviour component rather than a ScriptableObject. (docs)
- Added keyboard shortcuts to the level graph editor:
- select multiple rooms when holding
Shift - duplicate rooms with
Ctrl + D - delete rooms with
Ctrl + Del
- select multiple rooms when holding
🐛 Bug fixes
- Fixed weird behaviour of door sockets in some corner cases
💅 Polish
- Edgar components are now properly organized in the Add Component menu
- Do not show door labels if they are too small
💥 Breaking changes
- Most of the classes now have the
Grid2Dsuffix to indicate that they belong to the 2D version of the generator. For now, the old classes without the suffix still exist but will produceObsoletewarnings. It is recommended to fix the warnings as soon as possible. - Internal structure of core folders was changed but that should not affect you unless you changed the internals of the generator.
- The API of custom post-processing logic was changed. The
Runmethod now expects a single argument: an instance of theDungeonGeneratorLevelGrid2Dwhich now also contains the level description which was previously passed as the second argument. - All examples were moved into the
Examples/Grid2D/folder (previously was onlyExamples/
⏩ Migrate from previous version
Important for this version: remove all existing Edgar files before updating!
To update the plugin from a previous version, it is critical to first remove all the old files (Assets/Edgar folder) and then import the newer version of the plugin. You may also want to back up your files if you did some changes to the asset files.
To make it easier for you to update to future versions of the asset, please try to not create your games directly in any of the example scenes. It is okay to use these scenes as a playground. However, be prepared to lose all your modifications when upgrading to a new version of the asset.