README
¶
Mechane
Mechane is an experimental app which provides a number of interactive 3D worlds drawn in a wire art style that use a browser based UI.
Development status
Mechane is unstable; expect breaking changes with every commit.
License
{height=75}
SPDX-License-Identifier: CC0-1.0 OR MIT-0
-
mechane by Christian Stewart is marked with CC0 1.0 Universal
-
MIT No Attribution
Copyright 2023 Christian Stewart
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package about contains and generates meta information about Mechane including dependencies and their licenses.
|
Package about contains and generates meta information about Mechane including dependencies and their licenses. |
|
Package mechrun sets up a Mechane server and runs a Mechane world on it.
|
Package mechrun sets up a Mechane server and runs a Mechane world on it. |
|
Package mechserver provides a Mechane server which performs various essential low level tasks for a Mechane world.
|
Package mechserver provides a Mechane server which performs various essential low level tasks for a Mechane world. |
|
mechcamera
Package mechcamera distributes available camera names along with shutterbug-to-camera associations to clients and receives camera association requests from clients.
|
Package mechcamera distributes available camera names along with shutterbug-to-camera associations to clients and receives camera association requests from clients. |
|
mechdevoir
Package mechdevoir collects certain high level UI commands from clients and distributes some associated world state affected by these commands.
|
Package mechdevoir collects certain high level UI commands from clients and distributes some associated world state affected by these commands. |
|
mechoverlayer
Package mechoverlayer dispenses HTML elements which overlay the scene associated with a particular shutterbug.
|
Package mechoverlayer dispenses HTML elements which overlay the scene associated with a particular shutterbug. |
|
mechpixel
Package mechpixel dispenses drawings of scenes associated with a particular shutterbug.
|
Package mechpixel dispenses drawings of scenes associated with a particular shutterbug. |
|
mechraster
Package mechraster provides a rasteriser that can draw scenes.
|
Package mechraster provides a rasteriser that can draw scenes. |
|
mechshutterbug
Package mechshutterbug helps manage shutterbugs which are needed to connect to a Mechane server.
|
Package mechshutterbug helps manage shutterbugs which are needed to connect to a Mechane server. |
|
mechuievent
Package mechuievent collects certain UI events from clients such as keyboard key events, mouse move events, and ShutterbugPixels' overlayer clicks.
|
Package mechuievent collects certain UI events from clients such as keyboard key events, mouse move events, and ShutterbugPixels' overlayer clicks. |
|
Package mechtree implements a hierarchical tree structure of nodes in 3D space that ultimately form the visual content of a Mechane world.
|
Package mechtree implements a hierarchical tree structure of nodes in 3D space that ultimately form the visual content of a Mechane world. |
|
Package mechui provides the HTML, JS, and other such files needed by a Mechane server to display the browser based UI.
|
Package mechui provides the HTML, JS, and other such files needed by a Mechane server to display the browser based UI. |
|
asciidoc
Package asciidoc converts AsciiDoc to HTML by sending the AsciiDoc to a Node.js process that uses the Asciidoctor.js Processor API.
|
Package asciidoc converts AsciiDoc to HTML by sending the AsciiDoc to a Node.js process that uses the Asciidoctor.js Processor API. |
|
asciidoctor
Download the default fonts used by Asciidoctor and create a modified stylesheet with the fonts' local URLs.
|
Download the default fonts used by Asciidoctor and create a modified stylesheet with the fonts' local URLs. |
|
index
Generate the index.html file under the web directory.
|
Generate the index.html file under the web directory. |
|
Package motif contains the Mechane themes.
|
Package motif contains the Mechane themes. |
|
Package world helps developers implement a Mechane world.
|
Package world helps developers implement a Mechane world. |
|
dolly
Package dolly maps user input to camera movements.
|
Package dolly maps user input to camera movements. |
|
worlds
|
|
|
0/test3d
Package test3d is for the Mechane developer to manually test Mechane.
|
Package test3d is for the Mechane developer to manually test Mechane. |
|
0/test3d/model
Package model aggregates the various sub models into one model.
|
Package model aggregates the various sub models into one model. |
|
0/test3d/model/cams
Package cams provides models which simulate cameras being added and removed, sometimes in an erratic manner.
|
Package cams provides models which simulate cameras being added and removed, sometimes in an erratic manner. |
|
0/test3d/model/shape
Package shape models various shapes for testing the rendering abilities of Mechane.
|
Package shape models various shapes for testing the rendering abilities of Mechane. |
|
0/test3d/model/style
Package style contains some commonly used colours and colour gradients.
|
Package style contains some commonly used colours and colour gradients. |
|
0/test3d/model/txtinput
Package txtinput provides textfield inputs.
|
Package txtinput provides textfield inputs. |
|
0/test3d/model/veneer
Package veneer implements a navigation panel that uses the veneer to stay visually above the rest of the world.
|
Package veneer implements a navigation panel that uses the veneer to stay visually above the rest of the world. |
|
0/test3d/update
Package update modifies the model in response to UI events and the relentless passage of time.
|
Package update modifies the model in response to UI events and the relentless passage of time. |
|
solarsystem/model/ellipse
Package ellipse computes properties of the ellipse.
|
Package ellipse computes properties of the ellipse. |
Click to show internal directories.
Click to hide internal directories.