thunderbrewhq/squall
1
0
Fork 0
mirror of https://github.com/thunderbrewhq/squall.git synced 2026-02-04 00:49:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update README

Browse source
This commit is contained in:
fallenoak 2025-09-01 15:20:00 -05:00
parent ae1bd8f92c
commit c0dd80376d
No known key found for this signature in database
GPG key ID: 7628F8E61AEA070D
1 changed files with 32 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,7 +1,7 @@
# Squall # Squall
Squall is an unofficial open source implementation of the Storm standard Squall is an unofficial open source implementation of the Storm standard
library circa 2010. library.
The Storm standard library is a collection of data structures and functions The Storm standard library is a collection of data structures and functions
created by the talented folks at Blizzard Entertainment for use in their created by the talented folks at Blizzard Entertainment for use in their
@ -11,11 +11,30 @@ 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 version used in the final release build of World of Warcraft: Wrath of the
Lich King in 2010: 3.3.5a (12340). Lich King in 2010: 3.3.5a (12340).
Squall also attempts to provide versions of Storm that work with other
projects centered around classic Blizzard games, like
[Starsurgical](https://github.com/Starsurgical). Note that Squall does not
natively support being built as a dynamic library, although it may support
such scenarios in the future.
In the spirit of documenting what is presumed to have existed at the time, 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 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 side effects of the original implementation of Storm. At the same time, it
attempts to ensure portability and compatibility with modern 64-bit systems. attempts to ensure portability and compatibility with modern 64-bit systems.
## Storm Flavors
Squall supports different flavors depending on the type of project consuming
it. These flavors can be configured by setting a CMake variable called
`WHOA_STORM_FLAVOR`:
- `WOW`: Ensures the resulting build is compatible with World of Warcraft
3.3.5a (12340)
- `SC1`: Ensures the resulting build is compatible with StarCraft 1.16/1.17
Flavors control groups of behavior-related defines. These defines can be used
on their own if the groups defined by the flavors are not desired.
## FAQ ## FAQ
**Why?** **Why?**
@ -23,25 +42,29 @@ attempts to ensure portability and compatibility with modern 64-bit systems.
It's fascinating to explore the development practices used to build a modern It's fascinating to explore the development practices used to build a modern
major video game. major video game.
**Why 3.3.5a?** **Why does Squall focus on specific game versions?**
The game and its libraries have become significantly more complex in the Storm changed a lot over the years it was used. By focusing on specific
intervening 10+ years. By picking 3.3.5a, it's possible to imagine this versions of the games that used Storm, it's possible to imagine this
implementation will eventually be complete. implementation will eventually be complete.
**Will this let me cheat in the game?** **Will this let me cheat in a game?**
No. Storm is a standard library, and none of its routines are particularly No. Storm is a standard library, and none of its routines are particularly
relevant to the anti-cheat measures found in the game. relevant to the anti-cheat measures found in the games that used it.
**Can I use this in my own development projects?** **Can I use this in my own development projects?**
It's probably a bad idea. The original library remains closed source, and this Maybe. Keep in mind the original library remains closed source and this
project is in no way official. project is in no way sanctioned or official. Also keep in mind that C++, its
standard library, and OS-provided capabilities like memory management,
networking stacks, and rendering frameworks have substantially improved since
the 1990s-2010.
## Legal ## Legal
This project is released into the public domain. This project is released into the public domain. No claim is made to any
intellectual property contained in this project.
World of Warcraft: Wrath of the Lich King ©2008 Blizzard Entertainment, Inc. 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 All rights reserved. Wrath of the Lich King is a trademark, and World of