Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Runner tutorial dependency has changed in the project, but the documentation still references the old version #369

Closed
PaulPorthouse opened this issue Jan 7, 2024 · 2 comments

Comments

@PaulPorthouse
Copy link

While going through the tutorial, I encountered this issue (https://forum.defold.com/t/cant-find-hero-json-for-runner-tutorial-solved/69559/5) which is marked as solved but it actually isn't. The problem occurs because the tutorial page specifies adding the spine dependency https://github.com/defold/extension-spine/archive/main.zip, but the dependency in the project file in the repo has been changed to reference https://github.com/defold/extension-spine/archive/refs/tags/2.13.0.zip.

Would it be possible to update the documentation to reflect this change please?

Thanks

@britzl
Copy link
Contributor

britzl commented Jan 7, 2024

Hmm, the thing is that the Spine extension has many releases and some of them are not compatible with certain editor releases. Example:

You can see all spine extension releases here and some of them mention a new minimum Defold version that is required: https://github.com/defold/extension-spine/releases

The tutorial expects the user to download the latest version of Defold and then use the latest version of the extension. These two should usually work together, but not necessarily always.

I'm not sure how to solve it? Should we ask the user to pay attention to the list of releases and pick the one matching the editor version that was downloaded and installed?

@PaulPorthouse
Copy link
Author

@britzl I see your point.

From a users perspective, at the moment, the tutorial is very absolute about what should be done (Add the following URL to your game.project dependencies) but I think it would be better to let them know that this can change depending on the version of Defold they are running. It would probably also be beneficial to provide the link to the releases (https://github.com/defold/extension-spine/releases) as this also has the Defold release number attached to each release and then they can make an informed decision about what version they need.

Thanks for looking at this

@britzl britzl closed this as completed in a142184 Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants