Trouble getting started with the example project

[andybak]

FIrstly - Unity won't allow you to open scene files that are installed via UPM so I copied the examples to my assets directory. At this point I got errors because of duplicate names. I closed Unity, removed the examples entry from packages.json and restarted.

However - the example scenes seemed to have lost references and nothing worked.

Personally speaking, I'd recommend publishing the example as a full Unity project. It's a much more reliable way to distribute working code and the presence of a ProjectSettings directory will clarify which Unity version it's expected to work with.

Another issue is the use of Odin. It appears to only be used for inspector buttons and could probably be replaced with https://github.com/dbrizov/NaughtyAttributes which has the same functionality and is open source.

I'm still interested in trying Graphene so any pointers on fixing the issues above would be gratefully received. I'm happy to contribute PRs wherever that would be helpful but I need to get the examples working before I can be much use in that department.

[LudiKha]

Hi @andybak ! I'll heed your advice and split up the online demo from the sample project, and provide the latter in the form of a Unity Project.

I also experience the lost references issue - unfortunately this seems to be an issue with Unity git packages that are re-imported (e.g. by upgrading to a different version) whilst the editor is open. Restarting the editor has always fixed this issue for me, but I agree it is something that needs to be figured out structurally.

The Odin issue has since been resolved, thanks for bringing it to my attention. Very happy to hear you're willing to contribute. I'll keep you posted with the changes!

[LudiKha]

Hi @andybak - sorry for the long wait. I've started working on improving the usability of the project this week, including its documentation. You can find the new sample project under the following repo:

https://github.com/LudiKha/Graphene-Sample-Project

It should be plug & play. I'll be updating the documentation further this week.