Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/01-packages_bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ body:
- graphics-2d
- input
- music
- network-client
- network-server
- sound
validations:
required: true
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/03-feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ body:
- graphics-2d
- input
- music
- network-client
- network-server
- sound
- eslint-config
- prettier-config
Expand Down
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ What kind of change does this PR introduce?
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:

## What is the current behavior?
Expand Down
8 changes: 8 additions & 0 deletions .github/issue-labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ packages:music:
- "### Which (package|utils|package or utils) is this (bug
report|feature request) for\\?\\n\\nmusic\\n"

packages:network-client:
- "### Which (package|utils|package or utils) is this (bug
report|feature request) for\\?\\n\\nnetwork-client\\n"

packages:network-server:
- "### Which (package|utils|package or utils) is this (bug
report|feature request) for\\?\\n\\nnetwork-server\\n"

packages:sound:
- "### Which (package|utils|package or utils) is this (bug
report|feature request) for\\?\\n\\nsound\\n"
Expand Down
12 changes: 12 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,18 @@ packages:music:
- packages/music/*
- packages/music/**/*

packages:network-client:
- changed-files:
- any-glob-to-any-file:
- packages/network-client/*
- packages/network-client/**/*

packages:network-server:
- changed-files:
- any-glob-to-any-file:
- packages/network-server/*
- packages/network-server/**/*

packages:sound:
- changed-files:
- any-glob-to-any-file:
Expand Down
8 changes: 8 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@
description: "Related to Music library"
color: "aaa3dc"

- name: "packages:network-client"
description: "Related to NetworkClient library"
color: "aaa3dc"

- name: "packages:network-server"
description: "Related to NetworkServer library"
color: "aaa3dc"

- name: "packages:sound"
description: "Related to Sound library"
color: "aaa3dc"
Expand Down
Binary file added .github/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions .idea/inspectionProfiles/Project_Default.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

102 changes: 64 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,75 @@
# Engine
<div align="center">
<br />
<p>
<a href="https://github.com/NanoForge-dev"><img src="https://github.com/NanoForge-dev/blob/main/.github/logo.png" width="546" alt="NanoForge" /></a>
</p>
<br />
<p>
<a href="https://github.com/NanoForge-dev/Engine/actions"><img src="https://github.com/NanoForge-dev/Engine/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
<a href="https://github.com/NanoForge-dev/Engine/commits/main"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/Engine.svg?logo=github&logoColor=ffffff" alt="Last commit." /></a>
<a href="https://github.com/NanoForge-dev/Engine/graphs/contributors"><img src="https://img.shields.io/github/contributors/NanoForge-dev/Engine.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="contributors" /></a>
</p>
</div>

This repository contains the full engine for NanoForge.
It can be used by itself.
## About

The engine is made of multiple components:
This repository contains multiple packages with separate [releases][github-releases]. Nanoforge is a powerful game engine for web browser.

- [ecs-client](packages/ecs-client)
- [ecs-server](packages/ecs-server)
- [ecs-lib](packages/ecs-lib)
- [input](packages/input)
- [core](packages/core)
- [common](packages/common)
- [graphics-2d](packages/graphics-2d)
- [asset-manager](packages/asset-manager)
- [sound](packages/sound)
- [music](packages/music)
## Usage

This is the full nanoforge engine including all the default libraries.
To use Nanoforge Engine, please refer to the [CLI documentation][cli-source] !

In order to manage this project we use (pnpm)[https://pnpm.io/]
First, install the CLI :

## Installing dependencies

To install dependencies run:

```sh
pnpm i
```

## Building

To build the project run:

```sh
pnpm build
```bash
npm install -g @nanoforge-dev/cli
```

## Tests
And then create a new project :

To run tests use:

```sh
pnpm test
```bash
nf new
```

## Setting up a test project

In order to setup a test project see (this)[https://github.com/NanoForge-dev/Engine/docs/Introduction.md]
## Packages

- `@nanoforge-dev/common` ([source][common-source]) - Common interfaces and utilities used by Nanoforge Engine
- `@nanoforge-dev/core` ([source][core-source]) - A core package that contains game main loop
- `@nanoforge-dev/ecs-lib` ([source][ecs-lib-source]) - A powerful data structure for managing game entities (_do not use this in your projects_)
- `@nanoforge-dev/ecs-client` ([source][ecs-client-source]) - A wrapper of `@nanoforge-dev/ecs-lib` for client-side usage
- `@nanoforge-dev/ecs-server` ([source][ecs-server-source]) - A wrapper of `@nanoforge-dev/ecs-lib` for server-side usage
- `@nanoforge-dev/config` ([source][config-source]) - A wrapper of `class-validator` and `class-transformer` to imports validation and transformation decorators
- `@nanoforge-dev/graphics-2d` ([source][graphics-2d-source]) - A base 2D graphics library
- `@nanoforge-dev/asset-manager` ([source][asset-manager-source]) - A manager for loading assets to uniform workwith between client and server
- `@nanoforge-dev/network-client` ([source][network-client-source]) - A network lib with tcp and udp support for client-side usage
- `@nanoforge-dev/network-server` ([source][network-server-source]) - A network lib with tcp and udp support for server-side usage
- `@nanoforge-dev/input` ([source][input-source]) - An input manager for handling keyboard and mouse events
- `@nanoforge-dev/music` ([source][music-source]) - A music player for your game
- `@nanoforge-dev/sound` ([source][sound-source]) - A sound manager for your game

## Contributing

Please read through our [contribution guidelines][contributing] 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][good-first-issue] label on issues in the repository. If you have any questions about the project, feel free to ask them on [Discussions][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.

## Help

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][discussions].

[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md
[discussions]: https://github.com/NanoForge-dev/Engine/discussions
[cli-source]: https://github.com/NanoForge-dev/CLI
[github-releases]: https://github.com/NanoForge-dev/Engine/releases
[asset-manager-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/asset-manager
[common-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/common
[config-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/config
[core-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core
[ecs-client-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client
[ecs-lib-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-lib
[ecs-server-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server
[graphics-2d-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/graphics-2d
[input-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/input
[music-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/music
[network-client-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-client
[network-server-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-server
[sound-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/sound
[good-first-issue]: https://github.com/NanoForge-dev/Engine/contribute
Loading
Loading