vrum

Game engine based on three.js

yarn install
yarn h // prints help

Thanks

• three.js
• tween.js
• ShaderParticleEngine
• howler.js
• jeromeetienne

And all the other dependencies vrum.js is using

Games

When desining a game maybe think about

• complementary colors
• contrast
• negative space
• Dan Harmon Story Circle

Tutorial

• About
• Install
• Test
• New game
• Tools
  • model-viewer
  • json-editor
  • scene-editor
• Assets
  • AssetManager
  • Models
  • Animations
  • JSON
  • Engine helpers
• Scenes
  • Input
  • Scene management
  • Fade
  • SceneEditor
  • Custom scenes
• Cheatsheet
  • Objects
    • Sky
    • Starfield
    • Text
    • Fog
    • Grid
    • Water
    • Tree
    • Forest
    • LightningBolt
    • Mirror
    • Terrain
    • Particles
    • Graffiti
  • Lights
    • SpotLight
    • Shadows
    • LightHelpers
    • Frustum
  • Dev
    • Wireframe
    • Screenshot
    • Record video
    • Save file
    • Debug Stats
    • Adjust renderer size
    • Orientation
    • Mobile
    • Persist
  • Controls
    • OrbitControls
    • RTSCamera
    • VirtualController
  • Misc
    • Toon outline
    • Config
    • Sound
    • QRCode
    • Highscores
    • MeshNetwork
    • Fullscreen
    • Opacity
    • AnaglyphEffect
    • StereoEffect
    • Set Skin
    • PoolManager
    • Shaders
    • Console
    • Tweens
    • Modifiers
    • Video
    • No WebGL
• Blender
• Distribute
  • Webserver
  • Executable
  • GithubPages
  • LiveReload

Features

• engine framework
• after effects with composer
• toggle fullscreen
• keyboard/mouse/touch input
• keyboard long pressed
• warn if webgl not available
• auto-resize
• config
• fade between scenes
• change opacity of objects
• debug stats (fps, memory, geometries, textures, points etc.)
• anaglyph effect
• stereo effect
• adjust renderer width/height
• require specific screen orientation
• persist data in localStorage
• sound manager
• clear scene recursively
• toggle wireframe
• orbit controls helper
• take screenshots
• record videos
• skybox
• clone loaded objects instead of direct use
• handle timeout/interval clear on uninit scene (this.setInterval/this.setTimeout)
• html icon
• distribute app for linux/mac/windows
• warn user when building with dependencies.html
• distribute app with gh-pages publish
• build before publish/distribute and copy vrum.min.js
• loading done event
• change model skin
• fog
• text
• grid helper
• high score manager (backed by https://json.northpole.ro)
• mesh networking
• water
• procedural tree
• day/night cycle
• lightning bolt
• on screen controls
• pool manager
• RTSCamera
• live reload
• load images
• load sounds
• load gltf models
• load glb models
• volumetric spotlight
• scene editor
• load json files (terrain/particles/shaders/graffiti)
• json editor
• load shaders
• particle system
• graffiti generator (layered painting)
• light helpers
• terrain with heightmap
• qr code generator
• on screen console
• forest generator
• mirror
• attach object to bone (scale support)
• shadows
• tween objects around
• modifiers - predefined tweens
• animations
• play movie on demand, VideoScene
• preloading screen, show logos, multiple images, skippable etc
• gamepad-api
• set shadowMap.width and height of all lights
• toon outline

Undocumented features

• mesh game pad controller game
• RayScanner
• Utils.boundingBox and RayScanner.addCollidable
• Player control PositionXZRotationYControls
• Button3D , setColor
• Measure
• Utils.lerpCamera(target, distance, speed)
• Utils.addCEButton
• TypeWriter
• RStatsManager.toggleStats()
• test all SceneLoader features
• wind effect with blowing leaves partciles
• smoke effect for wheels when they hit the edge particles
• small explosion effect particles
• next/prev button
• VR
• walker
• tween between animation weights
• generate load_assets_file.json
• physics
• pause rendering on blur (implement own timeout affected by rendering)
• auto generating documentation/cheatsheet from top level block comment

https://www.youtube.com/watch?v=L0zzY5ZeDh8

• qr code to join game top right
• scan qr code on join game screen
• controlled weapon position persistent. if the control moves and a player joins, the new player will see the wrong control position
• delete player when switching to menu fix menu
• give feedback to controller, like how much health, when dead etc.