Add README

README.md

@@ -0,0 +1,49 @@
+# Some Game Engine
+An attempt to create a game with the ECS architecture in C. This is mostly a learning experience about what goes into a game engine.
+
+The goal of the project is to make a game similar to Hannah and The Pirate Caves from Neopets. I thought that's a nice game to aim for, plus I have fond memories of it. It is not a full-on remake!
+
+**DISCLAIMER**: There is no obligations tied to this project. For all I know, the project can just get abandoned at anytime. I **WILL** take my time with this project.
+
+## Implementation Notes
+As mentioned, this is mostly a learning experience, so certain things are implemented for the sake of learning. However, there are certain things that I didn't bother with because dealing with them will open up another can of worms. Either that or I find it too large of a feature to implement on my own without hating my existance. For these, I will use libraries.
+
+As this point of time (28/5/2023), these are the things I won't bother for now:
+- Game rendering: I remember dealing with OpenGL for a little bit and it being a not-so-pleasant experience. This is also a large topic on its own too.
+- Camera System: This is an interesting one. I would really like to implement this. However, this is sort of tied to game rendering, so no.
+- Windows and raw input handling: Not keen on this.
+- GUI: I'm not about to roll my own GUI library for this.
+- Data structures: Will only do it for specific reasons. Otherwise, use a library.
+
+Libraries used:
+- _raylib_ \[[link](https://github.com/raysan5/raylib)\] + _raygui_ \[[link](https://github.com/raysan5/raygui)\]: MVP of this project. Basically the backbone of the game. I've use it for some past projects and it's always a pleasant experience. Can recommend!
+- _sc_ \[[link](https://github.com/tezc/sc)\]: For data structures. The library targets server backend usage, so it might not be the most suitable usage, and is likely to be replaced. However, it has been a good experience using this library, so no complaints from me.
+
+## Progress
+The engine features:
+- An Entity-Component framework with an Entity Manager + memory pool that is specific for this project
+- AABB collision system + Grid-based Broad phase collision detection
+- Scene management and transition
+- Assets management and sprite transition
+
+Game progress:
+- Simple main menu + sandbox scenes
+- Player movement
+- Tiles: Solid tiles, water, One-way platforms and ladders
+- Crates
+
+## Build Instruction
+1. Build and install raylib.
+2. Clone this repository.
+3. `mkdir build && cd build && cmake ..`
+4. Run: `./HATPC_remake`
+
+Depending on you raylib installation, you may need to specify its directory. Use the `RAYLIB_DIR` variable to indicate raylib's installation path when running the CMake:
+```
+cmake -DCMAKE_BUILD_TYPE=Release -DRAYLIB_DIR=/usr/local/lib ..
+```
+
+There are also other binaries generated for testing purposes. Feel free to try them out.
+
+## Note on assets
+This repository will not contain the assets used in the game, such as fonts, art, and sfx. However, the program should still run without those. Assets are placed in the _res/_ directory.