Short Circuit

# Short Circuit Fast, compact, modular way to design redstone circuits. Here's Bad Apple using Short Circuit: <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/MH6j4Y_WGIA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> ## Downloads Short Circuit is available for downloads on Modrinth and Curseforge, for multiple mod loaders including Fabric, Forge, NeoForge and Quilt (uses Fabric). - (https://modrinth.com/mod/short-circuit) - (https://www.curseforge.com/minecraft/mc-mods/short-circuit) You may also build the mod from source using JDK 21 and by running the following: ```bash git clone https://github.com/North-West-Wind/ShortCircuit.git cd ShortCircuit ./grawdlew build ``` Compiled mod files will be output at `{loader}/build/libs/`, where `{loader}` can be either `fabric`, `forge` or `neoforge`. ## Usage I have made a video for this, if you prefer having some visuals. <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/klFv8QrZ1eY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> This mod comes with 4 items you can craft: - Circuit - Poking Stick - Truth Assigner - Labelling Stick ### Circuit !(https://github.com/North-West-Wind/ShortCircuit/blob/main/images/circuit.png?raw=true) A circuit item looks like a repeater with green torches. When placed, it is shown as a glass block with a carpet inside. This is an uninitialized circuit. To make it work, hold the Poking Stick, and right-click on it. You will be brought to the inside of the circuit. The inside has 6 walls, with the middle of them labelled U (up), D (down), L (left), R (right), F (front), B (back). They relate to the direction you placed the circuit block in. Mark the sides as input or output as you need with the Poking Stick by crouch right-clicking the wall. Input is where external redstone signals will be passed into, and output where signals from inside the circuit will be output to the world. Build your circuit inside. Once you are done, you can leave the inside by right-clicking the wall with the Poking Stick. When you get out, right-click the circuit block with an empty hand. If the circuit doesn't break the rules, you should see the components you placed inside the circuit in the block. This circuit is now ready to receive signals! #### Duplication You can duplicate circuits by right-clicking circuit items on a placed circuit block. ### Poking Stick !(https://github.com/North-West-Wind/ShortCircuit/blob/main/images/poking_stick.png?raw=true) As introduced in the circuit section, the Poking Stick is the main way to interact with the circuit. However, there are additional uses for it. By crouch right-clicking a circuit, you can hide its inner components. This is useful when you have too many dynamic circuits rendering, which may cause some lag. You can also set the exterior size of a circuit using the Poking Stick. By right-clicking the item towards nothing, you can cycle sizes between 4 and 256 (only powers of 2). ### Truth Assigner !(https://github.com/North-West-Wind/ShortCircuit/blob/main/images/truth_assigner.png?raw=true) This is the "fast" part of Short Circuit. As circuits are made base on existing redstone components, they will have a certain amount of delay. The Truth Assigner (aka the washing machine) fixes this problem. The Truth Assigner is a machine that simulates dynamic (normal) circuits to create integrated circuits (ICs). It records the output of the dynamic circuit and constructs a truth table for it, thus being called the Truth Assigner. Integrated circuits are the outputs of Truth Assigner's conversion. The main advantage of integrated circuits is that they are 0-tick, meaning they activate instantly from external sources, and also immediately update neighbor blocks if they changed. However, one should be aware that, integrated circuits are not always the best way. Under 2 main situations, you should not convert a dynamic circuit to an IC. 1. Delay is intentional 2. The circuit has a memory component 1 is trivial. As ICs are 0-tick, no delay is preserved after the conversion. 2 simply refers to if the output of the circuit depends on states of blocks inside the circuit that are not constant. For example, if the output of the circuit depends on a copper bulb inside the circuit, and said copper bulb can change from receiving different inputs, then it is a memory component. #### Duplication Similar to dynamic circuits, integrated circuits can be duplicated in the same way, by right-clicking circuit items on the block. Any circuit items can change between dynamic or i