Skip to content

Latest commit

 

History

History
167 lines (148 loc) · 10.2 KB

README.md

File metadata and controls

167 lines (148 loc) · 10.2 KB
Raw
U3D Logo

U3D

android ios linux macos windows GitHub Discord

U3D is a open source, lightweight, cross-platform 2D and 3D game engine implemented in C++ and released under the MIT license. Forked from Urho3D and greatly inspired by OGRE and Horde3D.

Main website: https://u3d.io/

License

Licensed under the MIT license, see LICENSE for details.

Features

U3D Screenshot

  • Cross-platform support: Windows, Linux, macOS, iOS, tvOS, Android, Raspberry Pi (and other generic ARM boards), and Web with Emscripten
  • Powerful and configurable rendering pipeline, with implementations for forward, light pre-pass and deferred rendering
  • OpenGL, OpenGL ES, WebGL and Direct3D11
  • All-in-one editor built with ActionScript, allowing you to easily customize the editor to your game needs
  • Two scripting languages available for creating game logic: Lua and AngelScript
  • UI, localization and database subsystems
  • Component based scene model
  • Skeletal, vertex morph and node animation
  • Point, spot and directional lights
  • Cascaded shadow maps
  • Particle rendering
  • Geomipmapped terrain
  • Static and skinned decals
  • LODs
  • Automatic instancing
  • Software rasterized occlusion culling
  • Post-processing
  • HDR and PBR rendering
  • 2D sprites and particles that integrate into the 3D scene
  • Task-based multithreading
  • Hierarchical performance profiler
  • Scene, object and prefab load/save in binary, XML and JSON formats
  • Keyframe animation of object attributes
  • Background loading of resources
  • Keyboard, mouse, joystick and touch input
  • High-performance math library
  • Physics powered by Bullet and Box2D
  • Networking powered by SLikeNet
  • Pathfinding and Crowd Simulation via Recast/Detour
  • Supported images: JPEG, PNG, TGA, BMP, PSD, GIF, HDR
  • Compressed image support: DDS, KTX, PVR
  • Import virtually any 3D file format via Assimp
  • 2D and 3D audio playblack, Ogg Vorbis and WAV support
  • TrueType font rendering
  • Built as a single external library, can be linked statically or dynamically

Design Goals

  • Productive: Do not reinvent the wheel. Engine should reduce development time. Less yak shaving, more game making.
  • Fast: Compile and run fast. Parallelize when possible.
  • Modular: Only use what you need. Flexibility for power users.

Conventions

U3D uses the following conventions and principles:

  • Left-handed coordinates. Positive X, Y & Z axes point to the right, up, and forward, and positive rotation is clockwise.
  • Degrees are used for angles.
  • Clockwise vertices define a front face.
  • Audio volume is specified from 0.0 (silence) to 1.0 (full volume)
  • Path names use slash instead of backslash. Paths will be converted internally into the necessary format when calling into the operating system.
  • In the script API, properties are used whenever appropriate instead of Set...() and Get...() functions. If the setter and getter require index parameters, the property will use array-style indexing, and its name will be in plural. For example model->SetMaterial(0, myMaterial) in C++ would become model.materials[0] = myMaterial in script.
  • Raw pointers are used whenever possible in the classes' public API. This simplifies exposing functions & classes to script, and is relatively safe, because SharedPtr & WeakPtr use intrusive reference counting.
  • When an object's public API allows assigning a reference counted object to it through a Set...() function, this implies ownership through a SharedPtr. For example assigning a Material to a StaticModel, or a Viewport to Renderer. To end the assignment and free the reference counted object, call the Set...() function again with a null argument.
  • No C++ exceptions. Error return values (false / null pointer / dummy reference) are used instead. Script exceptions are used when there is no other sensible way, such as with out of bounds array access.
  • Feeding illegal data to public API functions, such as out of bounds indices or null pointers, should not cause crashes or corruption. Instead errors are logged as appropriate.
  • Third party libraries are included as source code for the build process. They are however hidden from the public API as completely as possible.

Community

U3D's development is community-driven and completely independent, empowering developers to build and design better tools to help indie game development. We invite you to familiarize yourself with our Code of Conduct and get to know us on:

If you'd like to help build U3D, we have a guide just for you! Check it out: Contributor Guide.

Credits

U3D is greatly inspired by Urho3D, OGRE and Horde3D. Additional inspiration & research used:

U3D uses the following third-party libraries:

Media credits

  • Jack and mushroom models from the realXtend project. (https://www.realxtend.org)
  • Ninja model and terrain, water, smoke, flare and status bar textures from OGRE.
  • BlueHighway font from Larabie Fonts.
  • Anonymous Pro font by Mark Simonson.
  • NinjaSnowWar sounds by Veli-Pekka Tätilä.
  • PBR textures from Substance Share. (https://share.allegorithmic.com)
  • IBL textures from HDRLab's sIBL Archive.
  • Dieselpunk Moto model by allexandr007.
  • Mutant & Kachujin models from Mixamo.
  • Skies from Polyhaven. (https://polyhaven.com/license)

License / copyright information included with the assets as necessary. All other assets (including shaders) by U3D authors and licensed similarly as the engine itself.

Contributors