Git Product home page Git Product logo

noel's Introduction

Noel Game Engine

Noel is a lightweight and user-friendly engine for creating 2D games. Developed in C++ and partially in Assembly, it provides an exceptionally simple API for beginners and includes several useful scripts to automate tasks that might be challenging for newcomers.

Contents

  1. Requirements
  2. Installation
  3. Usage
  4. Scripts
  5. ECS System
  6. Interface
  7. Configuration
  8. Example
  9. License

Requirements

Before working with Noel, make sure you have the following installed on your system:

  • GLFW
  • C++ compiler with supported 20 standard

Installation

To install Noel on your device, follow these steps:

  1. Run the command below in your OS command prompt.
  2. Done!
bash -c "$(curl -fsSL https://raw.githubusercontent.com/worona32b/Noel/main/setup.sh)"

Usage

To use Noel in your project, add the necessary files and libraries to your project and include noel.h.

#include "noel.h"

int main() {
    // Code...
    return 0;
}

Scripts

Noel comes with several scripts that simplify working with the engine:

  • setup.sh: Set up the project for Unix systems.
  • setup.ps1: Set up the project for Windows systems.

ECS System

Noel includes a simple yet powerful Entity-Component-System (ECS) for organizing and interacting with objects in your game.

Interface

Noel's API is designed with an understanding of beginners' needs. It is easy to understand and use for the development of 2D games.

Configuration

Configuration for the game is executed through the config.lua file if it exists.

Example

Here's a simple example using Noel to create a window and render a rectangle:

#include "noel.h"

int main() {
    Noel::initialize();

    Noel::drawCircle(0, 0, 30f, Noel::Color.Blue);

    Noel::terminate();
    return 0;
}

License

Noel is distributed under the MPL-2 license, allowing you to use and modify it for your own purposes.


Wishing you successful game development with Noel!

noel's People

Contributors

worona32b avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.