mirror of
https://github.com/HarbourMasters/Shipwright.git
synced 2024-11-16 14:35:06 -05:00
143 lines
9.5 KiB
Markdown
143 lines
9.5 KiB
Markdown
|
<img align="left" src="https://github.com/raysan5/raylib/blob/master/logo/raylib_logo_animation.gif" width="288px">
|
||
|
|
|
||
|
|
**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 specially 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!](https://www.raylib.com/examples.html)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
[](https://github.com/raysan5/raylib/graphs/contributors)
|
||
|
|
[](https://github.com/raysan5/raylib/releases)
|
||
|
|
[](https://github.com/raysan5/raylib/commits/master)
|
||
|
|
[](LICENSE)
|
||
|
|
|
||
|
|
[](https://discord.gg/raylib)
|
||
|
|
[](https://github.com/raysan5/raylib/stargazers)
|
||
|
|
[](https://twitter.com/raysan5)
|
||
|
|
[](https://www.reddit.com/r/raylib/)
|
||
|
|
|
||
|
|
[](https://github.com/raysan5/raylib/actions?query=workflow%3AWindows)
|
||
|
|
[](https://github.com/raysan5/raylib/actions?query=workflow%3ALinux)
|
||
|
|
[](https://github.com/raysan5/raylib/actions?query=workflow%3AmacOS)
|
||
|
|
[](https://github.com/raysan5/raylib/actions?query=workflow%3AAndroid)
|
||
|
|
[](https://github.com/raysan5/raylib/actions?query=workflow%3AWebAssembly)
|
||
|
|
|
||
|
|
[](https://github.com/raysan5/raylib/actions?query=workflow%3ACMakeBuilds)
|
||
|
|
[](https://github.com/raysan5/raylib/actions/workflows/windows_examples.yml)
|
||
|
|
[](https://github.com/raysan5/raylib/actions/workflows/linux_examples.yml)
|
||
|
|
|
||
|
|
features
|
||
|
|
--------
|
||
|
|
- **NO external dependencies**, all required libraries are [bundled into raylib](https://github.com/raysan5/raylib/tree/master/src/external)
|
||
|
|
- Multiple platforms supported: **Windows, Linux, MacOS, RPI, Android, HTML5... and more!**
|
||
|
|
- Written in plain C code (C99) in PascalCase/camelCase notation
|
||
|
|
- Hardware accelerated with OpenGL (**1.1, 2.1, 3.3, 4.3 or ES 2.0**)
|
||
|
|
- **Unique OpenGL abstraction layer** (usable as standalone module): [rlgl](https://github.com/raysan5/raylib/blob/master/src/rlgl.h)
|
||
|
|
- Multiple **Fonts** formats supported (TTF, XNA fonts, AngelCode fonts)
|
||
|
|
- Multiple texture formats supported, including **compressed formats** (DXT, ETC, ASTC)
|
||
|
|
- **Full 3D support**, including 3D Shapes, Models, Billboards, Heightmaps and more!
|
||
|
|
- Flexible Materials system, supporting classic maps and **PBR maps**
|
||
|
|
- **Animated 3D models** supported (skeletal bones animation) (IQM)
|
||
|
|
- Shaders support, including model and **postprocessing** shaders.
|
||
|
|
- **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
|
||
|
|
- Huge examples collection with [+120 code examples](https://github.com/raysan5/raylib/tree/master/examples)!
|
||
|
|
- Bindings to [+50 programming languages](https://github.com/raysan5/raylib/blob/master/BINDINGS.md)!
|
||
|
|
- **Free and open source**.
|
||
|
|
|
||
|
|
basic example
|
||
|
|
--------------
|
||
|
|
This 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/core/loader.html?name=core_basic_window).
|
||
|
|
```c
|
||
|
|
#include "raylib.h"
|
||
|
|
|
||
|
|
int main(void)
|
||
|
|
{
|
||
|
|
InitWindow(800, 450, "raylib [core] 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](https://github.com/raysan5/raylib/releases).
|
||
|
|
|
||
|
|
raylib is also available via multiple [package managers](https://github.com/raysan5/raylib/issues/613) on multiple OS distributions.
|
||
|
|
|
||
|
|
#### Installing and building raylib on multiple platforms
|
||
|
|
|
||
|
|
[raylib Wiki](https://github.com/raysan5/raylib/wiki#development-platforms) contains detailed instructions on building and usage on multiple platforms.
|
||
|
|
|
||
|
|
- [Working on Windows](https://github.com/raysan5/raylib/wiki/Working-on-Windows)
|
||
|
|
- [Working on macOS](https://github.com/raysan5/raylib/wiki/Working-on-macOS)
|
||
|
|
- [Working on GNU Linux](https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux)
|
||
|
|
- [Working on Chrome OS](https://github.com/raysan5/raylib/wiki/Working-on-Chrome-OS)
|
||
|
|
- [Working on FreeBSD](https://github.com/raysan5/raylib/wiki/Working-on-FreeBSD)
|
||
|
|
- [Working on Raspberry Pi](https://github.com/raysan5/raylib/wiki/Working-on-Raspberry-Pi)
|
||
|
|
- [Working for Android](https://github.com/raysan5/raylib/wiki/Working-for-Android)
|
||
|
|
- [Working for Web (HTML5)](https://github.com/raysan5/raylib/wiki/Working-for-Web-(HTML5))
|
||
|
|
- [Working anywhere with CMake](https://github.com/raysan5/raylib/wiki/Working-with-CMake)
|
||
|
|
|
||
|
|
*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.*
|
||
|
|
|
||
|
|
#### Setup raylib with multiple IDEs
|
||
|
|
|
||
|
|
raylib has been developed on Windows platform using [Notepad++](https://notepad-plus-plus.org/) and [MinGW GCC](https://www.mingw-w64.org/) compiler but it can be used with other IDEs on multiple platforms.
|
||
|
|
|
||
|
|
[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.
|
||
|
|
|
||
|
|
*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.*
|
||
|
|
|
||
|
|
learning and docs
|
||
|
|
------------------
|
||
|
|
|
||
|
|
raylib 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.
|
||
|
|
|
||
|
|
Some additional documentation about raylib design can be found in raylib GitHub Wiki. Here the more relevant links:
|
||
|
|
|
||
|
|
- [raylib cheatsheet](https://www.raylib.com/cheatsheet/cheatsheet.html)
|
||
|
|
- [raylib architecture](https://github.com/raysan5/raylib/wiki/raylib-architecture)
|
||
|
|
- [raylib library design](https://github.com/raysan5/raylib/wiki)
|
||
|
|
- [raylib examples collection](https://github.com/raysan5/raylib/tree/master/examples)
|
||
|
|
- [raylib games collection](https://github.com/raysan5/raylib-games)
|
||
|
|
|
||
|
|
|
||
|
|
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](https://discord.gg/raylib)! :)
|
||
|
|
|
||
|
|
- Webpage: [https://www.raylib.com](https://www.raylib.com)
|
||
|
|
- Discord: [https://discord.gg/raylib](https://discord.gg/raylib)
|
||
|
|
- Twitter: [https://www.twitter.com/raysan5](https://www.twitter.com/raysan5)
|
||
|
|
- Twitch: [https://www.twitch.tv/raysan5](https://www.twitch.tv/raysan5)
|
||
|
|
- Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib)
|
||
|
|
- Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib)
|
||
|
|
- YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/c/raylib)
|
||
|
|
|
||
|
|
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) for further details.
|
||
|
|
|
||
|
|
raylib uses internally some libraries for window/graphics/inputs management and also to support different fileformats loading, all those libraries are embedded with and are available in [src/external](https://github.com/raysan5/raylib/tree/master/src/external) directory. Check [raylib dependencies LICENSES](https://github.com/raysan5/raylib/wiki/raylib-dependencies) on raylib Wiki for details.
|