From d0487caba3e68076faf7e6733c21207102267525 Mon Sep 17 00:00:00 2001 From: fallenoak Date: Tue, 8 Sep 2020 23:03:57 -0500 Subject: [PATCH] chore: add README --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d9e38bd --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Storm + +This project is an unofficial open source implementation of the Storm standard +library circa 2010. + +The Storm standard library is a collection of data structures and functions +created by the talented folks at Blizzard Entertainment for use in their +games. + +This project attempts to provide a version of Storm compatible with the +version used in the final release build of World of Warcraft: Wrath of the +Lich King in 2010: 3.3.5a (12340). + +In the spirit of documenting what is presumed to have existed at the time, +this project makes every attempt to maintain the canonical names, layouts, and +side effects of the original implementation of Storm. At the same time, it +attempts to ensure portability and compatibility with modern 64-bit systems. + +## FAQ + +**Why?** + +It's fascinating to explore the development practices used to build a modern +major video game. + +**Why 3.3.5a?** + +The game and its libraries have become significantly more complex in the +intervening 10+ years. By picking 3.3.5a, it's possible to imagine this +implementation will eventually be complete. + +**Will this let me cheat in the game?** + +No. Storm is a standard library, and none of its routines are particularly +relevant to the anti-cheat measures found in the game. + +**Can I use this in my own development projects?** + +It's probably a bad idea. The original library remains closed source, and this +project is in no way official. + +## Legal + +This project is released into the public domain. + +World of Warcraft: Wrath of the Lich King ©2008 Blizzard Entertainment, Inc. +All rights reserved. Wrath of the Lich King is a trademark, and World of +Warcraft, Warcraft and Blizzard Entertainment are trademarks or registered +trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.