2
0
mirror of https://github.com/raylib-cs/raylib-cs synced 2025-04-03 11:09:40 -04:00
raylib-cs/README.md
ChrisDill 06d092d462 Updated README.md.
- Made support information clearer.
- Updated Hello World example.
- Fixed LICENSE link.
2020-09-25 19:16:30 +01:00

3.8 KiB

Raylib-cs Logo

Raylib-cs

C# bindings for raylib 3.0, a simple and easy-to-use library to learn videogames programming (www.raylib.com)

GitHub contributors License .NET Core GitHub stars

Chat on Discord

Installation - NuGet

This is the prefered method to get started - The package is still new so please report any issues.

dotnet add package Raylib-cs --version 3.1.5

NuGet

Currently supports netstandard2.0 and netcore3.1. There is also some support for Framework 4.7.2+ although it is experimental.

If you need to edit Raylib-cs source then you will need to add the bindings as a project (see below).

Installation - Manual

  1. Download/Clone this repo

  2. Add Raylib-cs/Raylib-cs.csproj to your project as an existing project.

  3. Download the native libraries for the platforms you want to build for using the official 3.0 release.
    NOTE: the MSVC version is required for Windows platforms

  4. (Recommended) Put the native library for each platform under Raylib-cs/runtimes/{platform}/native/
    (Optional) If you want to handle the native libraries yourself, make sure they are either in the same directory as the executable and/or can be found in the search path. See https://www.mono-project.com/docs/advanced/pinvoke/ for details.

  5. Start coding!

using Raylib_cs;

namespace HelloWorld
{
    static class Program
    {
        public static void Main()
        {
            Raylib.InitWindow(800, 480, "Hello World");

            while (!Raylib.WindowShouldClose())
            {
                Raylib.BeginDrawing();
                Raylib.ClearBackground(Color.WHITE);

                Raylib.DrawText("Hello, world!", 12, 12, 20, Color.BLACK);

                Raylib.EndDrawing();
            }

            Raylib.CloseWindow();
        }
    }
}

Physac-cs and Raygui-cs

These are unfinished EXPERIMENTAL bindings to physac and raygui. Added as a test to Raylib-cs but caused confusion in project setup so they were moved into their own libraries.

Examples

The Examples for Raylib-cs were moved and can be found at Raylib-cs-Examples.

Tech notes

  • Certain functions take a enum instead of a int such as IsKeyPressed.

  • Colours moved into the Color struct as static members. RED changes to Color.RED.

  • Uses string.Format instead of TextFormat.

  • Adds constructors for some of the structs(WIP).

  • Adds operator overloads for math structs.

Contributing

If you have any ideas, feel free to open an issue and tell me what you think. If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

If you want to request features or report bugs related to the library (in contrast to this binding), please refer to the author's project repo.

License

See LICENSE for details.