https://github.com/ferstormblessed/nooklibrary
Nook, 2D game engine library with C++
https://github.com/ferstormblessed/nooklibrary
cmake cpp cpp17 game-development games
Last synced: over 1 year ago
JSON representation
Nook, 2D game engine library with C++
- Host: GitHub
- URL: https://github.com/ferstormblessed/nooklibrary
- Owner: ferstormblessed
- License: other
- Created: 2024-11-02T17:42:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-06T21:36:57.000Z (over 1 year ago)
- Last Synced: 2025-01-15T16:04:27.209Z (over 1 year ago)
- Topics: cmake, cpp, cpp17, game-development, games
- Language: C++
- Homepage:
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nook Library
NookLibrary is the backbone of the Nook 2D game engine. It provides all the essential systems for 2D game development, including rendering, physics, input handling, and more. Built on a modular Entity-Component-System (ECS) architecture, this library is designed to be easy to use and integrate into your own game projects.
## What Does It Do?
- Rendering: Powered by SFML, for smooth 2D graphics and windowing.
- Physics: Uses Box2D for realistic simulations.
- Input Handling: Keyboard, mouse, and controller input made easy.
- UI: Debug menus and interfaces with ImGui-SFML.
- Modular Design: Built with the Entity-Component-System (ECS) architecture for flexibility.
## How to Use It
### Use [NookCLI](https://github.com/ferstormblessed/nookcli) to Set Up Your Project
The NookCLI tool streamlines the process of setting up a new project with NookLibrary fully integrated, eliminating the need for manual configuration. When you use NookCLI, it generates a new project that includes a pre-configured CMake setup, ensuring that NookLibrary is properly linked and ready to use
## Related Projects
- [Nook](https://github.com/ferstormblessed/nook): The main repository for the Nook 2D game engine development.
- [NookCLI](https://github.com/ferstormblessed/nookcli): A command-line tool to set up new projects with NookLibrary pre-integrated.
Prerequisites
Make sure you have the following installed before using NookLibrary:
- A C++ compiler (like GCC, Clang, or MSVC)
- CMake
## For Developers
If you're here to contribute to Nook’s development, the [Nook](https://github.com/ferstormblessed/nook) repository is where the engine itself is being worked on. Feel free to dive into the code and submit pull requests!
## License
The source code is dual licensed under Public Domain and MIT -- choose whichever you prefer.