LICENSE.md (1071, 2023-02-05)
machines/ (0, 2023-02-05)
machines/amusement_000.mch (30280, 2023-02-05)
machines/avatar_000.mch (5886, 2023-02-05)
machines/ball-cannon_000.mch (19530, 2023-02-05)
machines/bridge_000.mch (6132, 2023-02-05)
machines/clock_000.mch (17991, 2023-02-05)
machines/garage-door_000.mch (38683, 2023-02-05)
machines/iris_000.mch (23723, 2023-02-05)
machines/memory_000.mch (36450, 2023-02-05)
machines/mixer_000.mch (20654, 2023-02-05)
machines/motor_000.mch (18176, 2023-02-05)
machines/paint_000.mch (63397, 2023-02-05)
machines/piano_000.mch (52785, 2023-02-05)
machines/printer_000.mch (37811, 2023-02-05)
machines/robot_000.mch (21116, 2023-02-05)
machines/rocker_000.mch (6099, 2023-02-05)
machines/safe_000.mch (14909, 2023-02-05)
machines/segment_000.mch (5787, 2023-02-05)
machines/sort_000.mch (49697, 2023-02-05)
machines/tetris_000.mch (37660, 2023-02-05)
project.clj (1303, 2023-02-05)
res/ (0, 2023-02-05)
res/action-menu.svg (14490, 2023-02-05)
res/add-menu.svg (36222, 2023-02-05)
res/animated-frag.glsl (63, 2023-02-05)
res/animated-vert.glsl (1323, 2023-02-05)
res/avatar.anim (408168, 2023-02-05)
res/avatar.mtl (611, 2023-02-05)
res/avatar.obj (171097, 2023-02-05)
res/basic-frag.glsl (63, 2023-02-05)
res/basic-vert.glsl (185, 2023-02-05)
res/bulb.mtl (232, 2023-02-05)
res/bulb.obj (30417, 2023-02-05)
res/button.mtl (232, 2023-02-05)
res/button.obj (710, 2023-02-05)
res/cage.mtl (124, 2023-02-05)
res/cage.obj (1393, 2023-02-05)
... ...
# MockMechanics
MockMechanics is a program that allows the creation of complex and interactive mechanisms using only simple building blocks and a graphical and intuitive form of programming. By focusing on simplicity it encourages experimentation and thinkering: you can develop your ideas as you build them instead of carefully planning ahead. The project is still evolving but already some pretty interesting things can be made, including playable musical instruments, prototypes for real machines, visual representations of algorithms, games and many other things. It is very flexible and easy to use so who knows what else people will come up with. The best way to get to know what it is and what it can do is to watch the first video on the companion YouTube channel.
[](https://www.youtube.com/watch?v=HrwxbQj5mj0)
# Getting Started
Simply install leiningen, download the project, and on the root directory do ```lein run``` (``` lein osx -- run``` on macOs). Make sure you have the Java Runtime Environment version 11 or newer installed. You can get it
here.
On Ubuntu you can use this instead on the command line: ```sudo apt install openjdk-11-jre```
# Gallery
  
 
# Documentation
# Concepts
Mock Mechanics is a program that lets you create interactive machines in a very intuitive way, even programming these machines is mostly a question of connecting things visually in a logical way.
Tree structure: Machines are 3d tree structures of parts, so each part has a parent. You add a part to the ground then add parts to that part and so on to create the structure you want. When you move a part, all it's children move with it.
Modes: The program has different modes (selected on the right buttons bar), each view the same 3d environment but allows you to interact with it in a different way, add mode for instance allows adding objects, edit mode allows scaling and moving them and so on.
Values: Each part has a value associated with it, and what this value means depends on the part. The track value represents its rotation from 0 to 1, 1 being 360 degrees. The wagon value is the distance from its starting point on the track path it's on, the button (and block) value is 1 when pressed and 0 otherwise. The lamp value is 1 when on and 0 when off. You can run a chip by setting it's value to 1 and play the sound of a speaker in the same way. The probe has a value of 1 when it's touching another probe and 0 otherwise.
Behaviour: To make things move (or press buttons, light lamps and so on) you add it to a graph chip part and run the graph. The graph has time (in seconds) on the x axis, i.e the horizontal and the value in the y axis. A graph function that goes from (0,0) to (1,1) for a track for instance would when run rotate that track 360 degrees in 1 second.
Decisions: To connect the behaviour of one part with the behaviour of another (say running a graph when a button is pressed) you use a motherboard part to connect the values of those parts. You can use logical gates to make the values of the outputs any function of the value of the inputs. When a motherboard is called (when one of it's trigger inputs changes) it computes and sets the value of its outputs to zero or one. For instance suppose you connect a button pin directly to a lamp and set the button as a trigger (which it is by default). When you press the button, the lamp will go on and when you release it will go off. The button press and release runs the motherboard (since the button is a trigger) and since the lamp is connected to the button, it's value become the same as that button, 1 (button pressed, lamp on) or 0 (button released, lamp off). Or you could use a probe pin to check a condition in the world, for instance run that chip when the button is pressed and that block is close to that one.
Settings: You can set a few preferences by modifying the settings.clj file in the root directory. This file will grow as I publish new versions of the program to allow fine tuning of the program by the users.
# Interface
You can rotate the view by clicking and dragging the right mouse button. You can also set the pivot of rotation to a part or a point in the ground by right clicking it. You can pan with the middle mouse button. You can zoom in and out with the mouse wheel. The left mouse button click behaviour is specific for each mode, on simulation mode you can apply a force to a part (which is free or has a parent that is free) to move it, on color mode you can apply the current color to the clicked part and so on.
Right buttons bar: Select mode.
Left buttons bar: new file, undo and redo are self explanatory.
Save: The first time it will prompt for a root name, you could type say clock and press enter and it will save the file machines/clock_000.mch. After that, saving will not ask for a name and only save a new version clock_001, clock_002 etc.
Open: will prompt for the root name and load the latest version.
Reset Camera: Place the camera back at the original position is was on startup.
Cancel action: almost self explanatory, useful when you start an action like opening a file but give up, also to erase the shortcuts buffer. Mock mechanics accepts compound shortcuts like emacs, for instance to open a file just press "Ctrl+o", to import a file (for instance load a submachine to the machine you are working on) press "Ctrl+x" followed by "o".
# Library Machines
The three machines: copier, proximity-test and lever are the first "library" machines (you could have build them yourself but I already built them for you). You can import them with "Ctrl-x o" to use as submachines of your own machines.
The lever is the simplest, it can be pulled on or off, there is a hidden probe on layer 2 that lets you check which state it's in.
The proximity-test is for checking if there is a part in a given direction. Just place (transfer) the probe anywhere and press the button. If there is an object in the probe's line of sight (anywhere "on top" of it, the bottom of an object is always sitting on a surface, place a probe on a wall and its top will be facing in the horizontal, try to place a cone on the ground and then on a wall and you'll see what I mean) then the light will be turned on, if not it will be turned off and you can use the light value itself as an input to let a motherboard know if there was a part there or not. I used it for instance on the row tester at the bottom of the tetris game to check each square to see if there was a block there. You can also open the script proximity-test.clj to set the max distance from the probe that counts.
The copier uses the same idea of probes as pointers, point the green probe at anything and point the red probe to where you want to copy it and press the button. The yellow toggle is to decide whether to copy something to the exact place you point or copy in place, but to the parent you point.
Play with the machine library-test to understand all these machines.
* As a side note, the safe machine is broken at the moment due to a problem with the physics engine, so it doesn't actually stop at the wall and locking has no effect, I'm working on it. For the same reason, the tetris script (tetris-loop.clj) has an extra function that won't be necessary when I fix the physics engine issue.
# Add mode
Select an object from the bottom bar then click on some surface (including the ground) to add the object there, while the mouse is pressed you can move it (just like move mode on edit mode).
You can only add to a track at the end, just move the mouse close to the end and click on the appropriate face of the helper cube, clicking anywhere else just adds to the "top" face, which is what you want most of the time when the object you're adding to the track is not another track.
Wagons can only be added to tracks and you can click anywhere on the track. The wagon will move on the circuit created by its parent track and any adjacent tracks (to experiment create an L shape with two tracks, add a wagon to one of them and then on property mode drag the wagon around and note the value, which is the distance from the endpoint of the track path).
# Edit mode
Move: move objects on the surface it's on (the surface of its parent) (the info at the bottom of the screen gives the relative coordinates, (0,0) is the center of the surface). You can also press shift to change the snap distance.
Change height: change vertical distance from the surface, ideally you want a child sitting on the surface of it's parent but sometimes it's necessary to tweak the alignment of things.
Rotate: click and drag away from object to rotate one way, back towards object to rotate another.
Scale: scale works differently for different objects, some can't be scalled at all, for others you click and drag a surface to make the object grow in that direction (like the block, cylinder). For the sphere and track click anywhere and drag (can only scale in one way). For the cone click near the base to increase diameter, near the top to increase height.
Copy: Ctrl click on object to make a selection (it will flash a different color) then normal click to add a copy of it (and all its children) somewhere else.
Transfer: move object to new parent/new surface on the same parent. Same deal as copy, ctrl click to select, normal click to place.
Delete: self explanatory (all children deleted too), and if there are any references to any of the deleted objects (inside a graph or motherboard), they disappear as well.
# Graph mode
If you click on a graph chip you open it for editing, if you click anything else, you add/remove it from the current graph. You can click the button on the bottom right to show/hide the possible commands (use use the shortcuts in red). You can pan the graph by dragging with the middle mouse button. You can zoom in and out with the mouse wheel. Zooming with shift pressed scales only the y direction so you can control the aspect ratio of the graph.
Move submode: move nodes around (shift to change snapping).
Set x: white band shows (it's expecting you to click on a node) then enter the precise x value.
Set y: ditto for y.
Add: click at any point of a function line segment to add a node there.
Delete: click on node to delete it.
Run: run the graph as a test.
Toggle: click on function to toggle between relative and absolute. An absolute function (with circles for nodes) will set the value of the part directly, for instance if it has a node at (1,1) then at 1 second the part it's controlling will be set to the value 1. A relative function (with square nodes will take the part starting value in consideration. For instance if a wagon has value 0 and you have a relative function which is a single segment from (0,2) to (0.25,2), then when you run the graph the wagon will move from 0 to 0.5 (increase at a rate of 2 for 0.25 of a second), if run again it will move from 0.5 to 1 and so on. You can also think of these two functions as a position function, giving the position directly and a velocity function, setting the rate at which the position is changing.
View: reset view of graph.
Lengths: when creating graphs for wagons, its often useful to know what the lengths of each leg of its circuit (and the total) are, click on wagon function to find out.
# Motherboard mode
Similar to graph mode, click on motherboards to view them or click on other parts to add or remove them as pins (outputs and inputs) to the motherboard.
Move submode: move nodes and pins around
And, or, not: add the corresponding gate to the motherboard
Delete: delete nodes or connections
Connect: connect two elements (pins or nodes) in a input to output direction, can also click on the background to create turns to make the wiring more organized visually. Click on a pin or node, then click on zero or more points in the background and finally click on another pin or node.
Trigger: click on a pin to toggle it as a trigger or not (blue circle indicates a trigger pin). The motherboard is called when one of it's trigger pins changes value.
Run: click on a chip pin to run it, useful when you have multiple chips as pins and want to find out what one does.
Script: toggle script or connections, if using a script the motherboard will actually run the code in the machines folder with the name. For example if the name "test" is given, you have to create a file machines/test.clj and name all the pins in a vector so you can use them and the last thing should be a fn that accepts a part name, which will be the part triggered. You can also have helper functions before the fn. Scripts are often unecessary unless creating library parts, the circuits using logical gates are often enough, but if you do need to use one, look at the machine scripted-decider for an example.
# Color mode
Select color, click on part to change it (some part's colors can't be changed like the graph part). The colors have shortcuts too, at least the basic ones (r for red, y for yellow etc).
# Property mode
Set the value of the part (the angle of the track, from 0 to 1, the distance of the wagon from 0 to the maximum distance on the path, etc) and any other properties. Click on the part to view its properties then click on the property to enter a value.
frequency: Set the speaker's frequency in hertz to alter the pitch.
max-angle: if not nil and the the track is free, it will only be able to moved in the range 0, max-angle.
snap: if not nil (or 0), the track or wagon will snap to multiples of this value, for example if snap is set to 0.25, when released by the mouse a track will go to the angles 0, 90, 180 or 270, whichever is closest.
# Toggle mode
It's similar to property mode but for binary properties, you select which property you want to see, then click an object to toggle its value to true or false (red is true, white is false). For instance if you set the "free" property of a track or wagon, on simulation mode you'll be able to move it by dragging it or any of its children (rotate the track or move the wagon on its path), the lever machine has a free track (it will also snap to the snap value if you set it on property mode). The "solid" property allows a block to interact physically with other blocks and physical objects like the balls and the avatar.
# Layer mode
Click on a layer square to view objects in it, shift click to add/remove the layer from current visible ones, drag objects to the desired layer (shift drag to move it's children there too).
# Simulation mode
Where the magic happens, buttons will be pressable, motherboards will respond to changes, physical objects (spheres) will move and you can drag any free wagon/track with the mouse.
# Physics mode (experimental and hidden), "Alt-x p"
Add/remove spheres to interact with parts of your machine. You have to make blocks "solid" on toggle mode for them to interact with the balls. Click on a surface to add sphere there, click on a sphere to remove it.
# Contact
Have any queries, bugs, features or anything else you want to tell me? You can contact me at
mock.mechanics@gmail.com. You can also follow MockMechanics on all the usual places:
Youtube
Twitter
Instagram
If you like this project and want it to continue, you can also support it on Patreon:
Patreon