Have ideas to improve npm?Join in the discussion! »

    @ed-ge/ed-ge

    1.0.0 • Public • Published

    MIT Licence

    Unit Test

    JSDoc Build

    codebeat badge codecov

    ed-ge

    Demo: https://ed-ge.ricks.io

    The EDucational Game Engine

    This game engine is designed to prepare students to use a commerical game engine (e.g. Unity). This began as lecture content for a section of Introduction to Game Programming at the University of Nebraska at Omaha, Spring 2020. The state of the code at the end of that semester can be found on the course website here.

    There are two .html files. index.html uses the production folder that has been transpiled by babel. This should run on most browsers, but the code is difficult to debug and is not fulfill its educational purpose. dev.html on the other hand has not been transpiled but runs only on Chrome or the Firefox nightly build. The code is much easier to debug and fufills the educational goals of this project.

    Educational Game Engine Goals

    Below are the goals for this project. Note that not all of them are complete yet.

    • Use a Scene/Game Object/Component/Behavior system that mirrors Unity
    • Handle keyboard and mouse events in a way that matches Unity
    • Only allow code in Behaviors
    • Allow Scenes to have both prefabs and game objects defined on the fly
    • Clearly show the game loop
    • Clearly show the scene graph
    • Use a collision system that mirrors Unity
      • Use collider components
      • Include both a collision event and collision polling system
    • Include a basic discrete physics system
    • Clearly document the code

    Builds of the code can be found in the build branch.

    License

    This code is governed by an MIT license. Please consult the licenses of the dependencies folder (lib) for the licenes of the immediate dependencies and code in the node_modules folder for licenses used to build any of the components of this library.

    Note in particular that the rvo2-js library used for crowd simulation carries a license that does not allow commerical use with written permission.

    Install

    npm i @ed-ge/ed-ge

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    8.98 MB

    Total Files

    270

    Last publish

    Collaborators

    • avatar