@dexaf/sfyri-3d
v1.2.0
Published
micro framework to make threejs faster by code
Readme
Sfyri-3D - A micro Framework to boost ThreeJs productivity
Sfyri-3D is a micro framework with the objective of handling repetitive tasks such as:
- Creating Scenes that are resizible.
- Handling Global State and make it accessible around the code.
- Disposing the unloaded resources.
- Creating controllers to handle inputs for multiplatform.
and some other stuff, but i won't go farther then this because this is not going to be a replacement for threeJs but only a tool to make development faster and make the developer think only about scene logic / design and nothing else, in fact, the name of this project, Sfyri, comes from the greek and it means (i hope) hammer as per the hammer of Ephestus, a tool of creation that makes work faster (try to hammer a metal nail with your hands).
Tips
- To read this repo Better I advise using Better Comments by aaron bond and Comment Anchors by ExodiusStudios on VSCodium or Visual Studio Code to have colors and an index of code sections in the plugin tab.
Maintenance
- The commits will start with words that explains the purpose of the commits, if the commit have more then one purpose use & to add more then one purpose or use only the major purpose if the other modification are of lesser importance
- START: creation of repository.
- FEAT: feature added to the repository.
- FIX: fixed something in the repository.
- DOCS: added comments, doc files or renamed variables to be more explicative.
- RFCT: refactored the structure of code.
- RNM: renamed files.
- TEST: added tests to the repo.
- I hope i'll be able to maintain what i said in the previous point.
- Use early return guard instead of big nested if.
- Throw errors with meaningfull message, specify SFYRI and the name of the method throwing the error with \n after to make a cleaner visualization of the message.
