Craftbook
Craftbook Extra | |
Plugin Information | |
---|---|
Lead Dev | tyhdefu doublehelix457 |
Programmers | 14mRh4X0r nosefish M4411K4 |
Links | |
Bugtracker | Bugtracker |
MinecraftOnline is using Craftbook Extra - a fork of Craftbook by M4411K4.
For 1.12.2 Sponge, Craftbook was rewritten mostly by tyhdefu and doublehelix457. An up to date auto generated document of all the ICs can be found here
This article is not intended to replace or duplicate the official Craftbook documentation; the content here is specifically intended to document the features specific to Craftbook Extra which are in use on MinecraftOnline, and act as a friendly how-to guide. Please note that Craftbook Extra is based on Craftbook version 2.0. Not all features described in the Craftbook wiki will work.
What is it?
Craftbook is a plugin that uses codes written onto signs to accomplish a number of very common tasks.
Most commonly, a Craftbook Integrated Circuit (or "IC") will consist of a block with a sign on one side and a lever on the other.
The code on the sign, as well as any Redstone inputs from the front or sides of the sign, can affect the state of the lever on the other side.
How do I use it?
Typically, you'd look up the function that you want using the in-game /ic
command, then write it in square brackets on a sign's second line. The third and fourth lines are for various configuration parameters such as block type to affect or the x/y/z dimensions of an area to affect. Once the sign is placed, if the IC code and its parameters are all valid, the first line will auto-populate with the text description of the IC, letting you know that it worked. You can then add redstone power to the sign to observe the IC in action.
In-game information
You can list CBX signs from inside the game using a newly added information command:
/ic keyword|IC
- search for a Craftbook IC or other sign type by name or function, or look up function from a craftbook IC code.
MCO-specific enhancements
MinecraftOnline's admins have added some features to Craftbook Extra that are not in the official version maintained by M4411K4, and hence not documented on the Craftbook Extra wiki:
CraftBook Mining Protection
It used to be possible to place [MCX207] (Advanced Bridge) or [MCX208] (Advanced Door) ICs to mine out a 11x1x30 area of stone blocks with the flick of a lever. This did not fit the survival theme, so the mechanic of creating these ICs was changed.
After placement, these ICs cannot remove blocks of the type that is specified on line 3. When the input changes, they check the area that is specified on line 4 for these blocks, ignoring data values (red wool in the area will block a 35:0 IC). If any are found, the IC refuses to work and messages players within 3 blocks of the sign about the problem. Once all offending blocks have been removed and the input changes, the IC will notice that the area is now clear and that you cannot be using it to mine. From that point on, it will function as described on the Craftbook-Extra Wiki.
This boils down to a simple rule for creating [MCX207] and [MCX208]: Remove all blocks of the IC's type from the area that it operates on before you power it.
Wooden button
Craftbook signs, pumpkins, and netherack can be triggered by wooden buttons. → Will soon be integrated in the official release.
[Dispenser] for boats
On MCO, minecart dispensers can also dispense boats. Write "Boat" on line 3 to use this feature. The optional "Push" on line 4 does nothing for boats. → Will soon be integrated in the official release.
Planter for carrots and potatoes
Our versions of the planter ICs [MCX216] and [MCZ216] can plant carrots and potatoes.
Trigger Reader range
The original Craftbook Extra allows x- and z-offsets of +-32 for the trigger reader ICs [MCX295] and [MCZ295]. MCO's version can handle +-999.
Note that the chunks with trigger and trigger reader sign must be loaded for this to work, so using a very long range may not give the desired result unless there is a player near each location.
Naturally, trigger readers can read the state of wooden buttons, too.
General improvements over Craftbook 2.0
These are changes in Craftbook Extra that alter functionality from Craftbook standard.
Input swapping
It is possible to swap the inputs and outputs for any 3 input ICs and/or 3 output ICs.
- Not possible to swap single input or single output.
To swap inputs and outputs just type something like: [MCxxxx]abcdef.
- "abc" stands for the input arrangement, and "def" for the output arrangement.
- You can swap inputs by switching around the letters like "bca", or the outputs with "fde".
ICs
Integrated Circuits, or ICs for short, are Craftbook signs that perform actions or alter redstone output based on input and settings, or some aspect of the world state.
You can view a most up to date generated list of ICs here.
Modifiers
This section is a work in progress. On the same line as the IC, a modifier character can be typed to alter the behavior of the IC.
- Invert (!)
- Adding a ! character to the end of an IC (Ex: [MCZ205]!) will invert the output of the IC
- No Y Offset (=)
- Adding a = character to the end of an IC (Ex: [MCZ205]=) will run the IC with no Y-axis offset
- Reverse (r)
- Write what this does
- Cycle Off (1)
- Write what this does
- Thunder Storm (t)
- Write what this does
- Humans Only (-)
- Write what this does
- Log Nearby Players? (+)
- Write what this does
Classes
Every IC belongs to a class / family. These classes define how many inputs and outputs an IC has. They can be: AISO, SISO, SI3O, SI5O, 3ISO, 3I3O, ZISO, or VIVO. The following has been taken from the official Craftbook Wiki: https://craftbook.enginehub.org/en/3.x/mechanics/ics/icfamilies
- AISO
- ICs in this family have:
- 1 input, but the input can be at any input location
- 1 output
- ICs in this family have:
- SISO
- ICs in this family have:
- 1 input
- 1 output
- ICs in this family have:
- SI3O
- ICs in this family have:
- 1 input
- 3 outputs
- ICs in this family have:
- SI5O
- ICs in this family have:
- 1 input
- 5 outputs
- ICs in this family have:
- 3ISO
- ICs in this family have:
- 3 inputs
- 1 output
- ICs in this family have:
- 3I3O
- ICs in this family have:
- 3 inputs
- 3 outputs
- ICs in this family have:
- ZISO
- ICs in this family have:
- 1 output
- ICs in this family have:
- VIVO
- ICs in this family can either have:
- 1 input and 3 outputs, or:
- 2 inputs and 2 outputs, or:
- 3 inputs and 1 output
- ICs in this family can either have:
Bridge
Door
Gate
MC1000 - Repeater
line2: [MC1000]
Repeats a redstone signal.
MC1001 - Inverter
line2: [MC1001]
Inverts a redstone signal.
MC1017 - Toggle Flip Flop RE
line2: [MC1017]
Toggles output on high.
MC1018 - Toggle Flip Flip FE
line2: [MC1018]
Toggles output on low.
MC1020 / MC0020 - Random 1-Bit
Outputs a redstone signal dependent on a random number generator(0-1), with 0 being no signal and 1 being full signal.
MC0020: is the self-triggering version of this.
MC2020 - Random 3-Bit
Outputs a redstone signal with three levers, each dependent on a separate random number generator(0-1), with 0 being no signal and 1 being full signal.
- Note: The IC block itself requires three levers, placed on each of the three sides that the IC sign isn't on.
MC6020 - Random 5-Bit
MC1025 - World Time Modulus
line2: [MC1025]
Outputs high when the world time is odd.
MC1110 - Wireless Transmitter
Transmits a wireless redstone signal on a given shortband, and optionally only under a specific wideband.
MC1111 / MC0111 - Wireless Receiver
Receives a wireless redstone signal on a given shortband, and optionally only under a specific wideband. Self-Triggering variant is [MC0111].
MC1203 - Zeus Bolt
(admin placement only)
line2: [MC1203]
Strikes a location with lightning.
MC1205 - Set Block Above
(admin placement only)
line2: [MC1205]
Set a block above IC Block.
MC1206 - Set Block Below
(admin placement only)
line2: [MC1206]
Set a block below the IC block.
MC1207 - Flex Set Admin
(admin placement only)
line2: [MC1207] line3: (X|Y|Z)(+|-)Distance:BlockType[@Dmg] line4: True/False - true if equal to any of: h
Set a block at a specified location
MC1230 / MC0230 - Daylight Sensor
line2: [MC1230]
Outputs high if it is day.
MC1240 - Arrow Shooter
line2: [MC1240]
(admin placement only)
Shoot a single arrow when powered.
MC1241 - Arrow Barrage
line2: [MC1241]
(admin placement only)
Shoot 5 arrows when powered
MC1249 - Block Replacer
line2: [MC1249]
(admin placement only)
Searches a nearby area and replaces blocks accordingly.
MC1250 - Fireworks
line2: [MC1250]
Shoots TNT-based fireworks
MC1253 - Programmable Firework Display
line2: [MC1253] line3: Name of the firework show script to use, without the .txt / .fwk
Plays a firework show from a file. Both .txt and .fwk are valid extensions.
MC1260 / MC0260 - Water Sensor
line2: [MC1260] line3: Y-offset (optional; default 1)
Output high if water is detected.
MC0260 is the self-triggering variant of this.
MC1261 / MC0261 - Lava Sensor
line2: [MC1261] line3: Y-offset (optional; default 1)
Output high if lava is detected.
MC0261 is the self-triggering variant of this.
MC1262 / MC0262 - Light Sensor
line2: [MC1262] line3: MinLight line4: [X:Y:Z Offset]
Output high if specified light level is detected.
MC0262 is the self-triggering version of this.
MC1420 / MC0420 - Clock
Repeatedly outputs a redstone pulse at a specified rate.
- Third line is the output rate, which must be at least 3.
MC1500 / MC0500 - Player Online?
line2: [MC1500] line3: Name of the player
Outputs when a specified player is online.
MC0500 is the self-triggering version of this.
MC1511 - Message All
(admin placement only)
line2: [MC1511] line3: Message to be broadcast to all players
Message All online players
MC2300 - ROM Get
line2: [MC2300] line3: Name of the ROM file to access, without the .dat
Gets the memory state from a file for usage in the MemorySetter/Access IC group. Only alphanumeric, underscore, and hyphen characters are allowed in the ROM filename.
MC2999 - Marquee
line2: [MC2999]
Cycle through all three outputs.
MC3002 - And Gate
line2: [MC3002]
Outputs high if all inputs are high.
MC3003 - Nand Gate
line2: MC3003
Outputs high if not all inputs are high.
MC3020 - Xor Gate
line2: [MC3020]
Outputs high if the inputs are different
MC3021 - Xnor Gate
line2: [MC3021]
Outputs high if the inputs are the same
MC3030 - RS-Nor Latch
line2: [MC3030]
A compact RS-Nor Latch
MC3031 - Inverse RS-Nand Latch
line2: [MC3031]
A compact Inverse RS-Nand Latch
MC3032 - JK Flip Flip
line2: [MC3032]
A compact JK Flip Flop
MC3033 - RS-Nand Latch
line2: [MC3033]
A compact RS-Nand Latch
MC3034 - Edge-Trigger D Flip Flop
line2: [MC3034]
A compact Edge-D Flip Flop
MC3036 - Level-Trigger D Flip Flop
line2: [MC3036]
A compact Level-D Flip Flop
MC3040 - Multiplexer
line2: [MC3040]
Output Input 1 or 2 depending on state of Input 0
MC3050 - Combination Lock
line2: [MC3050]
Outputs high if the correct combination is inputed
MC3101 - Down Counter
line2: [MC3101]
Decrements on redstone signal, outputs high when reset.
MC3102 - Counter
line2: [MC3102] line3: {max value}[:INF] line4: {counter value}
Increments on redstone signal. Outputs signal is ON when the count is equal to the maximum value, else OFF. To have the counter reset automatically after reaching the maximum value, put ":INF" after the max value, otherwise requires a redstone signal from the left side to reset.
MC3231 - Time Control Advanced
line2: [MC3231]
Changes the time of day when the clock input goes from low to high.
MC3300 - ROM Set
line2: [MC3300]
Sets the memory state for a file for usage in the MemorySetter/Access IC group.
MC3456 - Marquee Transmitter
line2: [MC3456]
Transmit to a set number of receivers with the same base bandname
MC4000 - Full Adder
line2: [MC4000]
A compact full-adder
MC4010 - Half Adder
line2: [MC4010]
A compact half-adder
MC4040 - Demultiplexer 2-Bit
line2: [MC4040]
Demultiplexes the input
MC4100 - Full Subtractor
line2: [MC4100]
A compact full-subtractor
MC4110 - Half Subtractor
line2: [MC4110]
A compact half-subtractor
MC4200 - Dispatcher
line2: [MC4200]
Outputs the centre input on the appropriate outputs when input is high.
MC5000 - Perlstone 3ISO Programmable Logic Chip
line2: [MC5000]
3ISO PLC programmable with Perlstone.
MC6543 - Analog Transmitter
line2: [MC6543] line3: Short band line4: True/False - true if equal to any of: silly
Triggers various bands depending on input signal strength
MCM116 / MCO116 - Mob Above
line2: [MCM116]
Outputs when specified entity is above
MCO116 is the self-triggering variant of this.
MCX010 - Pulse
line2: [MCX010] line3: Pulse Length line4: Pulse Count
Sends out a Pulse when toggeled.
MCX027 / MCZ027 - Between Time
line2: [MCX027] line3: StartTime line4: EndTime
Outputs high if the time is between the specified times. These times refer to real Minecraft time of day, minimum zero, maximum 24000. This is the 20-minute day/night cycle. If the server were running constantly at maximum TPS of 20, then there should be 24000 ticks per day. Realistically, many of these "times" of this clock will be skipped, since TPS is often running about 6 ticks per second.
MCX112 - Transporter
(admin placement only)
Also known as the teleporter. Transports players to matching destinations.
- Third line is for destination IC name.
- Fourth line is for optional message to show on-screen.
It is possible to have multiple teleporters to a single destination.
Transporter pad mode
There is also a "transporter pad" mode when typing [MCX112]p on the second line.
- The 'p' must be lower case!
This transporter pad mode will teleport players from 2 blocks in front of the sign, and 2 blocks (or higher) up. This allows players to be able to use wood/stone plates to teleport by having redstone under it and linked to the MCX112 sign.
Transporter pad pressure plate reset
- [MCX112]P will reset pressure plates connected to it - necessary to prevent the stuck pressure plate bug when used for long-distance teleporters.
MCU113 - Destination
(admin placement only)
This is the destination the players that are teleported by MCX112 will go to. Please note the U in MCU113.
- The third line is the name of the destination that teleporters need to use to link together.
- Destinations can be turned on and off with redstone wire.
It is possible to have multiple teleporters to a single destination.
MCX116 / MCZ116 - Is player above?
Detects if a player is above the IC block at the first empty space a player can fit in. Specific players or groups can be detected instead if set on the IC sign.
- Line 3:
option:name is an optional name for a player or group to detect.
The option value is either p for player, or g for group, or m for a player containing all of the letters in name in the order that they appear.
The name value is the name of the player or group to detect. Prefixing name with an exclamation point will detect everything except option:name
If Line 3 is left blank, it will detect all players.
MCZ116 is the automatic version of MCX116.
MCX118 / MCZ118- Is player near?
- Line 3:
option:name is an optional name for a player or group to detect.
The option value is either p for player, or g for group, or m for a player containing all of the letters in name in the order that they appear.
The name value is the name of the player or group to detect. Prefixing name with an exclamation point will detect everything except option:name.
If Line 3 is left blank, it will detect all players. - Line 4:
range# is an optional block range to detect players around the IC. The range must be a number from 1 to 64. If left blank, the range will be set to 5.
MCZ118 is the automatic version of MCX118.
MCX119 / MCZ119 - Is Mob Near?
This IC is a Single Input Single Output (SISO) IC sign. It works to detect mobs or a specific mob with a maximum range of 64.
- Line 3: name is an optional name for the mob type to be detected. Values can be Mob, Animal, or a mob name that you would use on a spawner IC such as [MCX200]. If Line 3 is left blank, it will detect all mob types.
- Line 4: range# is an optional block range to detect Mobs around the IC. The range must be a number from 1 to 64. If left blank, the range will be set to 5.
MCZ119 is the automatic version of MCX119 above.
MCX120 / MCZ120 - Command controlled IC
- You can control MCX120 and MCZ120 with the command /mcx120 [band name] <on/off/state>
- [band name] is the band/network name on MCX120 or MCZ120.
- /mcx120 [band name] - will toggle the IC on or off
- /mcx120 [band name] on - will set the IC on
- /mcx120 [band name] off - will set the IC off
- /mcx120 [band name] state - will display a message that the IC is on or off
- [band name] is the band/network name on MCX120 or MCZ120.
- Note: MCX120 needs to be manually updated with a clock signal. MCZ120 is the automatically updating version.
- The command /mcx120list (or /mcz120list) will list all currently loaded band/network names for this IC.
- The band/network names will show up in green if "on", red if "off", and gray if the server is doing odd things with this IC. Should never be gray, but can be.
MCZ120 is the automatic version of MCX120.
MCX121 / MCZ121 - Password controlled IC
MCX121 Password Command is a Craftbook IC which allows a player to remotely control Redstone circuitry by typing a password-protected command into chat.
The MCX121 supports the following commands:
- /mcx121pass add name password - to create and name a new password
- /mcx121pass change name oldpassword newpassword - to change the password associated with a name
- /mcx121pass has name - to see if the given password name already exists
- /mcx121remove name - deletes the stored password for the given name (Admin only)
- /mcx121list - lists all known mcx121 password names but does not reveal their passwords.
- /mcx121 name password - to toggle the state of all ICs using the name name
- /mcx121 name password off - to turn off all ICs using the name name
- /mcx121 name password on - to turn on all ICs using the name name
- /mcx121 name password state - to check the state of ICs using the name name
MCZ121 is the automatic version of MCX121.
MCX130 / MCZ130 - Mob Zapper
(admin placement only)
This kills mobs within a specified range (maximum of 64). Specific mobs can be killed if specified on the sign. It is a manual updated sign. Additionally, it is a Single Input Single Output (SISO) IC sign.
MCZ130 is the automatic version of MCX130.
MCX131 / MCU131- Hit Player Above
(admin placement only)
line2: [MCX131] line3: Player matcher line4: Damage
Damages detected players above the IC block at the first empty space a player can fit in. A specific player or group of players can be defined using a player matcher as in MCX118. Ignores all armor.
MCU131 is the self-triggering variant of this.
MCX132 / MCU132 - Hit Mob Above
(admin placement only)
line2: [MCX132] line3: Entity matcher (optional) line4: Damage
Damages detected mobs above the IC block at the first empty space a mob can fit in. Ignores all armor.
MCU132 is the self-triggering variant of this.
MCX133 / MCZ133 - Humans Only
line2: [MCX133]
(admin placement only)
Removes all nonhuman entities
MCZ133 is the self-triggering variant of this.
MCX140 / MCU140 - In Area
line2: [MCX140]
Outputs if specified entity is in area
See https://cbx.fandom.com/wiki/MCU140 for details
MCX144 / MCU144 - CBWarp Area
line1: Entity tag (example: @Player) line2: [MCX144] line3: CBWarp name line4: area
(admin placement only)
Teleports entities to CBWarp within an area
MC1200 - Entity Spawner
line2: [MC1200]
(admin placement only)
Spawns an entity with specified data.
MCX200 - Entity Spawner (Mob Spawner)
(admin placement only)
Same as MC1200, but adds support for coloured sheep, squids, and ghasts, as well as charged creepers.
- To create a colored sheep, on the third line type Sheep:ID where "ID" is a colour id number (0-15).
- To create a charged creeper, make the third line Creeper:1.
MC1201 - Item Dispenser
line2: [MC1201]
Spawns in items with specified data.
MCX201 - Item Spawner
(admin placement only)
Same as MC1201, but adds "damage" support which allows you to spawn colored dyes, wool, and the different logs.
- To spawn items with color/damage type item:id where "item" is the item name or number, and "id" is the damage/color value (0-15).
MC1202 - Container Dispenser
(admin placement only)
line2: [MC1202]
Dispenses an Item when triggered.
MCX202 - Chest Dispenser
Same as MC1202 (equivalent of MCX201 but item must be from a nearby chest).
- Usage same as MCX201
MCX203 / MCZ203 - Chest Collector
Collects items into a nearby chest, when input goes high.
- Line 3: item-id:color is the specific item to collect. Leave blank if you want to collect all dropped items.
- Line 4: radius is an optional range to collect dropped items. Radius must be a number from 1 to 8. Default is 8.
MCZ203 is the automatic version of MCX203.
MCX205 / MCZ205 - Block Detector
Detects a specific placed block at specific coordinates and outputs high if block is detected.
- Line 3: block-id:damage is the specific block to detect.
- Line 4: direction:distance is the direction and optional distance to detect the placed block.
The direction is either UP or DOWN.
The distance is an optional distance to check the blocks up to. If no distance is added all blocks above or below will be checked (depending on the direction).
MCZ205 is the automatic version of MCX205.
MCX206 - Flex Set
MCX207 - Bridge (Advanced Bridge)
An advanced version of the standard Bridge sign.
- You are able to specify a width, length, and an up/down offset.
- The maximum are:
- width = 11
- length = 30
- up/down = between -10 and 10
- MCX207 and MCX208 are versions that are not allowed to "force" or delete existing blocks.
- They can still have the "force" option on them, but it will not actually force/delete.
- To use:
- <first line blank>
- [MCX207]
- blockID#:colour#
- width:length
- The colour# is optional, and you can just have the blockID# by itself instead.
- The fourth line can also have the up/down offset: width:length:offset
MCX208 - Door (Advanced Door)
An advanced version of the standard Door sign.
- Usage is the same as for #MCX207 - Advanced bridge.
MCX209 - Bridge+ (advanced bridge, forcing)
(admin placement only)
- As #MCX207 - Advanced bridge, but the third line can also have the "force" option added in front:
- f:blockID#:color# where "f" is the force option.
MCX210 - Door+ (advanced door, forcing)
(admin placement only)
- As #MCX208 - Advanced door, but the third line can also have the "force" option added in front:
- f:blockID#:color# where "f" is the force option.
MCX211 - ToggleBlock
line2: [MCX211] line3: BlockType[@Dmg][|]BlockType[@Dmg] line4: (X|Y|Z)(+|-)Distance
Toggles between two given blocks on signal change
MCX213 - Harvester
line2: [MCX213] line4: Width:Length:Height[/Y Offset]
Harvest a set type and amount of blocks
MCX215 / MCZ215 - Area Planter
line2: [MCX215] line3: ItemType[@Damage] line4: width:length[:YOffset (default 1)]
Plants crop entities on nearby farmland.
MCX216 / MCZ216 - Planter
line2: [MCX216] line3: ItemType[@Damage] line4: [yOffset]
Plant a crop entity on nearby farmland.
MCX230 / MCZ230 - Rain Sensor
(admin placement only)
line2: [MCX230]
Output when Raining
MCX231 / MCZ231 - Storm Sensor
(admin placement only)
line2: [MCX231]
Output when Storming
MCT233 - Weather Control
(admin placement only)
- Takes in 3 inputs
- When the front input is turned "on" it will set the weather based on the left and right inputs.
- left input = weather on/off
- right input = stormy weather (chance of lightning) on/off
- This works similar to [MC3231] Time Control
MCX233 - Simple Weather Control
(admin placement only)
- 3rd line = duration. Can be left blank. Duration is from 1 to 24000.
- mode t = storym weather (chance of lightning) (i.e. [MCX233]t)
MCX230 / MCZ230 - Weather Check
(admin placement only)
- output is "on" when it is raining/snowing
- [MCZ230] is self-updating version.
MCX231 / MCZ231 - Stormy Weather Check
(admin placement only)
- output is "on" when the storm mode is on
- NOTE! The weather can be off and this can be on!
- meaning even if it's not raining/snowing the storm mode can be on
- storms will only happen when it's raining/snowing, but the mode can be on.
- when the storm mode is on while it is NOT raining/snowing, nothing happens.
- when storm mode is on while it IS raining/snowing then there are chances that lightning will strike in the world.
- NOTE! The weather can be off and this can be on!
- [MCZ231] is self-updating version.
MCX235 - False Weather
(admin placement only)
- Makes players see rain/snow even when it is not raining/snowing.
- 3rd line = specific player or group. Can be left blank.
- If left blank, all players will be effected.
- specific player example:
- line1:
- line2: [MCX235]
- line3: p:PlayerName
- line4:
- No spaces allowed in in names
- specific group example:
- line1:
- line2: [MCX235]
- line3: g:GroupName
- line4:
- specific player example:
- If left blank, all players will be effected.
MCX236 / MCZ236 - Distance False Weather
(admin placement only)
- Makes players see false rain/snow when they enter the distance range, and removes the false rain/snow when they leave the distance range.
- 3rd line = distance. Distance must be from 1 to 127
- 4th line = message to players in distance range. Can be left blank.
- When using the manual version [MCX236], turning this IC "off" will stop the fake rain/snow for all players that were affected.
MCX237 - Hide Weather
(admin placement only)
- Hides the rain/snow from players.
- Snow will still cover the ground and rain will still put out fires, but players will be unable to see the rain drops and snow flakes.
- 3rd line = exactly the same as [MCX235] False Weather IC mentioned above
MCX238 & MCZ238 - Distance Hide Weather
(admin placement only)
- Same as [MCX236] & [MCZ236] Distance False Weather IC, but hides the weather.
- 3rd & 4th lines = same as [MCX236] & [MCZ236] Distance False Weather IC
MCX242 - Snow Shooter
(admin placement only)
Uses the same format as Craftbook's standard MC1240 arrow shooter.
- Third line: Either speed or both speed and spread. Speed is a value between 0.2 and 2 and the default value is 0.6. Spread is a value between 0 and 50 and the default value is 12. Leave blank to use default.
- Speed
- Speed:Spread
- Fourth line: Vertical velocity between -1 and 1, with 0 being the default. Leave blank to use default of 0.
MCX243 - Snow Barrage
(admin placement only)
Uses the same format as Craftbook's standard MC1241 arrow barrage. Parameters the same as above.
MCX244 - Egg Shooter
(admin placement only)
Same format as MCX242 snowball shooter above.
MCX245 - Egg Barrage
(admin placement only)
Same format as MCX243 snowball barrage above.
MCX246 - Fireball
(admin placement only)
line2: [MCX246]
Shoot a ghast fireball
MCX250 - Particle
(admin placement only)
line2: [MCX250]
Emits particles
MCX255 - Lightning
(admin placement only)
Place the sign on the side of a block. When activated by redstone, it will cause lightning to strike the block it is placed on, and occasionally one block on either side. There is a chance of starting a fire on top of and around the affected block.
Lightning ICs can be placed indoors, in which case the lightning effect will pass through the roof in order to strike the specified block.
- An optional Y-offset can be specified on the 3rd line.
MCX256 / MCX256 - Holy Smite
(admin placement only)
Same functionality as MCX255 but with a radius effect.
- 3rd line = y-offset. Can be left blank.
- 4th line = radius. Can be left blank. Max radius is 5.
- mode 1 = empty circle. Example:
- line1:
- line2: [MCX256]1
- line3:
- line4:
- This will cause the lightning to only hit around the IC block leaving the centre unharmed.
MCX295 / MCZ295 - Trigger Reader
line2: [MCX295]
Output the powered state of a redstone trigger
MCU440 - Monoflop (Countdown)
A type of count down timer which keeps the output off for a set amount of time, and then sets the output on for an optional set amount of time. The down count starts from the value specified and ends at 0.
There is a mode to set the output back off after one cycle of being on, that being 1. And + is another mode to swap the output so that the output would start on and then turn off when the time has been reached.
When activated, the count down timer can not be stopped, and can not be reset. The count down needs to either finish or the IC needs to be destroyed.
- Line 3:
down_count:clock_rate:on_count is the time and rate to keep the output off and on.
down_count is the value to start the timer from. The timer will start at this value and end at 0. The down_count must be a value from 1 to 999.
clock_rate is the amount of ticks until 1 timer cycle is complete. (ex: every 5 ticks the down count will decrease by 1). The clock_rate must be a value from 5 to 15. If no clock_rate is specified, the clock_rate will be set to 5.
on_count is the amount of cycles to keep the output on after reaching 0 and finishing. (Note: for some modes, this will be the duration to remain off instead)
MCX512 - Message Nearby
(admin placement only)
line2: [MCX512]
Message all nearby players.
MCX513 - Message Named Nearby
(admin placement only)
line2: [MCX513] line3&4: Message (uses '&' for colors)
Message a Named player nearby.
MCX515 - Server Log (logs message)
(admin placement only)
A IC that logs a message to the server. It is a Single Input Single Output (SISO) sign.
- Example:
- line1:
- line2: [MCX515]
- line3: (insert message here)
- line4: (insert message here continued)
- This will log a message to the server
MCX516 - Server Log Nearby
(admin placement only)
Logs a message to the server. It can also report the nearest player and message them with the same log message. It is a Single Input Single Output (SISO)sign.
- Example: 1
- line1: range
- line2: [MCX516]
- line3: message
- line4: message continued
- This will log messages to the server
- Example: 2
- line1: range
- line2: [MCX516]
- line3:player %p is th
- line4:e nearest
- This will log messages as well nearby players
- Example: 3
- line1: range
- line2: [MCX516]+
- line3: player %p is th
- line4: e nearest
- This will log messages as well nearby players and messages with the same log to the player
MCX517 - Server Log Nearby+
(admin placement only)
Logs messages as well as players nearby. Unlike MCX 516, it also logs the distance of the player between the player and the IC itself. It is a Single Input Single Output (SISO) sign. Tags that can be used with this sign include " %a " " %p " and /n but only for line 3.
- Example: 1
- line1: range
- line2: [MCX517]
- line3: Message
- line4: Message continued
- Range works only 1-64 blocks
- Basic server message
- Example: 2
- line1: 5
- line2: [MCX517]
- line3: player %p is th
- line4:e nearest
- Will log a custom message and report the specific player within 5 blocks
- Example: 3
- line1: 30
- line2: [MCX517]+
- line3: player %p is th
- line4:e nearest
- Will log a custom message to the server and report the specific player within 30 blocks. it will also send a copy of the server message
- Example: 4
- line1: 30
- line2: [MCX517]
- line3: the players %a
- line4: are in range
- Basic sign set up which logs a message to the server and reports all players within 30 blocks
- Example: 5
- line1: 30
- line2: [MCX517]+
- line3: the players %a
- line4: are in range
- Basic sign set up which logs a message to the server and reports all players within 30 blocks and sends them a copy of the message
MCU700 - Music
Midi ICs that play music. The MCU700 IC must be placed on the side of any block, with a note block placed behind it (in the same way as a switch would be placed at the back of a block with a toggling IC on it).
Midi
Midi files have to be uploaded to the server, so can be created by admins only. These files can be listed with /listmidi. If there's sufficient demand, a midi upload function may be added on the website in future.
line1: line2: [MCU700] line3: songname.m line4:
It's possible to adjust the beat/tick speed:
line1: line2: [MCU700] line3: filename.m:# line4:
Where # is the beat/tick speed. Default is 4. A value such as 6 will make the midi play faster, and a value such as 2 will make it play slower. A value of 0 or less will set it back to 4, and the max value is currently 10.
Note: the first track in any midi file is currently skipped.
troubleshooting
* A .mid file (e.g. example.mid) will be referenced as .m (e.g. example.m) on the sign * check the switch placement if it doesn't play - make it look exactly like the diagram * you may need to have it run slightly faster than 4 to sound normal - 5 or 6 * unlike normal minecraft note blocks you don't need a space above the note block * unlike normal minecraft note blocks the material under the note block isn't important
Text music
The MCU700 IC can also play player-written text format music in one of two formats:
Format 1
default song title author 2 harp f#|3---|-4-3|----| g.|----|-333|5 g#|--4-|----|----| a.|----|3333|----| a#|----|5-5-|----| b.|3---|----|----| c.|-4-4|----|----| c#|----|----|-3--| d.|----|----|-4--| d#|----|----|---4| e.|--3-|----|----| f.|-3--| f#|---4|----|----| bdrum b.|-3--|-3--|-3--| f#|---4|4---| a#|4---|----|---4| f.|---4|---3|---5| d#|4---|----|----| harp e.|3-----|||-4-4|-------| d#--|-333|--5
- line1: The format type. In this case "default".
- line2: Title (not yet used)
- line3: Author (not yet used)
- line4: The default "ticks per beat speed" to use if no speed was specified on [MCU700]. So a value of 2 would be 2 ticks until a note is played.
- line5: The instrument to use. Instruments available:
NAME | INSTRUMENT |
harp | harp |
bdrum | bass drum |
snare | snare |
hat | hat |
batk | bass attack |
Just like the harps in the example, you can have more than one of the same instrument. You need a single empty line between new instruments (after the first) as shown in the example.
- After the instrument (line6+) is the list of notes and octave #.
- Notes with # after it are "sharp" and a . after it are regular
- Notes can be arranged in any order
- Notes with no beats can be left out.
- | (vertical line) characters are ignored and so it can be used to help line up beats. In the last "harp" example you can see that | characters can be placed anywhere.
- - (dash) or spaces count as an empty beat/note.
- a number specifies what octave to play for the note. You can use a value from 0 to 9, but the numbers will be set to the lowest or highest allowed.
- Minecraft only has 2 full octaves. The wiki says it starts from F#3 to F#5, but others suggest it starts from F#2 to F#4. This format starts with F#3. Midi and the 2nd text file format start with F#2.
- There is a max number of lines and beats for text files, but they can be changed in the "craftbook.properties"
Format 2
default2 song title author 2 harp # Some kind of comment #|----------|----------|----------|----------|----------|----------|----------|----------|----------|----------| 4|----------|----------|----------|----------|----------|--------Cc|------Aaf-|fF--Aaf-dD|--FfC--CE-|GF--------| 3|----------|--------cf|-ffA-AAGf-|fDF-fCf-Dc|e-gf------|-f-ffA----|a-fF------|----------|------A---|--fff-----| 2|-AAAAAAAAA|AAfffAfAA-|----------|----------|----fffAfA|A---------| 2|---G---G--| snare 3|---|A--a| #|----|----|----|-just a comment line-|--==-| 2|d-dd|-CD-|
Format 2 acts the same as Format 1, but the octaves are on the left instead. To specify Format 2, put default2 on the first line.
Format 2 also includes the ability to add in comments, which can also be used to help with note placements.
- Comments start with the # character.
Just like format 1:
- you can use more than one of the same instrument.
- octaves that aren't used can be left out.
- octaves can be arranged in any order.
- you can have more than one of the same octave for an instrument.
- | (vertical line) characters are ignored.
- - (dashes) and spaces are counted as empty beats/notes.
- Uppercase letters are sharps (#) and lowercase are regular notes.
MCU702 - Music (sign)
Music IC that reads music from a sign rather than from a file. Not yet implemented.
MC1510 - Player Messenger (Remote messaging)
(admin placement only)
Previously had a bug with permissions, now fixed.
Books
Page reader
Page readers are created by placing a sign on a bookshelf block with:
- Line 1: namespace
- Line 2: [Book]
- Line 3: book
- Line 4: pages
By default, players have access to their own namespace and the global namespace.
- To access the global namespace, type "@" without the quotes on the first line.
- The "book" on the third line is the .txt file name without ".txt" at the end.
- Pages on the fourth line can be left blank. The Page Reader will only read from page 1 if left blank. To read more pages, put on the fourth line: start#:end# where "start#" and "end# "are page numbers separated by ":".
- Book titles are stored in the first line of the book .txt file.
When reading through a range of pages (such as pages 3 to 14), you can *reset* back to the start page by left-clicking the bookshelf.
Commands
- /cbpage - book writing interface.
- If writing pages using the in-game commands, any pages after the max pages allowed will be deleted!
- By default, the max page is 20, so page 21 and up will be deleted if using the in-game commands.
- Pages from in-game writing also have a max character limit of 400 characters by default.
- If writing pages using the in-game commands, any pages after the max pages allowed will be deleted!
- <br> is used to split a page to a new line.
Example:
The brown<br>fox.
Will show as:
The brown fox.
Carts and Craftbook
- Speed Modifiers (CartSpeed)
- Elevators (CartLift)
- Collectors and Depositors (CartCollect, CartDeposit)
- Dispensers (CartDispenser)
- Launchers (CartLaunch)
- Ejectors (CartEject)
- Message Emittors (CartPrint)
- Reversers (CartReverse)
- Sorters (CartSort)
- Stations (CartStation)
- Crafting (CartCraft)
Miscellaneous features
Maps
Map signs are created by placing a sign on a bookshelf with the text:
- Line 1: map number
- Line 2: [Map]
Right-clicking on the bookshelf (not the sign itself!) with a map item currently selected will then change the number of the player's map to the one denoted on the sign.
Debug Stick
The IC Debug Stick can be used by players to get information about and diagnose issues with Craftbook ICs. Some of its features include:
- Showing the area that the IC is configured to react to (the radius of a Chest Collector, the rectangular area of a Bridge or Door, etc.)
- Triggering an IC without using redstone for testing purposes (admin-only)
- Showing technical information about the IC for debugging (admin-only)
- Reloading an IC when sign text is modified without breaking blocks (admin-only)
- Toggling debug messages that allow the IC to explain what it is doing (admin-only)
Players can use a custom crafting recipe to obtain the Debug Stick. Right clicking on an IC sign with the stick shows a menu in chat with information and settings to toggle.
Troubleshooting
Mac users may experience difficulties whilst configuring Craftbook components and may see strange warning messages when placing certain ICs. This can be due to Macs placing invisible characters when the user presses the 'Enter' or arrow keys, which can interfere with Craftbook's ability to parse sign text. If you experience such difficulties and are using a Mac, try swapping between using the 'Enter' key and arrow keys to change lines on a sign.
See also
External links
- http://forums.canarymod.net/?topic=85 - Latest Craftbook Extra thread on canary forums
- http://gitlab.com/minecraftonline/craftbook-extra/issues - MinecraftOnline's issue tracker for craftbook extra
- http://cbx.wikia.com/wiki/CBX_IC_List - Craftbook Extra wiki
- https://craftbook.enginehub.org/en/3.x/ - Official Craftbook 3 documentation (does not include Craftbook Extra features)
- https://web.archive.org/web/20190526034109/http://wiki.sk89q.com/wiki/CraftBook/Usage - Latest archive of the original official Craftbook wiki (does not include Craftbook Extra features)
- http://www.youtube.com/watch?v=dtAxmAKo8ak - Craftbook Extra tutorial video for MCU700 music IC
- http://www.minecraftwiki.net/wiki/Redstone - Minepedia's Official Redstone Page