simtactics/mysimulation
1
0
Fork 0
mirror of https://github.com/simtactics/mysimulation.git synced 2025-08-29 08:17:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated server README

Browse source 
- Removed accidental of API's object files
This commit is contained in:
Tony Bark 2024-05-01 03:50:54 -04:00
parent 22191ce648
commit 4b5e584eeb
18 changed files with 419 additions and 16737 deletions
Download patch file Download diff file Expand all files Collapse all files

13
server/README.md
View file

@ -1,12 +1,13 @@
# API Server
zTSO utilizes the FreeSO API architecture for its backend, albeit not entirely compatible due to differences in simulation management.
zTSO uses FreeSO's API architecture for the backend. However, zTSO is not 100% compatible with FreeSO due to differences in how the simulation is managed. Instructions for setting up an API server are available in the appropriate directories. zTSO's API is based on FreeSO `beta-update-88b`.
### Versioning Scheme
To maintain compatibility with legacy servers, zTSO follows a slightly altered version scheme that adheres to SemVer guidelines. Instead of `beta/update-88b`, it becomes `beta/update-0.88.101`. Prefixed letters are replaced with a three-digit incremental patch number, akin to .NET's SDK versions. This approach aims to ensure that zTSO servers cannot access FreeSO's servers while remaining familiar to existing users and server operators.
Instead of using FreeSO's versioning scheme, zTSO adopts a versioning pattern that adheres to SemVer guidelines with some modifications:
As the API server is already complete, zTSO's client and server will have separate release cycles. The API server will have a Long-Term Support (LTS) release to support existing server operators, while the client will follow a rapid rolling release. To prevent conflicts between the two clients, the API server will be modified to check for zTSO-based clients as part of an additional handshake during login. This check will be ignored by FreeSO-based clients as it constitutes a separate API call.
- FreeSO version ``beta/update-88b`` becomes ``beta/update-0.88.101`` in zTSO.
- Prefixed letters in FreeSO version are replaced with a three-digit incremental patch number in zTSO, akin to .NET's SDK versions.
## Support Cycle
This versioning strategy aims to ensure that zTSO servers remain distinct from FreeSO-compatible servers while maintaining familiarity for existing users and server operators.
| Version | Release Date | Type | End of Support |
| ------- | ------------ | ---- | -------------- |
| 0.88 | March 31 | LTS | TBA |