4c8b770992
Addressed review comments Addressed review comments Changed NOLINTBEGIN/END to NOLINTNEXTLINE Addressed CI complaint Fixed BSD CI issues |
||
|---|---|---|
| .github | ||
| cmake | ||
| doc | ||
| examples | ||
| extlibs | ||
| include/SFML | ||
| src/SFML | ||
| test | ||
| tools | ||
| .clang-format | ||
| .clang-tidy | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| changelog.md | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| license.md | ||
| readme.md | ||
SFML — Simple and Fast Multimedia Library
SFML is a simple, fast, cross-platform and object-oriented multimedia API. It provides access to windowing, graphics, audio and network. It is written in C++, and has bindings for various languages such as C, .Net, Ruby, Python.
State of Development
SFML is currently in an interesting state of development, which can quickly become confusing if you aren't following it closely. As such we want to clarify where to get which version.
- The
masterbranch contains work in progress for the next major version SFML 3. As such it's considered unstable, but any testing and feedback is highly appreciated. - The
2.6.xbranch is the nearly complete next minor version SFML 2.6, which should be very stable, even if it hasn't been officially released yet. - The
2.5.1tag is the last official SFML release, but it lacks a lot of fixes and features that can already be found on the2.6.xbranch.
Download
- You can get the latest official release on SFML's website.
- You can also get the source code of the current development version from the Git repository.
- Alternatively, you can get the latest snapshot / artifact builds from the artifacts storage.
Install
Follow the instructions of the tutorials, there is one for each platform/compiler that SFML supports.
Learn
There are several places to learn SFML:
- The official tutorials
- The online API documentation
- The community wiki
Community
Here are some useful community links:
Contribute
SFML is an open-source project, and it needs your help to go on growing and improving. If you want to get involved and suggest some additional features, file a bug report or submit a patch, please have a look at the contribution guidelines.
Authors
- Laurent Gomila (laurent@sfml-dev.org)
- Marco Antognini (hiura@sfml-dev.org)
- binary1248 (binary1248@hotmail.com)
- Lukas Dürrenberger (eXpl0it3r@sfml-dev.org)
- Jonathan De Wachter (dewachter.jonathan@gmail.com)
- Jan Haller (bromeon@sfml-dev.org)
- Mario Liebisch (mario@sfml-dev.org)
- Stefan Schindler (tank@sfml-dev.org)
- Artur Moreira (artturmoreira@gmail.com)
- Vittorio Romeo (vittorioromeo@sfml-dev.org)
- Chris Thrasher (thrasher@sfml-dev.org)
- And many other members of the SFML community
License
The SFML libraries and source code are distributed under the zlib/libpng license. See license.md. External libraries used by SFML are distributed under their own licenses.
In short, SFML is free for any use (commercial or personal, proprietary or open-source). You can use SFML in your project without any restriction. You can even omit to mention that you use SFML -- although it would be appreciated.
External libraries used by SFML
- OpenAL-Soft is under the LGPL license
- stb_image and stb_image_write are public domain
- freetype is under the FreeType license or the GPL license
- libogg is under the BSD license
- libvorbis is under the BSD license
- libflac is under the BSD license
- minimp3 is under the CC0 license