1<img align="left" src="https://github.com/raysan5/raylib/blob/master/logo/raylib_logo_animation.gif" width="288px">
2
3**raylib is a simple and easy-to-use library to enjoy videogames programming.**
4
5raylib 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.
6
7*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.*
8
9Ready to learn? Jump to [code examples!](http://www.raylib.com/examples.html)
10
11---
12
13<br>
14
15[![GitHub contributors](https://img.shields.io/github/contributors/raysan5/raylib)](https://github.com/raysan5/raylib/graphs/contributors)
16[![GitHub All Releases](https://img.shields.io/github/downloads/raysan5/raylib/total)](https://github.com/raysan5/raylib/releases)
17[![GitHub commits since tagged version](https://img.shields.io/github/commits-since/raysan5/raylib/3.5.0)](https://github.com/raysan5/raylib/commits/master)
18[![License](https://img.shields.io/badge/license-zlib%2Flibpng-blue.svg)](LICENSE)
19
20[![Chat on Discord](https://img.shields.io/discord/426912293134270465.svg?logo=discord)](https://discord.gg/raylib)
21[![GitHub stars](https://img.shields.io/github/stars/raysan5/raylib?style=social)](https://github.com/raysan5/raylib/stargazers)
22[![Twitter Follow](https://img.shields.io/twitter/follow/raysan5?style=social)](https://twitter.com/raysan5)
23[![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/raylib?style=social)](https://www.reddit.com/r/raylib/)
24
25[![Windows](https://github.com/raysan5/raylib/workflows/Windows/badge.svg)](https://github.com/raysan5/raylib/actions?query=workflow%3AWindows)
26[![Linux](https://github.com/raysan5/raylib/workflows/Linux/badge.svg)](https://github.com/raysan5/raylib/actions?query=workflow%3ALinux)
27[![macOS](https://github.com/raysan5/raylib/workflows/macOS/badge.svg)](https://github.com/raysan5/raylib/actions?query=workflow%3AmacOS)
28[![Android](https://github.com/raysan5/raylib/workflows/Android/badge.svg)](https://github.com/raysan5/raylib/actions?query=workflow%3AAndroid)
29[![WebAssembly](https://github.com/raysan5/raylib/workflows/WebAssembly/badge.svg)](https://github.com/raysan5/raylib/actions?query=workflow%3AWebAssembly)
30
31[![CMakeBuilds](https://github.com/raysan5/raylib/workflows/CMakeBuilds/badge.svg)](https://github.com/raysan5/raylib/actions?query=workflow%3ACMakeBuilds)
32[![Windows Examples](https://github.com/raysan5/raylib/actions/workflows/windows_examples.yml/badge.svg)](https://github.com/raysan5/raylib/actions/workflows/windows_examples.yml)
33[![Linux Examples](https://github.com/raysan5/raylib/actions/workflows/linux_examples.yml/badge.svg)](https://github.com/raysan5/raylib/actions/workflows/linux_examples.yml)
34
35features
36--------
37  - **NO external dependencies**, all required libraries are [bundled into raylib](https://github.com/raysan5/raylib/tree/master/src/external)
38  - Multiple platforms supported: **Windows, Linux, MacOS, RPI, Android, HTML5... and more!**
39  - Written in plain C code (C99) in PascalCase/camelCase notation
40  - Hardware accelerated with OpenGL (**1.1, 2.1, 3.3 or ES 2.0**)
41  - **Unique OpenGL abstraction layer** (usable as standalone module): [rlgl](https://github.com/raysan5/raylib/blob/master/src/rlgl.h)
42  - Multiple **Fonts** formats supported (TTF, XNA fonts, AngelCode fonts)
43  - Multiple texture formats supported, including **compressed formats** (DXT, ETC, ASTC)
44  - **Full 3D support**, including 3D Shapes, Models, Billboards, Heightmaps and more!
45  - Flexible Materials system, supporting classic maps and **PBR maps**
46  - **Animated 3D models** supported (skeletal bones animation) (IQM, glTF)
47  - Shaders support, including model and **postprocessing** shaders.
48  - **Powerful math module** for Vector, Matrix and Quaternion operations: [raymath](https://github.com/raysan5/raylib/blob/master/src/raymath.h)
49  - Audio loading and playing with streaming support (WAV, OGG, MP3, FLAC, XM, MOD)
50  - **VR stereo rendering** support with configurable HMD device parameters
51  - Huge examples collection with [+120 code examples](https://github.com/raysan5/raylib/tree/master/examples)!
52  - Bindings to [+50 programming languages](https://github.com/raysan5/raylib/blob/master/BINDINGS.md)!
53  - **Free and open source**.
54
55raylib uses internally some libraries for window/graphics/inputs management and also to support different fileformats loading, all those libraries are embedded with raylib and are available in [src/external](https://github.com/raysan5/raylib/tree/master/src/external) directory. Check [raylib dependencies](https://github.com/raysan5/raylib/wiki/raylib-dependencies) on [raylib Wiki](https://github.com/raysan5/raylib/wiki) for a detailed list.
56
57basic example
58--------------
59This is a basic raylib example, it creates a window and it draws the text `"Congrats! You created your first window!"` in the middle of the screen. Check this example [running live on web here](https://www.raylib.com/examples/web/core/loader.html?name=core_basic_window).
60```c
61#include "raylib.h"
62
63int main(void)
64{
65    InitWindow(800, 450, "raylib [core] example - basic window");
66
67    while (!WindowShouldClose())
68    {
69        BeginDrawing();
70            ClearBackground(RAYWHITE);
71            DrawText("Congrats! You created your first window!", 190, 200, 20, LIGHTGRAY);
72        EndDrawing();
73    }
74
75    CloseWindow();
76
77    return 0;
78}
79```
80
81build and installation
82----------------------
83
84raylib binary releases for Windows, Linux and macOS are available at the [Github Releases page](https://github.com/raysan5/raylib/releases).
85
86raylib is also available via multiple [package managers](https://github.com/raysan5/raylib/issues/613) on multiple OS distributions.
87
88#### Installing and building raylib via vcpkg
89
90You can download and install raylib using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
91
92      git clone https://github.com/Microsoft/vcpkg.git
93      cd vcpkg
94      ./bootstrap-vcpkg.sh
95      ./vcpkg integrate install
96      vcpkg install raylib
97
98*The raylib port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.*
99
100#### Installing and building raylib via conan
101
102You can download and install raylib using the [conan](https://conan.io) dependency manager:
103
104      https://docs.conan.io/en/latest/getting_started.html
105
106*The raylib recipe in conan is kept up to date by conan team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/conan-io/conan-center-index) on the conan-center-index repository.*
107
108#### Installing and building raylib on multiple platforms
109
110[raylib Wiki](https://github.com/raysan5/raylib/wiki#development-platforms) contains detailed instructions on building and usage on multiple platforms.
111
112 - [Working on Windows](https://github.com/raysan5/raylib/wiki/Working-on-Windows)
113 - [Working on macOS](https://github.com/raysan5/raylib/wiki/Working-on-macOS)
114 - [Working on GNU Linux](https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux)
115 - [Working on FreeBSD](https://github.com/raysan5/raylib/wiki/Working-on-FreeBSD)
116 - [Working on Raspberry Pi](https://github.com/raysan5/raylib/wiki/Working-on-Raspberry-Pi)
117 - [Working for Android](https://github.com/raysan5/raylib/wiki/Working-for-Android)
118 - [Working for Web (HTML5)](https://github.com/raysan5/raylib/wiki/Working-for-Web-(HTML5))
119 - [Working anywhere with CMake](https://github.com/raysan5/raylib/wiki/Working-with-CMake)
120
121*Note that Wiki is open for edit, if you find some issue while building raylib for your target platform, feel free to edit the Wiki or open and issue related to it.*
122
123#### Setup raylib with multiple IDEs
124
125raylib has been developed on Windows platform using [Notepad++](https://notepad-plus-plus.org/) and [MinGW GCC](http://mingw-w64.org/doku.php) compiler but it can be used with other IDEs on multiple platforms.
126
127[Projects directory](https://github.com/raysan5/raylib/tree/master/projects) contains several ready-to-use **project templates** to build raylib and code examples with multiple IDEs.
128
129*Note that there are lots of IDEs supported, some of the provided templates could require some review, please, if you find some issue with some template or you think they could be improved, feel free to send a PR or open a related issue.*
130
131learning and docs
132------------------
133
134raylib is designed to be learned using [the examples](https://github.com/raysan5/raylib/tree/master/examples) as the main reference. There is no standard API documentation but there is a [**cheatsheet**](https://www.raylib.com/cheatsheet/cheatsheet.html) containing all the functions available on the library and a short description of each one of them, input parameters and result value names should be intuitive enough to understand how each function works.
135
136Some additional documentation about raylib design can be found in raylib GitHub Wiki. Here the more relevant links:
137
138 - [raylib cheatsheet](https://www.raylib.com/cheatsheet/cheatsheet.html)
139 - [raylib architecture](https://github.com/raysan5/raylib/wiki/raylib-architecture)
140 - [raylib library design](https://github.com/raysan5/raylib/wiki)
141 - [raylib examples collection](https://github.com/raysan5/raylib/tree/master/examples)
142 - [raylib games collection](https://github.com/raysan5/raylib-games)
143
144
145contact and networks
146---------------------
147
148raylib is present in several networks and raylib community is growing everyday. If you are using raylib and enjoying it, feel free to join us in any of these networks. The most active network is our [Discord server](https://discord.gg/raylib)! :)
149
150 - Webpage: [http://www.raylib.com](http://www.raylib.com)
151 - Discord: [https://discord.gg/raylib](https://discord.gg/raylib)
152 - Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5)
153 - Twitch:  [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5)
154 - Reddit:  [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib)
155 - Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib)
156 - YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/c/raylib)
157
158license
159-------
160
161raylib 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) for further details.
162