You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

76 lines
4.3 KiB

7 years ago
7 years ago
7 years ago
10 years ago
7 years ago
7 years ago
8 years ago
7 years ago
7 years ago
8 years ago
7 years ago
7 years ago
8 years ago
8 years ago
7 years ago
7 years ago
10 years ago
7 years ago
7 years ago
8 years ago
  1. <img align="left" src="https://github.com/raysan5/raylib/blob/master/logo/logo256x256.png" width=256>
  2. **raylib is a simple and easy-to-use library to learn videogames programming.**
  3. raylib is highly inspired by Borland BGI graphics lib and by XNA framework.
  4. raylib could be useful for prototyping, tools development, graphic applications, embedded systems and education.
  5. NOTE for ADVENTURERS: raylib is a programming library to learn videogames programming;
  6. no fancy interface, no visual helpers, no auto-debugging... just coding in the most
  7. pure spartan-programmers way. Are you ready to learn? Jump to [code examples!](http://www.raylib.com/examples.html)
  8. [![Build Status](https://travis-ci.org/raysan5/raylib.svg?branch=develop)](https://travis-ci.org/raysan5/raylib)
  9. features
  10. --------
  11. * Written in plain C code (C99) in PascalCase/camelCase notation
  12. * Hardware accelerated with OpenGL (1.1, 2.1, 3.3 or ES2)
  13. * Unique OpenGL abstraction layer (usable as standalone module): [rlgl](https://github.com/raysan5/raylib/blob/master/src/rlgl.c)
  14. * Powerful fonts module with SpriteFonts support (XNA bitmap fonts, AngelCode fonts, TTF)
  15. * Outstanding texture formats support, including compressed formats (DXT, ETC, PVRT, ASTC)
  16. * Basic 3d support for Geometrics, Models, Billboards, Heightmaps and Cubicmaps
  17. * Flexible Materials system, supporting classic maps and PBR maps
  18. * Shaders support, including Model shaders and Postprocessing shaders
  19. * Powerful math module for Vector, Matrix and Quaternion operations: [raymath](https://github.com/raysan5/raylib/blob/master/src/raymath.h)
  20. * Audio loading and playing with streaming support (WAV, OGG, FLAC, XM, MOD)
  21. * Multiple platforms support: Windows, Linux, Mac, **Android**, **Raspberry Pi** and **HTML5**
  22. * VR stereo rendering support with configurable HMD device parameters
  23. * Minimal external dependencies (GLFW3, OpenGL, OpenAL)
  24. * Complete bindings to LUA ([raylib-lua](https://github.com/raysan5/raylib-lua)) and Go ([raylib-go](https://github.com/gen2brain/raylib-go))
  25. raylib uses on its core module the outstanding [GLFW3](http://www.glfw.org/) library. The best option I found for
  26. multiplatform (Windows, Linux, Mac) window/context and input management (clean, focused, great license, well documented, modern, maintained, ...).
  27. raylib uses on its [audio](https://github.com/raysan5/raylib/blob/master/src/audio.c) module, [OpenAL Soft](http://kcat.strangesoft.net/openal.html) audio library, in multiple flavours,
  28. to accomodate to Android, Raspberry Pi and HTML5.
  29. *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.*
  30. *On Raspberry Pi, Videocore API and EGL libraries are used for window/context management and raw inputs reading.*
  31. building
  32. --------
  33. For detailed building instructions, check [raylib Wiki](https://github.com/raysan5/raylib/wiki).
  34. raylib has been developed using exclusively two tools:
  35. * Notepad++ (text editor) - [http://notepad-plus-plus.org/](http://notepad-plus-plus.org/)
  36. * MinGW (GCC compiler) - [http://www.mingw.org/](http://www.mingw.org/)
  37. Those are the tools recommended to develop with raylib, in fact, those are the tools my students use.
  38. contact
  39. -------
  40. * Webpage: [http://www.raylib.com](http://www.raylib.com)
  41. * Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5)
  42. * Facebook: [http://www.facebook.com/raylibgames](http://www.facebook.com/raylibgames)
  43. * Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib)
  44. * Twitch: [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5)
  45. * Patreon: [https://www.patreon.com/raysan5](https://www.patreon.com/raysan5)
  46. * YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/channel/UC8WIBkhYb5sBNqXO1mZ7WSQ)
  47. If you are using raylib and you enjoy it, please, [let me know][raysan5].
  48. If you feel you can help, then, [helpme!](http://www.raylib.com/helpme.html)
  49. license
  50. -------
  51. 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](LICENSE.md) for further details.
  52. [raysan5]: mailto:ray@raylib.com "Ramon Santamaria - Ray San"