This repository contains multiple packages with separate releases. Nanoforge is a powerful game engine for web browser.
The full documentation can be found at: https://docs.nanoforge.eu/docs/engine/getting-started/index
To use Nanoforge Engine, please refer to the CLI documentation !
First, install the CLI :
npm install -g @nanoforge-dev/cliAnd then create a new project :
nf new@nanoforge-dev/asset(source) - The built-in asset library, to read the files shipped with a game@nanoforge-dev/common(source) - Common interfaces and utilities used by Nanoforge Engine@nanoforge-dev/core(source) - A core package that creates the application and runs the game loop@nanoforge-dev/env(source) - A wrapper ofclass-validatorandclass-transformerto validate environment variables@nanoforge-dev/ecs(source) - A powerful data structure for managing game entities, for the client and the server@nanoforge-dev/editor-lib(source) - The bridge between a running game and the NanoForge editor@nanoforge-dev/graphics-2d(source) - A base 2D graphics library@nanoforge-dev/graphics-3d(source) - A 3D graphics library built on Three.js@nanoforge-dev/input(source) - An input manager for handling keyboard, mouse and controller events@nanoforge-dev/music(source) - A music player for your game@nanoforge-dev/network(source) - A network lib with tcp and udp support, for the client and the server@nanoforge-dev/scene(source) - A scene manager, with vars shared by scenes and systems@nanoforge-dev/sound(source) - A sound manager for your game
Please read through our contribution guidelines before starting a pull request. We welcome contributions of all kinds, not just code! If you're stuck for ideas, look for the good first issue label on issues in the repository. If you have any questions about the project, feel free to ask them on Discussions. Before creating your own issue or pull request, always check to see if one already exists! Don't rush contributions, take your time and ensure you're doing it correctly.
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please ask on Discussions.