raylib/README.md

82 lines
6.0 KiB
Markdown
Raw Normal View History

2018-02-12 13:53:47 +03:00
<img align="left" src="https://github.com/raysan5/raylib/blob/master/logo/raylib_256x256.png" width=256>
2018-09-09 18:36:24 +03:00
**raylib is a simple and easy-to-use library to enjoy videogames programming.**
2019-04-23 16:22:20 +03:00
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.
2017-07-25 12:40:04 +03:00
2019-05-27 16:31:57 +03:00
*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.*
2019-03-25 12:12:38 +03:00
Ready to learn? Jump to [code examples!](http://www.raylib.com/examples.html)
2014-12-31 21:25:50 +03:00
[![Build Status](https://travis-ci.org/raysan5/raylib.svg?branch=master)](https://travis-ci.org/raysan5/raylib)
2017-11-23 12:14:53 +03:00
[![https://ci.appveyor.com/api/projects/status/github/raysan5/raylib?svg=true](https://ci.appveyor.com/api/projects/status/github/raysan5/raylib?svg=true)](https://ci.appveyor.com/project/raysan5/raylib)
2019-04-27 23:42:22 +03:00
[![Chat on Discord](https://img.shields.io/discord/426912293134270465.svg?logo=discord)](https://discord.gg/VkzNHUE)
2020-01-07 18:45:17 +03:00
[![License](https://img.shields.io/badge/license-zlib%2Flibpng-blue.svg)](LICENSE)
2017-11-24 14:40:08 +03:00
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow)](https://twitter.com/raysan5)
2020-01-10 15:45:30 +03:00
[![Actions Status](https://github.com/raysan5/raylib/workflows/CI%20-%20Source%20&%20Examples%20-%20Windows/badge.svg)](https://github.com/raysan5/raylib/actions)
[![Actions Status](https://github.com/raysan5/raylib/workflows/CI%20-%20Source%20&%20Examples%20-%20Linux/badge.svg)](https://github.com/raysan5/raylib/actions)
[![Actions Status](https://github.com/raysan5/raylib/workflows/CI%20-%20Source%20&%20Examples%20-%20macOS/badge.svg)](https://github.com/raysan5/raylib/actions)
features
--------
2019-03-25 12:12:38 +03:00
- **NO external dependencies**, all required libraries are bundled into raylib
2018-07-16 03:07:48 +03:00
- Multiple platforms supported: **Windows, Linux, MacOS, Android... and many 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](https://github.com/raysan5/raylib/blob/master/src/rlgl.h)
2019-05-27 16:25:41 +03:00
- Multiple **Fonts** formats supported (XNA fonts, AngelCode fonts, TTF)
2018-07-16 03:07:48 +03:00
- Outstanding texture formats support, including compressed formats (DXT, ETC, ASTC)
2019-03-25 12:12:38 +03:00
- **Full 3D support**, including 3D Shapes, Models, Billboards, Heightmaps and more!
2018-07-16 03:07:48 +03:00
- Flexible Materials system, supporting classic maps and **PBR maps**
2019-05-27 16:25:41 +03:00
- **Animated 3D models** supported (skeletal bones animation)
- Shaders support, including model and postprocessing shaders.
2018-07-16 03:07:48 +03:00
- **Powerful math module** for Vector, Matrix and Quaternion operations: [raymath](https://github.com/raysan5/raylib/blob/master/src/raymath.h)
- Audio loading and playing with streaming support (WAV, OGG, MP3, FLAC, XM, MOD)
- **VR stereo rendering** support with configurable HMD device parameters
2019-05-27 16:25:41 +03:00
- Huge examples collection with [+95 code examples](https://www.raylib.com/examples.html)!
- Bindings to [+25 programming languages](https://github.com/raysan5/raylib/blob/master/BINDINGS.md)!
2019-05-27 16:31:57 +03:00
raylib uses on its [core](https://github.com/raysan5/raylib/blob/master/src/core.c) module the outstanding [GLFW3](http://www.glfw.org/) library, embedded in the form of [rglfw](https://github.com/raysan5/raylib/blob/master/src/rglfw.c) module, to avoid external dependencies.
2019-05-27 16:25:41 +03:00
raylib uses on its [raudio](https://github.com/raysan5/raylib/blob/master/src/raudio.c) module, the amazing [miniaudio](https://github.com/dr-soft/miniaudio) library to support multiple platforms and multiple audio backends.
2018-02-20 13:04:02 +03:00
2019-05-27 16:25:41 +03:00
raylib uses internally multiple single-file header-only libraries to support different fileformats loading and saving, all those libraries are embedded with raylib and available in [src/external](https://github.com/raysan5/raylib/tree/master/src/external) directory. Check [raylib Wiki](https://github.com/raysan5/raylib/wiki/raylib-dependencies) for a detailed list.
2019-04-23 16:22:20 +03:00
*On Android platform, `native_app_glue module` module (provided by Android NDK) and native Android libraries are used to manage window/context, inputs and activity life cycle.*
2019-04-23 16:22:20 +03:00
*On Raspberry Pi platform (native mode), `Videocore API` and `EGL` libraries are used for window/context management. Inputs are processed using `evdev` Linux libraries*
build and installation
----------------------
2019-04-23 16:22:20 +03:00
Binary releases for Windows, Linux and macOS are available at the [Github Releases page](https://github.com/raysan5/raylib/releases). raylib is also available via multiple package managers on multiple OS distributions. Check [raylib Wiki](https://github.com/raysan5/raylib/wiki) for more info.
2019-03-25 12:12:38 +03:00
If you wish to build raylib yourself, [the raylib Wiki](https://github.com/raysan5/raylib/wiki) also contains detailed instructions on how to approach that.
2019-04-23 16:22:20 +03:00
raylib has been developed using two tools:
2019-03-25 12:12:38 +03:00
* Notepad++ (text editor) - [http://notepad-plus-plus.org](http://notepad-plus-plus.org/)
* MinGW (GCC compiler) - [http://www.mingw.org](http://www.mingw.org/)
2019-04-23 16:22:20 +03:00
Those are the tools recommended to enjoy raylib development.
contact
-------
* Webpage: [http://www.raylib.com](http://www.raylib.com)
2019-04-23 16:22:20 +03:00
* Discord: [https://discord.gg/raylib](https://discord.gg/VkzNHUE)
* Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5)
2016-02-21 04:27:34 +03:00
* Twitch: [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5)
2019-05-27 16:25:41 +03:00
* Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib)
2018-04-23 21:59:10 +03:00
* Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib)
* YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/channel/UC8WIBkhYb5sBNqXO1mZ7WSQ)
2019-04-23 16:22:20 +03:00
If you are using raylib and you enjoy it, please, join our [Discord server](https://discord.gg/VkzNHUE).
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](LICENSE.md) for further details.