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

Semantic version for mod version strings #5892

Open
scarf005 opened this issue Jan 7, 2025 · 1 comment
Open

Semantic version for mod version strings #5892

scarf005 opened this issue Jan 7, 2025 · 1 comment
Labels
confirmed Bug that has been reproduced enhancement src changes related to source code.

Comments

@scarf005
Copy link
Member

scarf005 commented Jan 7, 2025

What is semantic version?

tl;dr: a versioning scheme like Major.Minor.Patch e.g 1.0.0 that's used virtually everywhere

Why do we need it?

One word: better UX.

It's required to check whether mods are compatible when creating a mod registry (think of steam workshop, nexus mods but for BN mods).

e.g after semver is stabilized, we could show players that this mod would only work on magical_nights equal to or newer than 1.7.0.

{
  "id": "my_magical_nights_extension",
  "dependencies": {
    "magical_nights": ">=1.7.0"
  }
}

we could borrow syntax for version range from other popular solutions (https://semver.npmjs.com/, https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#version-requirement-syntax)

without semver mods uploaded to mods registry will 99% of time crash with each other and it'll be a waste of time and effort to not do this automatically

Additional context

https://discord.com/channels/830879262763909202/1222011030079672330

@RoyalFox2140 RoyalFox2140 added enhancement confirmed Bug that has been reproduced src changes related to source code. labels Jan 7, 2025
@RoyalFox2140
Copy link
Collaborator

I'd say it's basically inevitable we'll do some level of semantics for mods.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed Bug that has been reproduced enhancement src changes related to source code.
Projects
None yet
Development

No branches or pull requests

2 participants