raylib/README.md

4.0 KiB

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

raylib is highly inspired by Borland BGI graphics lib and by XNA framework.

raylib could be useful for prototyping, tools development, graphic applications, embedded systems and education.

NOTE for ADVENTURERS: raylib is a programming library to learn videogames programming; no fancy interface, no visual helpers, no auto-debugging... just coding in the most pure spartan-programmers way. Are you ready to learn? Jump to code examples!

features

  • Written in plain C code (C99) in PascalCase/camelCase notation
  • Hardware accelerated with OpenGL (1.1, 2.1, 3.3 or ES2)
  • Unique OpenGL abstraction layer (usable as standalone module): rlgl
  • Powerful fonts module with SpriteFonts support (XNA bitmap fonts, AngelCode fonts, TTF)
  • Outstanding texture formats support, including compressed formats (DXT, ETC, PVRT, ASTC)
  • Basic 3d support for Geometrics, Models, Billboards, Heightmaps and Cubicmaps
  • Flexible Materials system, supporting classic maps and PBR maps
  • Shaders support, including Model shaders and Postprocessing shaders
  • Powerful math module for Vector, Matrix and Quaternion operations: raymath
  • Audio loading and playing with streaming support (WAV, OGG, FLAC, XM, MOD)
  • Multiple platforms support: Windows, Linux, Mac, Android, Raspberry Pi and HTML5
  • VR stereo rendering support with configurable HMD device parameters
  • Minimal external dependencies (GLFW3, OpenGL, OpenAL)
  • Complete bindings to LUA (raylib-lua) and Go (raylib-go)

raylib uses on its core module the outstanding GLFW3 library. The best option I found for multiplatform (Windows, Linux, Mac) window/context and input management (clean, focused, great license, well documented, modern, maintained, ...).

raylib uses on its audio module, OpenAL Soft audio library, in multiple flavours, to accomodate to Android, Raspberry Pi and HTML5.

On Android, 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, Videocore API and EGL libraries are used for window/context management and raw inputs reading.

building

For detailed building instructions, check raylib Wiki.

raylib has been developed using exclusively two tools:

Those are the tools recommended to develop with raylib, in fact, those are the tools my students use.

contact

If you are using raylib and you enjoy it, please, let me know.

If you feel you can help, then, helpme!

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.