Skip to content

Rezmason/modicum

Repository files navigation

Hanoi screenshot.

Modicum

Modicum is a small standalone WebGL wrapper to support small projects, written in plain old ECMAScript. It's all the WebGL calls you didn't want to make yourself.

Why does this exist, when three.js works?

Well, three.js is optimized for composing and rendering scenes of many nested 3D objects, via shaders nestled within a standard suite of materials.

  • Even if your project depicts a single object, in three.js you'll need to make a scene, make a mesh, assign it a material, make a camera, add the camera and mesh to the scene, and point the camera at the mesh.
  • Furthermore, if your project is mainly an overglorified shader, in three.js you'll need to make a custom material to assign to your mesh.

With Modicum, you build your project from the shaders up.

  • Shaders already require various kinds of data, which the WebGL API can report.
  • Modicum simply helps you satisfy these requirements, by building you objects to feed to your shaders.
  • You won't need to make anything that doesn't directly support those shaders.

Consequently, Modicum is barebones:

And while three.js is pretty great, it has grown pretty big. Modicum is simpler, smaller, and ducks out of your way.

If you really want to, you can read and understand Modicum in under thirty minutes.

Contributing

If you have an interest in this project, please contact me.

Legal?

The short version: you can use Modicum in your project. If you change it, please share your changes!

The long version: the source for Modicum is released under the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

About

A simplistic API for small scale WebGL projects.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages