From 3d06fafa6d4581657bc9c8eecfae7340c821d657 Mon Sep 17 00:00:00 2001 From: Remco Date: Wed, 13 May 2026 19:20:05 +0200 Subject: [PATCH] Update readme.md --- readme.md | 37 +++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 54c65ea852..a5656233f5 100644 --- a/readme.md +++ b/readme.md @@ -2,14 +2,14 @@ EpicNabbo Catalogue v2 is a heavily optimized evolution of our catalog system, specifically engineered for **Nitro v3** with 100% full native support. -Version 1 failed to meet our strict quality standards due to a flawed initial approach. Instead of starting completely from scratch, Version 2 takes a **rock-solid base structure**, merges it with the assets from v1, and completely overhauls the framework. We are massively expanding the database to include **over 52,000+ items/furni**, fully organized with zero missing pages. +Version 1 failed to meet our strict quality standards due to a flawed initial approach. Instead of starting completely from scratch, Version 2 takes a **rock-solid base structure**, merges it with the assets from v1, and completely overhauls the framework. We are massively expanding the database to include **over 52,000+ items/furni**—a massive leap from v1, which would have only featured 31,000 items at full completion. > ⚠️ **Current Status: Active Development (WIP)** > The core base and v1 data merge are completed, but it is **not yet suitable for production use**. Estimated time to final release is **a few weeks**. ## 🚀 Key Improvements & Objectives over v1 -* **Massive 52k+ Furni Database:** Expanded and optimized to smoothly handle a massive catalog of over 52,000 furniture items without lag. +* **Massive 52k+ Furni Database:** An increase of over 21,000 items compared to the 31k target of v1, optimized to handle the massive load without lag. * **Native Nitro v3 Support:** Specially tailored to fully support all Nitro v3 features, packet structures, and UI elements. * **Meeting High Quality Standards:** Re-engineered to fix the structural and performance flaws that caused v1 to fail our internal benchmarks. * **100% Complete Layout:** Merging v1 data into a superior base ensures all pages, tabs, and sub-items are present with absolutely zero missing pages. @@ -21,12 +21,34 @@ Version 1 failed to meet our strict quality standards due to a flawed initial ap | Feature | Version 1 (Old) | Version 2 (New) | | :--- | :--- | :--- | | **Status** | Discontinued (Failed Quality Checks) | **In Development (Base & Merge Ready)** 🛠️ | -| **Catalog Size** | Limited / Unorganized | **52,000+ Items (Massive Expansion)** 📦 | +| **Catalog Size (Full)** | ~31,000 Items (Projected) | **52,000+ Items (Massive Expansion)** 📦 | | **Nitro v3 Support**| None / Partial | **100% Full Native Support** | | **Completeness** | Missing pages & broken links | 100% Complete & verified structure | | **Performance** | Slow loading / poor queries | Blazing fast optimized index | | **ETA** | - | **A few weeks** | +## ⚙️ Technical Requirements & Optimization + +To ensure smooth operation of the 52k+ item database, your environment must meet the following criteria: + +* **Database:** MySQL 8.0+ or MariaDB 10.5+ (Required for advanced indexing optimizations). +* **Server Environment:** Fully optimized for **Nitro v3** asset structures and packet handling. +* **MySQL Configuration:** You **must** increase your packet size limits in your `my.ini` or `my.cnf` file before importing the SQL file due to its massive size, otherwise the import will crash: + ```ini + max_allowed_packet = 64M + ``` + +## 📁 Repository Structure + +```text +├── .gitlab/ # CI/CD and issue templates +├── database/ # Optimized SQL structures (Base + v1 Merge + 52k Expansion) +│ ├── core_catalog.sql # The main catalog table structures +│ └── items_dump.sql # Full 52,000+ items dataset +├── nitro_assets/ # Nitro v3 configuration files and JSON hooks +└── README.md +``` + ## 🛠️ Current Roadmap - [x] Analyze v1 bottlenecks and establish a superior base framework. @@ -35,10 +57,13 @@ Version 1 failed to meet our strict quality standards due to a flawed initial ap - [/] Integrate full Nitro v3 compatibility hooks (In Progress). - [ ] Final quality assurance testing and zero-missing-pages validation. -## 📦 Getting Started (Development Preview) +## 📦 Database Installation Guide (Development Preview) -1. Clone this repository: +1. Clone this repository to your local machine: ```bash git clone gitlab.com ``` -2. Keep an eye on the active development branches for updates over the coming weeks. \ No newline at end of file +2. Open your MySQL terminal or database tool (e.g., Navicat, HeidiSQL). +3. Import `core_catalog.sql` first to set up the clean page structures. +4. Import `items_dump.sql` to populate the 52,000+ items. *(Note: This may take a few minutes depending on your hardware).* +5. Clear your Nitro v3 server cache and restart your emulator environment. \ No newline at end of file