Contributing

Coding Style

1. Functions and Classes are always Capitalized. Some libs use camel case (Swoosh and SFML). Tolerate them as much as possible.
2. SOLID principles. I know some classes are not doing this, they should be refactored.
3. Long function names are better than cryptic function names
4. Doxygen-style documentation
5. Unless impossible, code implementation goes in .cpp file and declarations go in .h file.
6. No globals or singleton classes.
7. Prefer elegant design over hacking it together "it just works". This is game engine, so API matters most.
8. Do not abuse auto. I'm guilty of this and am slowly correcting them.

Community

Join the developers and content creators on the discord here

Contributor List

The Battle network games are very precise when it comes to their inner-workings. The engine saw many deep refactors that left me with sleepless nights but it was worth it. I could not have gotten this far without the help from many contributors ranging from code contributions, art, and general battle network knowledge helping me shape this project up and getting closer to the original goals of an accurate and robust engine.

Project Godfather

• Pheelbert - His SFML battle network project started it all. I forked it and he helped me clean up some early code! The tile movement logic is highly borrowed from his designs! The engine has become almost entirely unrecognizable from its origins. If it wasn't for him, this project might not even exist today. Call it the butter-fly effect. 🦋

Content Creator Kings

These top content creators are the reason we have so much cool stuff!

• Kirbyatina - If there's an authentic chip remake, chances are he made it (and he made a LOT!)
• loui - If there's an authentic enemy (including full enemy families), chances are he made it (and he made a LOT!)
• D3str0y3d255 - If there's a playable boss or navi mod, chances are he made it
• Alrysc - Absolutely pushes ONB scripting to its technical limits making unbelievable custom mods
• Hooviey - Pumped out a lot of authentic, custom, and Shanghai.EXE mod content!
• Rune - Made a lot of official BN3 and BN6 chips and enemies!

Tech Wizards

These members helped me with code!

• Mars - For several initial years of the project, Mars provided valuable insight to make the battle system accurate. I could not have gotten as close to accurate as I did without his crucial help up to v2 release in January 2022. Thank you, Mars for that time you gave me.
• Pion - A lot of scripting support fixes in C++, title screen, web Lua API documentation!!
• Keristero - EZ Scripts for EZ overworld and quest building. Gung-ho community creator. Mod scraping tool for easy navigation of mods available on a website. So much content is possible because of Keristero. Thank you!!
• Weenie - Investigated and delivered security concerns in lua LOADK and minizip's file extraction that could be exploited. Helped discuss and implement UTF-8 filepath and string support into the engine
• Konstinople - Improved my server by designing his own scriptable overworld server complete with integration with my existing engine. Helped me undertake one of the many major refactors required for the engine. Helped with debugging as well. Thank you.
• Alrysc - Quality Assurance by testing the engine to its limits via EXTREME lua scripting. He has found many breaking bugs that helped address and fix the engine's robustness.

Notable Community Mentions

These members stand out above the rest!

• DJRezzed - Almost all sfx and sound provided by DJ. PET menu sprites and custom menu sprites. Custom app icons!
• D3str0y3d255 - Owner of 7 servers (and counting). Admin and Moderator.
• Knight Forte - Discord Community Admin & Moderator
• Caos - Discord Moderator
• Kirbyatina - Discord Moderator
• Kuri - Discord Moderator
• FrozenLake - chronological documentation of many mechanics throughout the series

Discord Boosters

These members made our community discord GREAT!

• Augatillo
• Kirbyatina
• Knight Emperor Forte
• Quetzen
• Keristero

And A Special Thanks To:

• Claris
• Shale
• Dunstant
• Mint
• Gray Nine
• Zeek
• Salad
• CosmicNobab
• OuroYisus
• Kuri
• jontheburger
• Gemini
• Poly
• Yaz_
• BlaXun
• SusThor
• SCA
• Beaned

I can't fit everyone who has helped in smaller but important capacities. So to all other contributors, mod content creators, and community members on here, THANK YOU!