raylib README

The project's README from github.com/raysan5/raylib. As one markdown file: README.md.

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 especially 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 debug button... just coding in the most pure spartan-programmers way.

Ready to learn? Jump to code examples!


GitHub Releases Downloads GitHub Stars GitHub commits since tagged version GitHub Sponsors Packaging Status License

Discord Members Reddit Static Badge Youtube Subscribers Twitch Status

Build Windows Build Linux Build macOS Build WebAssembly

Build CMake Build examples Windows Build examples Linux

features

limitations

raylib presents some limitation by design for code simplicity, some forks, alternatives and samples are available to overcome most of them but it's up to the users to modify the library for their specific needs.

basic example

This is a basic raylib example, it creates a window and draws the text "Congrats! You created your first window!" in the middle of the screen. Check this example running live on web here.

#include "raylib.h"

int main(void)
{
    InitWindow(800, 450, "raylib example - basic window");

    while (!WindowShouldClose())
    {
        BeginDrawing();
            ClearBackground(RAYWHITE);
            DrawText("Congrats! You created your first window!", 190, 200, 20, LIGHTGRAY);
        EndDrawing();
    }

    CloseWindow();

    return 0;
}

build and installation

raylib binary releases for Windows, Linux, macOS, Android and HTML5 are available at the Github Releases page.

raylib is also available via multiple package managers on multiple OS distributions.

Installing and building raylib on multiple platforms

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

Note that the Wiki is open for edit, if you find some issues while building raylib for your target platform, feel free to edit the Wiki or open an issue related to it.

Setup raylib with multiple IDEs

raylib has been developed on Windows platform using Notepad++ and MinGW GCC compiler but it can be used with other IDEs on multiple platforms.

Projects directory contains several ready-to-use project templates to build raylib and code examples with multiple IDEs.

Note that there are lots of IDEs supported, some of the provided templates could require some review, so please, if you find some issue with a template or you think they could be improved, feel free to send a PR or open a related issue.

learning and docs

raylib is designed to be learned using the examples as the main reference. There is no standard API documentation but there is a cheatsheet containing all the functions available on the library a short description of each one of them, input parameters and result value names should be intuitive enough to understand how each function works.

Some additional documentation about raylib design can be found in raylib GitHub Wiki. Here are the relevant links:

contact and networks

raylib 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! :)

contributors

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.

raylib uses internally some libraries for window/graphics/inputs management and also to support different file formats loading, all those libraries are embedded with and are available in src/external directory. Check raylib dependencies LICENSES on raylib Wiki for details.

raylib (raysan5/raylib)

Searching Database…

35.2K ·GitHub
Raylib
Что это такое?raylib — это простая и удобная библиотека на C (C99) для создания видеоигр, вдохновлённая Borland BGI и фреймворком XNA: вы пишете код, а она берёт на себя окна, графику, ввод и звук.
Так это полноценный движок с редактором или библиотека, к которой я пишу код?Это обычная библиотека для программирования без редактора: никакого навороченного интерфейса, визуальных помощников или кнопки отладки — просто C API, который вы вызываете из своего кода.
Как его установить?Возьмите готовый бинарник со страницы GitHub Releases, установите через пакетный менеджер вашей ОС или соберите из исходников; в вики есть инструкции для каждой платформы и готовые шаблоны проектов для IDE.
Нужно ли сначала ставить какие-то другие библиотеки или SDK?Нет — у raylib нет внешних зависимостей: все нужные библиотеки для окон, OpenGL, ввода, звука и загрузки файлов уже встроены в саму библиотеку.
Какие главные подводные камни ждут меня в глубине проекта?Так задумано: окно только одно, с одним контекстом OpenGL (несколько окон не поддерживаются), изменение размера или перемещение окна приостанавливает цикл рендера, RenderTextures получаются перевёрнутыми по вертикали, а текст не поддерживает RTL, лигатуры и эмодзи.
Оно только для игр или можно делать что-то ещё?Она нацелена на видеоигры, но официально хорошо подходит для прототипирования, инструментов, графических приложений, встраиваемых систем и обучения, а её 140+ примеров — фактически готовый курс по графическому программированию.
Где на самом деле будет работать моя готовая игра?Windows, Linux, macOS, Raspberry Pi, Android и HTML5 в браузере, а также платформы вроде Chrome OS и FreeBSD, для которых есть инструкции по сборке в вики.
Могу ли я продавать закрытую игру, сделанную на нём?Да — используется немодифицированная лицензия zlib/libpng, BSD-подобная лицензия, одобренная OSI, которая прямо разрешает статическую линковку в проприетарное ПО.
Потянет ли старый ноутбук со встроенной графикой?Скорее всего да: для рендера на минималках нужен всего лишь OpenGL 1.1, а есть даже программный рендерер (rlsw), работающий вообще без OpenGL.
Обязательно писать на C или можно использовать другой язык?Сам raylib написан на чистом C99, но есть биндинги более чем к 70 языкам программирования, так что использовать его можно из многих экосистем — каноничным остаётся C API.
Как мне его освоить, если нет документации по API?Это сделано специально: raylib рассчитан на изучение по коллекции из 140+ примеров кода, а ещё есть шпаргалка со всеми функциями, их параметрами и названиями результатов; более подробные заметки о дизайне лежат в GitHub wiki.
Какие медиаформаты он умеет загружать из коробки?Шрифты: TTF, OTF, FNT, BDF и спрайтовые шрифты; текстуры, включая сжатые DXT, ETC и ASTC; 3D-модели: IQM, M3D и glTF со скелетной анимацией; аудио: WAV, QOA, OGG, MP3, FLAC, XM и MOD со стримингом.
What are similar projects?bgfx, Craft, ebiten, egui, sokol, benilla, tidewater, 3d-game-shaders-for-beginners
Which topics is it in?win32, riscv, shaders, esp32, opengl, webassembly, game-engine, gamedev, iot, raspberry-pi, rendering, embedded
Creator
raysan5
Size
406.5 MB
Stars
35.2K
Updated
CommitOct 16Release6.2Oct 15
Age
12y
Commits · 90 Days