diff --git a/readme.md b/readme.md index e94f936efc..0808b6cd8a 100644 --- a/readme.md +++ b/readme.md @@ -1,37 +1,73 @@ -Here is a clear, professional, and comprehensive README.md for EpicNabbo 2.0. It highlights the stability of the release while honestly noting the current limitation with the search functionality. - -Markdown # EpicNabbo 2.0 - Catalogue -Welcome to **EpicNabbo 2.0**, a powerful and highly optimized catalogue system designed for seamless content management and presentation. This release focuses heavily on core stability, performance improvements, and a robust architecture. +Welcome to **EpicNabbo 2.0**, a powerful, high-performance catalogue system engineered for seamless integration with **Polaris Emulator**, **Octane**, and **Octane Render**. This release focuses on modern architecture, enhanced asset rendering, and modularity. --- -<<<<<<< Updated upstream -## 🚀 Status: Stable -======= -## 🚀 Status: Stable not done ->>>>>>> Stashed changes +## 🚀 Status & Release Tracks -EpicNabbo 2.0 has undergone extensive testing to ensure that the core database handling, page rendering, and item structures are completely **stable** for production environments. You can rely on this version for day-to-day operations without worrying about critical crashes or data corruption. +* **Full Habbo Edition:** **Stable** — Fully tested and production-ready. Database handling, page rendering, item structures, search, and emulator integration are rock-solid for day-to-day operations. +* **Customs Edition:** **In Development / Work in Progress** — Currently under active testing and development. Not yet complete or ready for production, but progressing steadily toward a full future release. -> ⚠️ **Known Issue:** The **Search Functionality** is currently not working as intended. While it will not crash the system, the search results may be inaccurate or incomplete. This is a known priority and is actively being worked on for the next patch. +--- + +## 🌐 Multi-Language Support + +Both editions are designed with native multi-language support out of the box: +* 🇬🇧 **English** +* 🇳🇱 **Dutch** (Nederlands) +* 🇩🇪 **German** (Deutsch) +* 🇪🇸 **Spanish** (Español) +* 🇮🇹 **Italian** (Italiano) + +--- + +## ⚙️ Core Integration & Engine + +EpicNabbo 2.0 is built to seamlessly sync with modern server stacks: +* **Polaris Emulator Support:** Native database schema and packet-level alignment with the Polaris emulator. +* **Octane & Octane Render Integration:** Native handling for Octane engine workflows and real-time/pre-rendered dynamic furniture states via Octane Render. +* **Modern Stack:** Entirely free of PHP legacy code, optimized for high throughput and rapid client response times. + +--- + +## ⚠️ Known Issues & Work in Progress (v2) + +While core catalogue functionality, search, and engine integrations are active, please note the following current limitations in the v2 release: + +* **Missing Furniture Interactions:** Some specific furniture items currently lack complete interactive behaviors (e.g., multi-state toggles or complex custom actions). +* **Broken Furniture Definitions:** Certain custom items or broken furniture entries may experience rendering bugs or fail to load correctly. Fixes and updates are continuously being rolled out. --- ## ✨ Features -* **Rock-Solid Stability:** Enhanced core architecture ensures maximum uptime. +* **Rock-Solid Core:** Enhanced base architecture ensuring stability and maximum uptime. * **EPIC WEB CONTROL:** Fully compatible with advanced web control structures for effortless management. -* **Optimized Performance:** Fast loading times for large-scale item catalogues. -* **Clean UI/UX:** Designed to be easy on the eyes and lightweight to navigate. +* **Fast & Fully Functional Search:** Integrated search functionality to instantly locate items across extensive catalogues. +* **Octane Render Pipeline:** Direct rendering pipeline compatibility for accurate item previews and custom graphics. +* **Clean UI/UX:** Designed to be lightweight, responsive, and easy to navigate. --- -## 🛠️ Installation & Setup +## 🛠️ Editions & Architecture -### Prerequisites -Make sure you have the following installed on your environment: -* PHP 8.1 or higher -* MySQL 8.0 or MariaDB equivalent -* A compatible web server (Apache / Nginx) \ No newline at end of file +1. **Full Habbo Edition (Production Ready):** A pure, faithful recreation designed for standard Habbo item structures, offering native integration with Polaris Emulator and complete multi-language support. +2. **Customs Edition (In Active Development):** Tailored specifically for custom furniture, custom badges, and unique Octane Render graphics. Features and custom asset handling are still being completed. + +--- + +## 📋 Prerequisites & Setup + +### Requirements +Make sure you have the following active in your environment: +* **Emulator Environment:** Polaris Emulator running alongside Octane / Octane Render +* **Database:** MySQL 8.0 or MariaDB equivalent +* **Web Server:** A compatible high-performance web server or reverse proxy (e.g., Nginx, Apache) + +### Deployment Steps +1. Select the appropriate branch or directory (`Full Habbo` for production, or `Customs` for development/testing). +2. Ensure your Polaris Emulator / Octane database tables are properly structured. +3. Import the provided catalogue SQL schema into your MySQL/MariaDB database. +4. Configure your core environment variables with your database, language preference, and engine settings. +5. Launch your web server pointing to the project base. \ No newline at end of file