Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.58 KB

README.md

File metadata and controls

60 lines (46 loc) · 2.58 KB
Raw

rust-sfml crates.io docs.rs Discord

Rust bindings for SFML, the Simple and Fast Multimedia Library.

Platform support

Platform Development and testing CI (basic tests)
🐧 Linux ✅ Most tested Status
🪟 Windows (MSVC) ⚠️ Rarely tested. Looking for testers/maintainers! Status
🐧 -> 🪟 (mingw-w64) ⚠️ Cross-compile from Linux to Windows. Somewhat tested. ❌
🍎 Mac OS X ❌ Untested. Looking for testers/maintainers! Status

Prerequisites

  • Rust 1.82 or later
  • CMake, and a C++ toolchain for building SFML
  • 🐧 On Linux, you need the following dependencies installed:
    • Window module: libGL libX11 libXcursor libXrandr
    • Graphics module: libfreetype
    • Audio module: libopenal libvorbisenc libvorbisfile libvorbis

Documentation

The API documentation is available at: https://docs.rs/sfml/

If you need help with setting up rust-sfml on your system, you can take a look at the wiki.
Please take note that:

  • This wiki is supported by the community
  • The rust-sfml core team doesn't review it
  • Your contribution is welcome

License

This software is a binding of the SFML library created by Laurent Gomila, which is provided under the Zlib/png license.

This software is provided under the same license as SFML, the Zlib/png license.

Discord

rust-sfml users are welcome on the Official SFML Discord server