alfredcox/springstory

v95 shroom simulator implemented via SpringBoot and java 21

🍁 SpringStory

Java 21.0.1 SpringBoot Server simulator for a v95 Shroom game.

🧾 Requirements

• JDK 21+ (recommend JDK 21.0.1).
• MySQL Server (currently working with mySQL server 8).

📦 Setup (Windows)

1. Download the src (recommend downloading master -> LTS).
2. Download MySQL server and set the password to be admin (if you want to set different password you just need to update the application.properties).
3. Open your favorite mySQL workbench (I use intellJ ultimate to connect to the DB).
4. Add new Schema called SpringStory (in the DB).
5. Create in the src a new Dir called wz and dump all the wz files into img files (you can use WzDumper).
6. Run InitServer and let the server start generate the json folder with all the jsons data files.
7. Download the v95 client files (Download Link).
8. Open the Hendi v95 localhost (Download Link).
9. Login via Admin account -

   Username: admin

   Password: admin

🎯 Feature List

• Auto DB tables creation and mapping by @Entity classes (No more sql scripts to execute before start running the server).
• Service classes for each Table (No more old school queries / sql statements for CRUD operations!).
• WZ -> JSON files conversion (easier files reading and management / readability).
• Parallel data loading for faster server loading.
• Event Driven approach for the game loop utilizing java 21 Virtual Threads (EventManager.java).
• Reflection base handling to packets (Swordie style for much cleaner code / better performances imo).
• Reflection base Commands handling (method base rather than Swordie inner static classes).
• Custom Auto set of key mapping (hated to manually set my keybinding each time so the default is my preferred key binds).
• Generic handling for all the classes buffs skills (no more class for each class to duplicate bunch of code to handle tempStats!).
  • Hot swap / reload ability for the tempStat handling - after handling a skill the server don't need a restart!
• Custom Logger (made my own for better logs clarity to me, it's not optimized what-so-ever, but it's easier to develop that way to me).
• Hotswap - Java / intellJ can be awesome so enjoy its features xD
• Java + reflection base NPC scripting! (no more weird written and complex scripts)
• Auto Register system to create new accounts.
• Map/Item/Skill/Mobs search by name query based for better performances and nice utility to have.
• Graceful shutdown.
• Map caching & unloading after x amount of time for better memory management.
• More cool stuff that I'm probably just don't remember xD

💻 Personal Note

This project is for learning and fun, I'm planing to continue work on, so it will be continued to be updated but not consistently. Part of my plan was to suggest another way to go about creating a server and give good base for anyone that was to build on it with more updated and better performances.

⭐️ Acknowledgements

• RustMS - Joo is the goat ❤
• MAO Channel Server - Chronos the Kotlin god ❤
• Edelstein - Got a lot of references packets handling from here. (Kairou thanks!)
• Rebirth - Got a lot of references packets & tempStats handling from here. (Minimum Delta & Rajan Grewal thanks for being a legacy)
• Moe Script API - Got cool ideas for my NPC scripting 😊
• Swordie - Swordie gave me a lot of ideas on the architecture I went with in this project 🔥