kiril/GameJam2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Kiril Kovachev 2025-01-25 00:59:31 +00:00
parent 3dadf9b2fa
commit c2f30cc948
1 changed files with 13 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -1,36 +1,26 @@
# Raylib-Quickstart
A simple cross platform template for setting up a project with the bleeding edge raylib code.
Works with C or C++.
# Game (Name WIP)
## Supported Platforms
Quickstart supports the main 3 desktop platforms:
* Windows
* Linux
* MacOS
# VSCode Users (all platforms)
*Note* You must have a compiler toolchain installed in addition to vscode.
# Building
* Download the quickstart
* Rename the folder to your game name
* Open the folder in VSCode
* Press F5 to build
* You are good to go
# Windows Users
## Windows
There are two compiler toolchains available for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio
## Using MinGW-W64
### Using MinGW-W64
* Double click the `build-MinGW-W64.bat` file
* CD into the folder in your terminal
* run `make`
* You are good to go
### Note on MinGW-64 versions
#### Note on MinGW-64 versions
Make sure you have a modern version of MinGW-W64 (not mingw).
The best place to get it is from the W64devkit from
https://github.com/skeeto/w64devkit/releases
or the version installed with the raylib installer
#### If you have installed raylib from the installer
##### If you have installed raylib from the installer
Make sure you have added the path
`C:\raylib\w64devkit\bin`
@ -39,18 +29,17 @@ To your path environment variable so that the compiler that came with raylib can
DO NOT INSTALL ANOTHER MinGW-W64 from another source such as msys2, you don't need it.
## Microsoft Visual Studio
### Microsoft Visual Studio
* Run `build-VisualStudio2022.bat`
* double click the `.sln` file that is generated
* develop your game
* you are good to go
# Linux Users
## Linux Users
* CD into the build folder
* run `./premake5 gmake2`
* CD back to the root
* run `make`
* you are good to go
# MacOS Users
* CD into the build folder
@ -59,35 +48,11 @@ DO NOT INSTALL ANOTHER MinGW-W64 from another source such as msys2, you don't ne
* run `make`
* you are good to go
# Output files
The built code will be in the bin dir
# Working directories and the resources folder
The example uses a utility function from `path_utils.h` that will find the resources dir and set it as the current working directory. This is very useful when starting out. If you wish to manage your own working directory you can simply remove the call to the function and the header.
# Changing to C++
Simply rename `src/main.c` to `src/main.cpp` and re-run the steps above and do a clean build.
# Using your own code
Simply remove `src/main.c` and replace it with your code, and re-run the steps above and do a clean build.
# Building for other OpenGL targets
If you need to build for a different OpenGL version than the default (OpenGL 3.3) you can specify an OpenGL version in your premake command line. Just modify the bat file or add the following to your command line
## For OpenGL 1.1
`--graphics=opengl11`
## For OpenGL 2.1
`--graphics=opengl21`
## For OpenGL 4.3
`--graphics=opengl43`
## For OpenGLES 2.0
`--graphics=opengles2`
## For OpenGLES 3.0
`--graphics=opengles3`
# Running
The built code will be in the `bin` dir, so to execute:
```bash
bin/Debug/raylib-quickstart
```
# License
Copyright (c) 2020-2024 Jeffery Myers