SDfmL/DOCUMENTATION.md

40 lines
1.2 KiB
Markdown
Raw Normal View History

2022-02-20 03:03:12 +00:00
# 🤨
2022-02-13 07:04:14 +00:00
A wrapper build around SDL2, some of its libraries, and SoLoud to make a lot of stuff
more easier to use.
Stuff like:
2022-02-15 01:11:07 +00:00
2022-02-13 07:04:14 +00:00
- Rendering functions
- Object system
- Sound
- Configuration
- Less dll binary clutter!
2022-02-20 03:03:12 +00:00
- and most possibly, more.... idk.
2022-02-13 07:04:14 +00:00
2022-02-20 03:03:12 +00:00
## Requirements
2022-02-13 07:04:14 +00:00
2022-02-20 03:03:12 +00:00
- [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)
2022-02-13 07:04:14 +00:00
2022-02-20 06:04:06 +00:00
## Compiler Requirements
2022-02-15 01:11:07 +00:00
2022-02-20 03:03:12 +00:00
- 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))
2022-02-13 07:04:14 +00:00
2022-02-20 06:04:06 +00:00
## Instructions
2022-02-13 07:04:14 +00:00
2022-02-20 03:03:12 +00:00
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.
2022-02-13 07:04:14 +00:00
2022-02-15 01:11:07 +00:00
`src/Main.cpp` should contain example code with some explanations.
2022-02-20 06:10:56 +00:00
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.