Update readme.md

This commit is contained in:
Remco Epicnabbo
2026-05-18 21:05:47 +02:00
parent 46d5f19c97
commit df06b423fa
+22 -55
View File
@@ -1,69 +1,36 @@
# EpicNabbo Catalogue v2 (In Development 🛠️) # EpicNabbo Catalogue v2 (Development 🛠️)
EpicNabbo Catalogue v2 is a heavily optimized evolution of our catalog system, specifically engineered for **Nitro v3** with 100% full native support. EpicNabbo Catalogue v2 is a heavily optimized evolution of our catalog system, specifically engineered for **Nitro v3** with 100% 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**—a massive leap from v1, which would have only featured 31,000 items at full completion. > 🔴 **CRITICAL WARNING: DEVELOPMENT ONLY**
> **DO NOT USE THIS IN A PRODUCTION ENVIRONMENT.** This system currently contains severe bugs that **can wipe your entire database**. It is strictly intended for local development and testing purposes only.
> ⚠️ **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 ## 🚀 Key Improvements & Objectives
* **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. * **Massive 52k+ Furni Database:** An increase of over 21,000 items compared to v1, optimized for high-performance indexing.
* **Native Nitro v3 Support:** Specially tailored to fully support all Nitro v3 features, packet structures, and UI elements. * **Native Nitro v3 Support:** Tailored to support all modern Nitro UI elements and packet structures.
* **Meeting High Quality Standards:** Re-engineered to fix the structural and performance flaws that caused v1 to fail our internal benchmarks. * **High Quality Standards:** Re-engineered framework to eliminate the performance bottlenecks found in previous versions.
* **100% Complete Layout:** Merging v1 data into a superior base ensures all pages, tabs, and sub-items are present with absolutely zero missing pages. * **100% Verified Layout:** Merging v1 data into a superior base ensures zero missing pages or broken assets.
* **Efficient Development:** Combining a strong existing base with our corrected approach allows us to deliver a massive upgrade in just a fraction of the time.
## 📈 Comparison ---
## 📈 Version Comparison
| Feature | Version 1 (Old) | Version 2 (New) | | Feature | Version 1 (Old) | Version 2 (New) |
| :--- | :--- | :--- | | :--- | :--- | :--- |
| **Status** | Discontinued (Failed Quality Checks) | **In Development (Base & Merge Ready)** 🛠️ | | **Status** | Discontinued | **Active Development** 🛠️ |
| **Catalog Size (Full)** | ~31,000 Items (Projected) | **52,000+ Items (Massive Expansion)** 📦 | | **Production Ready** | Limited | **ABSOLUTELY NOT (Wipe Risk)** |
| **Nitro v3 Support**| None / Partial | **100% Full Native Support** | | **Catalog Size** | ~31,000 Items | **52,000+ Items** 📦 |
| **Completeness** | Missing pages & broken links | 100% Complete & verified structure | | **Nitro v3 Support**| Partial | **100% Full Native Support** |
| **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: ## ⚙️ Technical Requirements
* **Database:** MySQL 8.0+ or MariaDB 10.5+ (Required for advanced indexing optimizations). To handle the 52k+ item dataset, ensure your database configuration is optimized. You **must** increase the packet size in your `my.ini` or `my.cnf` before importing:
* **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 ```ini
[mysqld]
```text max_allowed_packet = 64M
├── .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.
- [x] Merge v1 catalog data into the new clean database structure.
- [/] Expand and index the database to support 52,000+ items (In Progress).
- [/] Integrate full Nitro v3 compatibility hooks (In Progress).
- [ ] Final quality assurance testing and zero-missing-pages validation.
## 📦 Database Installation Guide (Development Preview)
1. Clone this repository to your local machine:
```bash
git clone gitlab.com
```
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.