Walidoux
90720c34f9
Update the VSCode settings.json to include the Prettier VSCode formatter, and enable formatting on save. A new LICENSE file is added to comply with the MIT license due to the open-source nature of the project. The README.md file has now core features and to-dos that should be taken care of as the project continues to evolve. The index.html file is modified to match changes in src/index.tsx. The postcss configuration files are created, and some files are updated. Finally, new files like build.rs, draworder.json, and commands.rs were created
61 lines
2.3 KiB
Markdown
61 lines
2.3 KiB
Markdown
# 🧿 Getting started
|
|
|
|
## 🎯 Todos
|
|
|
|
- [ ] Two options for downloading Habbo resources:
|
|
- [ ] Default data extraction. (Without conversion)
|
|
- [ ] Using [Scuti](https://scuti.netlify.app/) dataset for its [renderer.](https://github.com/kozennnn/scuti-renderer)
|
|
- [ ] Languages feature. (Default: EN)
|
|
- [ ] Download Habbo assets. (>800 MB of disk memory, make sure the IPC handles it correctly)
|
|
- [ ] Fix rendering animation issues.
|
|
- [ ] Add "abort" button with written data suppression feature.
|
|
- [x] Convert front-end with SolidJS
|
|
- [x] Fix issue of prettier-plugin-tailwindcss
|
|
|
|
- [ ] Export helpers/utils methods into Rust.
|
|
|
|
- [ ] Implementing typesafety with types' collections using Tauri Specta
|
|
- [ ] Handling extracted data in:
|
|
- [ ] JSON (Default + Adjustements for Scuti)
|
|
- [ ] XML (Using quickxml_to_serde)
|
|
- [ ] TXT (no idea...)
|
|
- [ ] Parsing data using `std::{fs::File, io::Write}`
|
|
|
|
- [ ] Avoid conflicts in open-source.
|
|
- [ ] Undertsand: Memory cache and disk cache.
|
|
|
|
## Overview
|
|
|
|
- [How it works](#🏗️-how-it-works)
|
|
- [Techs stack](#📦-techs-stack)
|
|
- [Interesting topics](#📤-interesting-topics)
|
|
- [Credits](#🤝-credits)
|
|
|
|
## 📦 Techs stack
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 🏗️ How it works
|
|
|
|
### Gamedata/Generic
|
|
|
|
It comes first with fetching data using the `@tauri-apps/api/http` module.
|
|
Converting uncoming data into minified JSON file formats.
|
|
(No need for avro, parquet, protobuf nor CSV for efficient data compression
|
|
and encoding schemas for fast data storing/retrieval)
|
|
|
|
## 📤 Interesting topics
|
|
|
|
### 🦀 Rust-related
|
|
|
|
- [Why serde_json crate is the best choice?](https://blog.logrocket.com/json-and-rust-why-serde_json-is-the-top-choice/)
|
|
|
|
## 🤝 Credits
|
|
|
|
This wouldn't be possible without the help of [KOZEN](https://github.com/kozennnn)'s contribution.
|