Warme-y2k NPM | npm.io

NPM Version

!TIP High luminosity is recommanded with scanlines filter (set enabled as default).

WARME Y2K is a fully packed 2D/3D game engine dedicated to Y2K games on the web !
The first part of the name (W.A.R.M.E) is an acronym for Web Against Regular Major Engines, you can understand it like a tentative to make a complete game engine for the web. The second part (Y.2.K) is the common acronym used to define the era covers 1998-2004 and define the technics limitation intentionally taken. These limitations are guarants of a human scaled tool and help a lot of to reduce the learning curve.

Some words about our philosophy:

Robustness: We used only simple and efficient methods coming from the industrie for nearly two decades.
Flexibility: Create your own renderers. Handle render and update loops in a state-less way.
Modularity: We used modular architecture to keep things simple and separate.
Performance: We used WebGPU API for a blazing fast rendering.
Lightweight: The lib minzipped size is just 73 kB (1Mb with Rapier2D & Rapier3D).

You can check the documentation here.
For a more concret overview on it, you can play examples here and check the demo source code here.

Table of content

Features

🧱 Core
- Maths
- Tweening
- Events
- Curves
- Quaternions
- Object pooling
👾 2D
- Static sprite (jss)
- Animated sprite (jas)
- Isometric tilemap (jtm)
- Orthographic tilemap (jtm)
- Particles
- Rendering filters
📐 2D Physics
- BoundingRect
- Rapier2D
🧊 3D
- Debug shapes
- Static mesh (jsm and obj)
- Animated mesh (jam)
- Static sprite (jss)
- Animated sprite (jas)
- Billboarding
- Cubemap skybox
- Particules
- Flares
- Fog
- Vertex colorization
- Decals
- Realtime shadowmap
- Multi-viewport
- Camera orbit
- Camera WASD
- Auto mipmap
- Post-process rendering (gbuffers: depth/normal/ids)
- Rendering filters
📐 3D Physics
- BoundingBox
- BoundingCylinder
- Walkmesh (jwm)
- Navigation mesh (jnm)
- Ray-testing
- Rapier3D
💥 3D Material
- Phong reflection model
- Displacement texture map
- Displacement texture scrolling
- Diffuse map
- Specular map
- Emissive map
- Normal map
- Env map
- Texture scrolling
- Animated UV
- Specular shininess
- Emissive intensity
- Normal intensity
🌞 3D Light
- Directional light
- Point lights (max : 64)
🖼️ 3D Post-processing
- Outline
- Hardware dithering
- Pixelation
- Color depth limiting
🎮 Input
- Action mapping
- Gamepad, keyboard and mouse support
🧠 AI
- A* for 2D/3D with graph and grid
- Min-max with alpha-beta pruning
📺 Screen
- Navigate between different view of your game
- Resources pre-loading
📜 Scripts
- Load script from json file
- Register async command function and call-it from json file
- Manual jump to part of the script
- Command primitives like: WAITPAD, GOTO, GOTO_IF, EXEC_IF, VAR_SET, VAR_ADD, VAR_SUB, DELAY
🔊 Sound
- Handle sounds by groups
- Play multiple sounds at same time
🌳 Tree
- 2D binary space partition
- 3D binary space partition
🎨 UI
- Focus/unfocus widgets
- Fade in/out
- Widget architecture
🖍️ UI Widgets
- Dialog + choices
- Dialog only
- Print long text
- Description list
- Virtual keyboard
- Slider
- Menu base
- Menu list view
- Menu text
- Prompt
- Sprite
- Text
🌆 DNA
- ECS architecture implementation

Getting started

A good start is to download the engine repository here add a sample and work on it. A second way for serious project is to start from scratch with this minimal boilerplate it's a complete environment including vite, typescript, warme and it's dependencies. Clone it and have fun !

Run with the following commands

# npm install
# npm run dev

How to integrate your 3D models

The best way is to used the Blender Exporter, otherwise you can used any software that export file in wavefront obj format like Blender, Crocotile, Elit3D or whatever.

Important note: The Blender coordinate system and the engine don't match, see below the rule to translate. Don't forget to apply these changes when you export your obj file.

blender => engine
----------------
x = -x
y = +z
z = +y
engine axis
----------------
forward = -z
up = +y
right = +x

Contributions

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b new_feature)
Commit your Changes (git commit -m 'Add new feature')
Push to the Branch (git push origin new_feature)
Open a Pull Request

Contributors

Crisxzu - Contribute to the Wiki, typedoc converter and Triple Triad demo.
zuda - Contribute to Triple Triad demo.
luciedefraiteur - Contribute to the fog.
thetinyspark - Contribute to the binary space partition.
Impre-visible - Contribute to 2D tutorial.
Alina Morinokanata - Create the logo.

Some parts taken for this work

DOM for UI elements
CanvasRenderingContext2D for 2D stuffs
Human readable custom format for all graphics stuff
Rapier for both 2D and 3D physics engine
No glTF support, we don't want to support the rendering techniques used by this format (BSDF, Skinning, etc...)
Blender is the default for modeling
SpriteFusion is the default for tilemap

Changelog

- [Ver. 1.1.14] Tilemap SpriteFusion format added.
- [Ver. 1.1.13] Cylinder collision class added.
- [Ver. 1.1.12] Fix and optimize jnm.
- [Ver. 1.1.10] Some added to fps demo.
- [Ver. 1.1.7]  Mipmap added.
- [Ver. 1.1.5]  Export as npm module added.
- [Ver. 1.1.1]  Outline post-process effect added.
- [Ver. 1.1.1]  Normals, id and depth rendering buffer added.
- [Ver. 1.1.1]  Object pooling added.
- [Ver. 1.1.0]  Move physics to dedicated folder and redesign JNM.
- [Ver. 1.1.0]  Rapier has been added.
- [Ver. 1.0.3]  Playstation one post-process effect has been added.
- [Ver. 1.0.3]  Post-processing effects has been added.
- [Ver. 1.0.3]  Camera WASD has been added.
- [Ver. 1.0.3]  Camera orbit has been added.

Roadmap

[INFO]
1. This roadmap can changed.
2. Ordered by priority
3. Task done one by one

[CORE TASKS]
1. Write tutorial for "programmez" mag.
3. Add binary format for 3D files.
5. Add spot-light

[DEADLINES]
a. CORE_TASKS.1.2: 01 Juin