Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eldskald/learning-raylib
Just learning C++
https://github.com/eldskald/learning-raylib
Last synced: 29 days ago
JSON representation
Just learning C++
- Host: GitHub
- URL: https://github.com/eldskald/learning-raylib
- Owner: eldskald
- License: mit
- Created: 2023-11-04T04:13:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-18T03:30:09.000Z (4 months ago)
- Last Synced: 2024-09-18T15:58:47.688Z (4 months ago)
- Language: C++
- Homepage:
- Size: 290 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WIP
This project is me trying to learn C++ with [raylib](https://github.com/raysan5/raylib).
## Dependencies
This project is using the GNU Toolchain for C/C++ development, in particular, the [GNU Compiler Collection](https://www.gnu.org/software/gcc), the [MinGW-w64](https://www.mingw-w64.org/) compilers and [make](https://www.gnu.org/software/make). If you want to make an HTML5 build, you need to install [emsdk](https://emscripten.org/docs/getting_started/downloads.html). See more details on below.
Optionally, [gdb](https://www.sourceware.org/gdb/) to debug. You also need [git](https://git-scm.com/), of course.
You'll also need basic libraries used by [raylib](https://github.com/raysan5/raylib) to do graphics and audio. More info on their [wiki](https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux).
It's also using [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format the code, as well as [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) to lint.
## Getting started
After cloning the repository, setup your `.env` file by copying the [.env.example](.env.example) and renaming it to `.env`, and then setting the values. The default values are for working on Linux. If you are working on Windows, use WSL.
Then, run the following to install dependencies:
```console
make install
```
This will install [raylib](https://github.com/raysan5/raylib) on this project so you can compile it. To erase dependencies and builds in case you want to redo everything, run:
```console
make clean
```
To build the level editor and edit levels, run the following:
```console
make editor
```
It will compile the binary `level-editor` at the project root, just run and start making levels. You can also drag and drop a level file at the editor and it will load it. Just press save to save it.
## Running and building
To make a build, run one of these commands:
```console
make build-linux # Makes a Linux build
make build-windows # Makes a Windows build
make build-web # Makes a Web (HTML5) build
make # All of the above
```
It will create a `build` directory and put the binary `app` in there, just run it to play the game.
To build and run a development build, run the following:
```console
make dev
```
It will create a `build` directory, put the binary `dev-app` in there and run it. Easy for quickly compiling changes and running the game with them.
To run the debugger, run the following:
```console
make debug
```
It compiles a development build with debug info, runs [gdb](https://www.sourceware.org/gdb/) on it and after you're done, it deletes it.
To format and lint the whole project, run the following:
```console
make format
make lint
```
Read the [Makefile](Makefile) for more details.
## Working with a web build
To make a web build, you will need to have [emsdk](https://emscripten.org/docs/getting_started/downloads.html) version 3.1.62 and `python`. Follow the link on how to install it in this version. Then, you will need to setup an emscripten config file using the `clang` and `node` binaries that come on the `emsdk` repository, that means the following lines on your `.emscripten` file:
```
LLVM_ROOT = '/upstream/bin'
BINARYEN_ROOT = '/upstream'
NODE_JS = '/node/18.20.3_64bit/bin/node'
```
If you can't compile either `raylib` or the game, pay attention to the error messages, might be some of these binaries that can't be found. Oh, and don't forget to setup your `.env` file with the path of your installation.
After successfully compiling with `make build-web`, you can run the following python line on `build/web`:
```console
python -m http.server 3000
```
This will serve the web build folder on your `localhost:3000`. You can change the port to whatever you want.
## License
This project is licensed under the [MIT](https://opensource.org/license/mit/) license.