raylib/README.md
2020-03-21 13:22:06 +01:00

6.6 KiB

raylib is a simple and easy-to-use library to enjoy videogames programming.

raylib is highly inspired by Borland BGI graphics lib and by XNA framework and it's specially well suited for prototyping, tooling, graphical applications, embedded systems and education.

NOTE for ADVENTURERS: raylib is a programming library to enjoy videogames programming; no fancy interface, no visual helpers, no auto-debugging... just coding in the most pure spartan-programmers way.

Ready to learn? Jump to code examples!


GitHub commit activity GitHub contributors GitHub commits since tagged version GitHub All Releases GitHub stars License

Chat on Discord Twitter Follow Subreddit subscribers

TravisCI Build Status https://ci.appveyor.com/api/projects/status/github/raysan5/raylib?svg=true

Actions Status Actions Status Actions Status

features

  • NO external dependencies, all required libraries are bundled into raylib
  • Multiple platforms supported: Windows, Linux, MacOS, Android, HTML5... and more!
  • Written in plain C code (C99) in PascalCase/camelCase notation
  • Hardware accelerated with OpenGL (1.1, 2.1, 3.3 or ES 2.0)
  • Unique OpenGL abstraction layer (usable as standalone module): rlgl
  • Multiple Fonts formats supported (TTF, XNA fonts, AngelCode fonts)
  • Outstanding texture formats support, including compressed formats (DXT, ETC, ASTC)
  • Full 3D support, including 3D Shapes, Models, Billboards, Heightmaps and more!
  • Flexible Materials system, supporting classic maps and PBR maps
  • Animated 3D models supported (skeletal bones animation)
  • Shaders support, including model and postprocessing shaders.
  • Powerful math module for Vector, Matrix and Quaternion operations: raymath
  • Audio loading and playing with streaming support (WAV, OGG, MP3, FLAC, XM, MOD)
  • VR stereo rendering support with configurable HMD device parameters
  • Huge examples collection with +115 code examples!
  • Bindings to +40 programming languages!

raylib uses on its core module the outstanding GLFW3 library, embedded in the form of rglfw module, to avoid external dependencies.

raylib uses on its raudio module, the amazing miniaudio library to support multiple platforms and multiple audio backends.

raylib uses internally several single-file header-only libraries to support different fileformats loading and saving, all those libraries are embedded with raylib and available in src/external directory. Check raylib Wiki for a detailed list.

On Android platform, native_app_glue module (provided by Android NDK) and native Android libraries are used to manage window/context, inputs and activity life cycle.

On Raspberry Pi platform (native mode), Videocore API and EGL libraries are used for window/context management. Inputs are processed using evdev Linux libraries

On Web platform, raylib uses emscripten provided libraries for several input events management, specially noticeable the touch events support.

build and installation

raylib binary releases for Windows, Linux and macOS are available at the Github Releases page. raylib is also available via multiple package managers on multiple OS distributions.

raylib has been developed on Windows platform using Notepad++ and MinGW GCC compiler but it can be used with multiple IDEs on multiple platforms, projects directory contains several ready-to-use project templates to build raylib and code examples.

raylib Wiki contains detailed instructions on building and usage on multiple platforms.

contact

If you are using raylib and enjoying it, please, join our Discord server and let us know! :)

license

raylib is licensed under an unmodified zlib/libpng license, which is an OSI-certified, BSD-like license that allows static linking with closed source software. Check LICENSE for further details.