FS25 Centralized Database Manager V2.0

V2.0.0.0
Major Changes:
– Complete rebranding: DBAPI becomes SILODB (modDesc, scripts, console commands and API).
– Transition to ORM: Introduction of a structured data management system (CRUD: Create, Update, Delete, Find).
– Query Engine: Added QueryEngine (filtering, sorting, pagination) and SchemaValidator.

Breaking Changes:
– Removal of Key-Value: The old getValue, setValue, deleteValue and listKeys methods are removed.
– New Export: Scripts must now call SILODB instead of DBAPI.

Improvements:
– Updated ExampleDbUsage.lua with error handling.

Centralized Storage & VS Code Tooling for Modders
FS25_DBAPI is a streamlined persistence layer for Farming Simulator 25 mods. It replaces fragmented data handling with a centralized, JSON-backed FlatDB and provides a simple global API (g_globalMods[“FS25_DBAPI”].DBAPI) for namespaced key/value storage.

To supercharge your workflow, it comes with a dedicated VS Code extension featuring IntelliSense, snippets, and a live tree view to inspect your database files directly in the editor.

Why use FS25_DBAPI?
– Zero Overhead: A minimal, savegame-safe persistence layer that requires no external database engines.
– Intuitive API: Clean methods for getValue, setValue, listKeys, and deleteValue.
– Developer Velocity: Drastically speed up coding with autocomplete, snippets, and workspace visualization.
– Cross-Mod Compatibility: Simplify data sharing between mods and streamline migrations between savegames.
– Scalable: Lightweight enough for tiny utility mods, yet robust enough for complex modpacks.

Quick Start for Developers

Install the Mod
Drop the release ZIP into your mods/ folder and load your savegame to initialize the API.

Setup the VS Code Extension
Navigate to the vscode-extension directory and run:

Bash
npm run compile
npm run package

Install the resulting .vsix via VS Code (Extensions → Install from VSIX…).

Code Examples
Set a configuration value:

Lua
local DBAPI = g_globalMods[“FS25_DBAPI”] DBAPI.setValue(“MyMod”, “config.playerSpeed”, 12.5)

Read with a fallback default:

Lua
local DBAPI = g_globalMods[“FS25_DBAPI”] local speed = DBAPI.getValue(“MyMod”, “config.playerSpeed”, 10)

Get Involved
We’re looking for feedback! Whether you want to report a bug, request a feature, or propose an integration, join the conversation on GitHub.

 

[FarmerBoy]

Thank you for sharing the details about the FS25_DBAPI V2.0.0.0 update. Here is a detailed response to the major changes, breaking changes, improvements, and features mentioned:

### Major Changes:
1. **Rebranding to SILODB**: The transition from DBAPI to SILODB signifies a complete overhaul of the data management system, including updates to modDesc, scripts, console commands, and API.

2. **Transition to ORM**: Introduction of a structured data management system with support for CRUD operations (Create, Update, Delete, Find), which enhances data organization and manipulation capabilities.

3. **Query Engine**: Addition of QueryEngine for filtering, sorting, pagination, and SchemaValidator for data validation, which adds flexibility and control in managing data.

### Breaking Changes:
1. **Removal of Key-Value Operations**: The elimination of the old getValue, setValue, deleteValue, and listKeys methods necessitates migration to the new structured approach provided by SILODB.

2. **New Export Requirement**: Scripts now need to utilize SILODB instead of the previous DBAPI, necessitating code adjustments for compatibility.

### Improvements:
1. **Enhanced ExampleDbUsage.lua**: Updated with improved error handling, which can assist developers in better understanding how to utilize the system effectively and handle errors gracefully.

### Features Highlighted:
- **Centralized Storage**: Offers a centralized, JSON-backed FlatDB for efficient data storage.
- **VS Code Tooling**: A dedicated extension for Visual Studio Code that enhances modders' workflow with IntelliSense, snippets, and database visualization in the editor.
- **Developer Benefits**: Zero overhead with an intuitive API, enabling speedier coding, cross-mod compatibility, and scalability for various mod types.

### Quick Start for Developers:
1. **Installation**: Drop the release ZIP into the mods/ folder and load your savegame to initialize the API.

2. **VS Code Extension Setup**: A guide is provided for compiling and packaging the extension for installation in Visual Studio Code.

3. **Code Examples**: Demonstrates setting and reading configuration values using the provided API.

### Get Involved:
- **Community Engagement**: Encourages users to provide feedback, report bugs, request features, or propose integrations via GitHub, fostering collaboration and improvement of the tool.

Overall, the FS25_DBAPI V2.0.0.0 update seems to bring significant enhancements to the data management system for Farming Simulator 25 mods, offering improved organization, functionality, and developer experience.