Modding:Mod-Engine Compatibility: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The Vintage Story Game engine is not immune to code deprecation. When new releases are made, some API components may become obsolete or removed entirely. However | The Vintage Story Game engine is not immune to code deprecation. When new releases are made, some API components may become obsolete or removed entirely. However, we the VS Team do very carefully consider every API breaking change, and try to minimize breaking changes as much as possible. | ||
In general, if your mod consists mostly of JSON assets, you are likely safe from breakage across several major updates. And even if your mod contains C# code, I'd like to believe 9 out of 10 times, the breakage on a major update should minimal and fixable within an hour or two. Every API change is also documentd in every devlog entry, to help you with your migration process. | In general, if your mod consists mostly of JSON assets, you are likely safe from breakage across several major updates. And even if your mod contains C# code, I'd like to believe 9 out of 10 times, the breakage on a major update should minimal and fixable within an hour or two. Every API change is also documentd in every devlog entry, to help you with your migration process. | ||
Revision as of 18:02, 16 July 2022
The Vintage Story Game engine is not immune to code deprecation. When new releases are made, some API components may become obsolete or removed entirely. However, we the VS Team do very carefully consider every API breaking change, and try to minimize breaking changes as much as possible. In general, if your mod consists mostly of JSON assets, you are likely safe from breakage across several major updates. And even if your mod contains C# code, I'd like to believe 9 out of 10 times, the breakage on a major update should minimal and fixable within an hour or two. Every API change is also documentd in every devlog entry, to help you with your migration process.
We also have a prolonged and consistent release cycle to prepare modders for a new major update.
1. pre: A preview release, we consider all major api changes to be 90% complete at this point. The main focus is finishing up minor game content.
2. rc: A release candidate, we consider all major api changes to be complete as well as all game features. The main focus is bugfixing.
3. stable: A stable version. We only change the API in extraordinary circumstances at this point.
If you experience a pattern of major breakage that requires many hours of updating to get your mod working again - the dev team always has an open ear for suggestions. Please also keep in mind, we are not perfect. Sometimes breakage does happen, sometimes unintentionally.
