From 96f057ad77ffce9a3ebfbbb6fc102b99d86167d8 Mon Sep 17 00:00:00 2001 From: gucio321 Date: Tue, 3 Dec 2024 19:19:03 +0100 Subject: [PATCH] add some docs --- docs/project-toughts.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/project-toughts.md diff --git a/docs/project-toughts.md b/docs/project-toughts.md new file mode 100644 index 00000000..939af8b4 --- /dev/null +++ b/docs/project-toughts.md @@ -0,0 +1,22 @@ +# Intro + +Hi everyone! +This file was created by [@gucio321](https://github.com/gucio321) and it was not a part of +the original prject. I just wanted to share my thoughts about this project, what am I planning to do here +(or rather what should be done here if I had more time - I don't believe I'll be able to do it myself). + +# HellSpawner & AbyssEngine + +My idea is to abandon the initial idea of AbyssEngine. +In my opinion It'd be better to do a tuned, step-by-step migration from current hard-coded OpenDiablo2 to the +desired state where the engine is fully configurable by HellSpawner. + +# Roadmap + +In this section I'm going to discuss overall what should be done on hellspawner and od2 in a general steps. + +- [ ] Clean up HellSpawner a bit (this project died when there was giu v0.4.x (or something) and now it is giu v0.11.0 - we did much on giu-side since that). + Especially things like hardcoded IDs and so on could be removed from this project (this will remove hundreds of code lines) +- [ ] Clean up OpenDiablo2. This project also was left long time ago so ebiten had several releases since that. +- [ ] Create a project decoder and extend the current Project type. +- [ ] Rewrite things from od2 to the new project decoder.