fogd-engine/README.md
2024-08-14 19:33:30 -07:00

68 lines
2.3 KiB
Markdown

# Raylib-Quikstart
Work in process quickstart for raylib using premake
# VSCode Users
Download the quickstart, rename the folder to your game name, and open it in VSCode.
Press F5 to build, and you are good to go.
# Windows Users
There are two compiler toolchains avialble for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio
## Using MinGW-W64
Double click the premake-mingw.bat file.
cd into the folder in your terminal
run make
### 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, just make sure to add the C:\raylib\w64devkit\bin to your path if you used the raylib installer
## Microsoft Visual Studio
Run the premake-VisualStudio.bat
double click the .sln file that is geneated.
develop your game, you are good to go.
# Linux and MacOS Users
CD into the build folder
run ./premake5 gmake2
CD back to the root
run make
you are good to go
# 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
# License
Copyright (c) 2020-2024 Jeffery Myers
This software is provided "as-is", without any express or implied warranty. In no event
will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial
applications, and to alter it and redistribute it freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not claim that you
wrote the original software. If you use this software in a product, an acknowledgment
in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented
as being the original software.
3. This notice may not be removed or altered from any source distribution.