From 28a316b3bfe72f7f8341c862c79b06604982b381 Mon Sep 17 00:00:00 2001 From: xamidev Date: Wed, 15 Jan 2025 09:48:59 +0100 Subject: [PATCH] update readme --- README.md | 127 ++++++++---------------------------------------------- 1 file changed, 19 insertions(+), 108 deletions(-) diff --git a/README.md b/README.md index 0192c62..a22334c 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,24 @@ -# Goal +# sandbox -Building my Powder Toy in C with Raylib. -It will be a cellular automaton with gravity and different particles: the evolution of conway's game of life... -Users should be able to save their creations. -It should be in a well-written and well-optimized code, and should be multiplatform ready. +A more evolved 2D cellular automaton with gravity and different elements. Similar to the Powder Toy. -# Raylib-Quickstart -A simple cross platform template for setting up a project with the bleeding edge raylib code. -Works with C or C++. +## Installation +``` +git clone https://github.com/xamidev/sandbox +cd sandbox/build +./premake5 gmake2 +cd .. +make +``` -## Supported Platforms -Quickstart supports the main 3 desktop platforms: -* Windows -* Linux -* MacOS +## Usage +``` +bin/Debug/sandbox +``` -# VSCode Users (all platforms) -* Download the quickstart -* Rename the folder to your game name -* Open the folder in VSCode -* Press F5 to build -* You are good to go +## Controls -# Windows Users -There are two compiler toolchains available for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio -## 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 -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 -Make sure you have added the path - -`C:\raylib\w64devkit\bin` - -To your path environment variable so that the compiler that came with raylib can be found. - -DO NOT INSTALL ANOTHER MinGW-W64 from another source such as msys2, you don't need it. - -## 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 -* 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 -* run `./premake5.osx gmake2` -* CD back to the root -* 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` - -# 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. +| Action | Key | +| ------ | --- | +| Spawn element | Left click | +| Change brush | Right click | \ No newline at end of file