mirror of https://github.com/haya3218/SDfmL.git
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# 🤨
|
|
|
|
A wrapper build around SDL2, some of its libraries, and SoLoud to make a lot of stuff
|
|
more easier to use.
|
|
|
|
Stuff like:
|
|
|
|
- Rendering functions
|
|
- Object system
|
|
- Sound
|
|
- Configuration
|
|
- Less dll binary clutter!
|
|
- and most possibly, more.... idk.
|
|
|
|
## Requirements
|
|
|
|
- [CMake](https://cmake.org) version 3.10 or above
|
|
- [SDL2 and SDL_ttf 2.0](https://libsdl.org)
|
|
- [SDL_gpu](https://github.com/grimfang4/sdl-gpu)
|
|
- [SoLoud](https://github.com/haya3218/soloud) (static library)
|
|
- [LuaJIT](http://luajit.org)
|
|
|
|
## Compiler Requirements
|
|
|
|
- VC++ (MSVC) version 14.2 or above
|
|
(GCC, clang, and MingW-w64 are not supported yet, [but feel free to make a pull request!](https://github.com/haya3218/SDfmL/compare))
|
|
|
|
## Instructions
|
|
|
|
Copy all of the library files to the `lib/` folder.
|
|
Reminder that ALL header files are already included, so you don't need to worry about linker issues.
|
|
|
|
`src/Main.cpp` should contain example code with some explanations.
|
|
|
|
Run `cmake` in any kind of way to build the program (most recommended is `cmake -B build -DCMAKE_BUILD_TYPE=Release -G "NMake Makefiles"`) and give yourself a pat in the back for building it.
|
|
|
|
## Documentation?
|
|
|
|
Not now. Most likely when the framework actually reaches a stable 1.0 release.
|