Skip to content

Commit

Permalink
Document the main idea of the project
Browse files Browse the repository at this point in the history
  • Loading branch information
rexim committed Feb 6, 2024
1 parent 6074de1 commit d5546a4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Unofficial Implementation of Subset of [Raylib](https://github.com/raysan5/rayli

**WARNING! This is a Research Project and not guaranteed to be useful in present or/and future! If you quickly need to port your Raylib game to Web just follow these instructions: https://github.com/raysan5/raylib/wiki/Working-for-Web-(HTML5)**

## Main Idea

The main idea is to enable a very specific style of [Programming in C for WebAssembly without Emscripten](https://surma.dev/things/c-to-webassembly/) but for Raylib. The current limitation is that Raylib.js is not fully implemented, but it does not mean it is useless! If you have a Game that uses only implemented function you can use Raylib.js. And if only few needed functions are not implemented you can implement them and submit a PR thus improving the library for future uses.

We have no plans to replace the official Emscripten version of Raylib. This is a Reasearch Project intended to explore how far this approach can be pushed.

## Start Demo Locally

The demo is deployed to GitHub pages: https://tsoding.github.io/raylib.js/ But you can run it locally.
Expand Down

0 comments on commit d5546a4

Please sign in to comment.