diff --git a/.vitepress/config.ts b/.vitepress/config.ts index b6d01ae..f565582 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -61,8 +61,9 @@ export default defineConfig({ }, markdown: { + math: true config: (md) => { md.use(githubLinks); }, }, -}); \ No newline at end of file +}); diff --git a/.vitepress/sidebars/users.ts b/.vitepress/sidebars/users.ts index 7b43217..8210088 100644 --- a/.vitepress/sidebars/users.ts +++ b/.vitepress/sidebars/users.ts @@ -6,14 +6,528 @@ export default { text: "For Users", link: "/users", items: [ - // TODO - Finish this - // { text: "Common Issues", link: "/users/common-issues" }, + // Everything not related to mod guidance + { + text: "About Create", + collapsed: true, + items: [ + { + text: "Development Status", + link: "/users/about/development-status", + }, + { text: "Supporting Create", link: "/users/about/support-create" }, + { text: "View changelogs", link: "/users/changelogs/" }, + ] + }, + + // Getting Started Section + { + text: "Getting Started", + collapsed: false, + items: [ + { + text: "Pondering", + link: "/users/utility/pondering" + }, + { + text: "Engineer's Goggles", + link: "/users/utility/engineers-goggles" + }, + { + text: "Andesite Alloy", + link: "/users/materials/andesite-alloy" + }, + { + text: "Shafts", + link: "/users/andesite-related/shafts" + }, + { + text: "Cogwheels", + link: "/users/andesite-related/cogwheels" + }, + { + text: "Waterwheels", + link: "/users/andesite-related/waterwheels" + }, + { + text: "Belts", + link: "/users/andesite-related/belts" + }, + + ] + }, + + // Materials + { + text: "Materials", + collapsed: true, + items: [ + { + text: "Andesite Alloy", + link: "/users/materials/andesite-alloy" + }, + { + text: "Copper", + link: "/users/materials/copper" + }, + { + text: "Brass", + link: "/users/materials/brass" + }, + { + text: "Zinc", + link: "/users/materials/zinc" + } + ] + }, + + /* Commented out until pages are fleshed out more + // SU Generation + { + text: "Generating Stress", + collapsed: true, + items: [ + { + text: "Rotational Force", + link: "" + }, + ] + }, + + // Ponder categories as is in game (mostly) + { + text: "Kinetic Blocks", + collapsed: true, + items: [ + // Done - Needs Review + { + text: "Shafts", + link: "/users/andesite-related/shafts" + }, + // Done - Needs Review + { + text: "Cogwheels", + link: "/users/andesite-related/cogwheels" + }, + // Done - Needs Review + { + text: "Belts", + link: "/users/andesite-related/belts" + }, + // Done - Needs Review + { + text: "Gearboxes", + link: "/users/andesite-related/gearboxes" + }, + // Done - Needs Review + { + text: "Clutch", + link: "/users/andesite-related/clutch" + }, + // Done - Needs Review + { + text: "Gearshift", + link: "/users/andesite-related/gearshift" + }, + // Done - Needs Review + { + text: "Encased Chain Drive", + link: "/users/andesite-related/encased-chain-drive" + }, + // Done - Needs Review + { + text: "Adjustable Chain Gearshift", + link: "/users/andesite-related/adjustable-chain-gearshift" + }, + { + text: "Chain Conveyor", + link: "" + }, + // Done - Needs Review + { + text: "Sequenced Gear Shift", + link: "/users/brass-related/sequenced-gearshift" + }, + // Done - Needs Review + { + text: "Rotation Speed Controller", + link: "/users/brass-related/rotation-speed-controller" + }, + ] + }, + { + text: "Kinetic Sources", + collapsed: true, + items: [ + { + text: "Hand Crank", + link: "/users/andesite-related/hand-crank" + }, + { + text: "Waterwheels", + link: "" + }, + { + text: "Windmill Bearing", + link: "/users/andesite-related/windmill-bearing" + }, + { + text: "Valve Handle", + link: "/users/copper-related/valve-handle" + }, + { + text: "Steam Engine", + link: "/users/copper-related/steam-engine" + }, + ] + }, + { + text: "Kinetic Appliances", + collapsed: true, + items: [ + { + text: "Millstone", + link: "/users/andesite-related/millstone" + }, + { + text: "Encased Fan", + link: "/users/andesite-related/encased-fan" + }, + { + text: "Mechanical Press", + link: "/users/andesite-related/mechanical-press" + }, + { + text: "Mechanical Mixer", + link: "/users/andesite-related/mechanical-mixer" + }, + { + text: "Mechanical Crafter", + link: "/users/brass-related/mechanical-crafter" + }, + { + text: "Mechanical Drill", + link: "" + }, + { + text: "Mechanical Saw", + link: "" + }, + { + text: "Deployer", + link: "" + }, + { + text: "Mechanical Arm", + link: "" + }, + { + text: "Mechanical Piston", + link: "" + }, + { + text: "Rope Pulley", + link: "" + }, + { + text: "Elevator Pulley", + link: "" + }, + { + text: "Mechanical Bearing", + link: "" + }, + { + text: "Gantry Shaft", + link: "" + }, + { + text: "Gantry Carriage", + link: "" + }, + { + text: "Clockwork Bearing", + link: "" + }, + { + text: "Display Board", + link: "" + }, + { + text: "Crushing Wheel", + link: "" + }, + ] + }, + { + text: "Fluid Manipulators", + collapsed: true, + items: [ + { + text: "Fluid Pipe", + link: "" + }, + { + text: "Mechanical Pump", + link: "" + }, + { + text: "Fluid Valve", + link: "" + }, + { + text: "Smart Fluid Pipe", + link: "" + }, + { + text: "Hose Pulley", + link: "" + }, + { + text: "Item Drain", + link: "" + }, + { + text: "Spout", + link: "" + }, + { + text: "Portable Fluid Interface", + link: "" + }, + { + text: "Fluid Tank", + link: "" + }, + ] + }, + { + text: "Item Transportation", + collapsed: true, + items: [ + { + text: "Belt", + link: "" + }, + { + text: "List Filter", + link: "" + }, + { + text: "Attribute Filter", + link: "" + }, + { + text: "Chute", + link: "" + }, + { + text: "Smart Chute", + link: "" + }, + { + text: "Item Vault", + link: "" + }, + { + text: "Depot", + link: "" + }, + { + text: "Weighted Ejector", + link: "" + }, + { + text: "Mechanical Arm", + link: "" + }, + { + text: "Andesite Funnel", + link: "" + }, + { + text: "Brass Funnel", + link: "" + }, + { + text: "Andesite Tunnel", + link: "" + }, + { + text: "Brass Tunnel", + link: "" + }, + { + text: "Portable Storage Interface", + link: "" + }, + ] + }, + { + text: "High Logistics", + collapsed: true, + items: [ + { + text: "Packager", + link: "" + }, + { + text: "Stock Link", + link: "" + }, + { + text: "Stock Ticker", + link: "" + }, + { + text: "Package Frogport", + link: "" + }, + { + text: "White Postbox", + link: "" + }, + { + text: "Redstone Requester", + link: "" + }, + { + text: "Red Table Cloth", + link: "" + }, + { + text: "Factory Gauge", + link: "" + }, + { + text: "Re-Packager", + link: "" + }, + { + text: "Package Filter", + link: "" + }, + ] + }, + { + text: "Logic Components", + collapsed: true, + items: [ + { + text: "Smart Observer", + link: "" + }, + { + text: "Threshold Switch", + link: "" + }, + { + text: "Nixie Tube", + link: "" + }, + { + text: "Redstone Contact", + link: "" + }, + { + text: "Analog Lever", + link: "" + }, + { + text: "Redstone Link", + link: "" + }, + { + text: "Pulse Extender", + link: "" + }, + { + text: "Pulse Repeater", + link: "" + }, + { + text: "Pulse Timer", + link: "" + }, + { + text: "Powereed Latch", + link: "" + }, + { + text: "Powered Toggle Latch", + link: "" + }, + { + text: "Rose Quartz Lamp", + link: "" + }, + ] + }, + { + text: "Movement Anchors", + collapsed: true, + items: [ + { + text: "", + link: "" + } + ] + }, + { + text: "Contraption Actors", + collapsed: true, + items: [ + { + text: "", + link: "" + } + ] + }, { - text: "Development Status", - link: "/users/development-status", + text: "Block Attachment Utility", + collapsed: true, + items: [ + { + text: "", + link: "" + } + ] }, - { text: "Supporting Create", link: "/users/support-create" }, - { text: "View changelogs", link: "/users/changelogs/" }, + { + text: "Railway Equipment", + collapsed: true, + items: [ + { + text: "", + link: "" + } + ] + }, + { + text: "Aesthetics", + collapsed: true, + items: [ + { + text: "", + link: "" + } + ] + }, + { + text: "Creative Mode", + collapsed: true, + items: [ + { + text: "", + link: "" + } + ] + }, + */ + + // TODO - Finish this + // { text: "Common Issues", link: "/users/common-issues" }, + // TODO - Redo this, it's really old and needs a update // { // text: "How to use Create Schematics", @@ -33,20 +547,50 @@ export default { // }, // ], // }, + + // Group integrations together for clearer organization { - text: "Create's Computercraft Integration", + text: "Integrations", collapsed: true, items: [ + // Computer Craft (might need to restructure nesting) { - text: "Trains", + text: "Create's Computercraft Integration", + collapsed: true, items: [ { - text: "Train station", - link: "/users/cc-tweaked-integration/train/train-station", + // Combine into one page? + text: "Trains", + items: [ + { + text: "Train station", + link: "/users/cc-tweaked-integration/train/train-station", + }, + { + text: "Train schedule", + link: "/users/cc-tweaked-integration/train/train-schedule", + }, + ], + }, + { + text: "Display Link", + link: "/users/cc-tweaked-integration/display-link", }, { - text: "Train schedule", - link: "/users/cc-tweaked-integration/train/train-schedule", + text: "Rotational Speed Controller", + link: "/users/cc-tweaked-integration/rotational-speed-controller", + }, + { + text: "Sequenced Gearshift", + link: "/users/cc-tweaked-integration/sequenced-gearshift", + }, + { + text: "Speedometer", + link: "/users/cc-tweaked-integration/speedometer", + }, + { + text: "Stressometer", + link: "/users/cc-tweaked-integration/stressometer", }, { text: "Libraries", @@ -54,28 +598,9 @@ export default { }, ], }, - { - text: "Display Link", - link: "/users/cc-tweaked-integration/display-link", - }, - { - text: "Rotational Speed Controller", - link: "/users/cc-tweaked-integration/rotational-speed-controller", - }, - { - text: "Sequenced Gearshift", - link: "/users/cc-tweaked-integration/sequenced-gearshift", - }, - { - text: "Speedometer", - link: "/users/cc-tweaked-integration/speedometer", - }, - { - text: "Stressometer", - link: "/users/cc-tweaked-integration/stressometer", - }, - ], - }, + // Other integrations here + ] + }, ], }, ], diff --git a/users/about/development-status.md b/users/about/development-status.md new file mode 100644 index 0000000..b321a06 --- /dev/null +++ b/users/about/development-status.md @@ -0,0 +1,30 @@ +Welcome! This is the page about our current development status and goals, mostly in regard to mod versions and +supported versions of the game. + +Sadly, we cannot give out ETA's for future releases. We are not a game studio and progress on this project depends on +many unpredictable factors. Additionally, Specific dates result in a lot higher pressure than you might think, and the +last thing we want is to give up on making features perfect for you just so it can be ready in time. + +## Supported Game Versions {#supported-versions} + +| Overview | | +| --------------- | ----------------- | +| 1.21.2+ | Unsupported | +| 1.21.1 | Continued Support | +| 1.20.2 - 1.21.0 | Skipped | +| 1.20.1 | Continued Support | +| 1.19.4 | Skipped | +| 1.19.2 | Available (0.5.1) | +| 1.18.2 | Available (0.5.1) | +| 1.17.x | Skipped | +| 1.16.5 | Available (0.3.2) | +| 1.15.2 | Available (0.3.1) | +| 1.14.4 | Available (0.2.3) | + +### Fabric Loader {#fabric} + +_Supported_ + +While the content is developed primarily on Forge, there is a dedicated team of developers maintaining a Fabric port of +Create. +Their Project Page can be found [here](https://www.curseforge.com/minecraft/mc-mods/create-fabric). diff --git a/users/about/support-create.md b/users/about/support-create.md new file mode 100644 index 0000000..d51a01b --- /dev/null +++ b/users/about/support-create.md @@ -0,0 +1,31 @@ +Aside from bug reports, suggestions, and pull requests, you can contribute to the Create endeavors by supporting us +financially. + +Please make donations only with the intent to **encourage the people who are working on content you enjoy playing**, not +to gain advantages over other players in regard to your feature suggestions or your in-game experience. + +--- + + + patreon-plural + + +Patreon is a great option to contribute with a monthly payment. +Your support will be credited at the top of the Project Page, and you will be granted access to an exclusive chatroom on +the Create Discord for hanging out with fellow enthusiastic Create patrons, as well as the team. +Sometimes we host a little Dev/Art stream in the supporter channel, or send out unreleased builds for play testing. + +--- + + + paypal-plural + + +Alternatively, you can send us some love with a little one-time donation on PayPal. +The Donation prompt will allow you to pick between a couple of 'programs' you would like to support, such as "Keep +making new Features" or "Host more Community Events". + +--- + +We'd like to thank everyone that decides to donate, no matter how much. It is greatly appreciated that you put forth +something to help us continue. diff --git a/users/andesite-related/belts.md b/users/andesite-related/belts.md new file mode 100644 index 0000000..5afe0b0 --- /dev/null +++ b/users/andesite-related/belts.md @@ -0,0 +1,57 @@ +# Mechanical Belts + +A Mechanical Belt is a mechanical component that conveys rotation and moves items and entities. + +![Belt](../assets/items/belt.png) + +## Usage + +### Placement + +Placing a Belt requires at least two Shafts. Place the Belt by right-clicking on the first shaft and then right clicking the second. Regardless of the length, this only consumes one mechanical belt. Both shafts must face the same direction. + +A Mechanical Belt can be placed over any number of Shafts arranged horizontally, vertically, or diagonally (45° towards the y axis) in a single line, provided that no obstructions are present and that the total length is no longer than twenty blocks (adjustable in the Config). The Mechanical Belt also require that the two shafts face the same direction. Andesite Casing and Brass Casing can be placed over any segment of a Belt. + +Once a Belt is placed, it can be extended by right clicking the end with a Mechanical Belt in hand while the belt is `under 20 blocks`, though this does not consume the belt. Belts can also be shortened by right clicking them with a Wrench. Both actions relocate the Shaft. + +### Moving Entities and Items + +The Mechanical Belt can transport items from one location to another. Items can either be thrown onto the belt, and machines such as Funnels, Chutes or Mechanical Arms can place items onto the belt or remove items from the belt. A belt can also transport entities and the player. Diving Boots can be worn to negate this effect. You can also negate it while crouching. Items cannot be moved by vertical belts. The belt moves items at $${\displaystyle ({\frac {75}{32}}\times k\times a)}$$ items/min, where $${\displaystyle k}$$ is the belt speed (RPM) and $${\displaystyle a}$$ is the stack size on the belt. Thus the belt's speed changes at a rate of `2.35 items/min` for every additional RPM. For instance, a belt moving at `64 RPM` will move `150 items per minute` when the belt contains singular items. + +If you need to transport more than `600 items per minute`, you will need to use a Brass Funnel to place stacks of items on the belt. At `64 RPM`, this results in a throughput of `9600 items/min`. + +### Common Speeds + +| RPM | Processing Time (sec/item) | Throughput (items/sec) | +| --- | -------------------------- | ---------------------- | +| 4 | 9.375 | 600 | +| 8 | 18.75 | 1,200 | +| 16 | 37.5 | 2,400 | +| 32 | 75 | 4,800 | +| 64 | 150 | 9,600 | +| 128 | 300 | 19,200 | +| 256 | 600 | 38,400 | + +### Relaying Rotational Power + +When rotational force is connected to any shaft of a belt, the belt conveys identical force to every other shaft it is connected to. As such, if two shafts are connected to external sources of rotational force, a belt cannot be placed connecting them unless the force is in the same direction and at the same speed. + +### Interactions + +Components that are commonly used in conjunction with the Mechanical Belt include: + +- Mechanical Press +- Deployer +- Spout +- Brass Tunnel +- Funnel +- Chute +- Depot +- Mechanical Arm +- Encased Fan + +A Mechanical Press presses items on the belt that pass underneath it. Deployers can use their held item on the items that are on the belt which is useful for making train tracks and precision mechanisms. Spouts also fills valid items with the corresponding liquid that it has been supplied with. Brass Tunnels may be used to separate items from stacks or reorganize them as they move along the belt and through the Brass Tunnels. Chutes and Funnels can place items from machine inventories onto the belt or take items off the belt when facing the belt. A belt can place items onto a Depot which allows other machines such as a Chute or a Mechanical Arm to pick up the item and transfer them somewhere else. Encased Fans can modify the item on the belt as it travels along it such as bulk washing or bulk smelting. + +### Dyeing + +Mechanical Belts can be dyed be right clicking on them with a Dye. This will add colored stripes along the edges of the belt. To remove the dye, right click on the belt with a Water Bucket or Water Bottle. diff --git a/users/andesite-related/cogwheels.md b/users/andesite-related/cogwheels.md new file mode 100644 index 0000000..9b8ccbd --- /dev/null +++ b/users/andesite-related/cogwheels.md @@ -0,0 +1,30 @@ +# Cogwheels + +The Cogwheel is a basic mechanical component in Create that relays rotation in a straight line and to adjacent cogwheels. + +The Large Cogwheel is a larger variant of the cogwheel that can relay rotation around corners, allow for change in Rotation Speed when connected to its smaller Counterpart, and power Rotation Speed Controllers. + +Cogwheel +Cogwheel + +## Usage + +### Conveying Rotation + +Cogwheels have three main methods of interlocking: + +- Two Cogwheels interlock when placed next to each other (not diagonally) and facing the same direction. When rotational force is provided to one of the cogwheels, the force will be provided to the other Cogwheel at the same speed but in the opposite direction. +- Two Large Cogwheels interlock when placed perpendicular to each other, effectively changing its axis and direction, but not its speed. +- A Cogwheel and a Large Cogwheel interlock when placed diagonally to each other and facing the same direction. The Large Cogwheel will rotate at half the speed of the Cogwheel. + +A cogwheel can also be used like a Shaft, conveying rotation from the ends of its axis. They can be stopped from doing this by applying a Casing, configurable with a Wrench. Mechanical components can be connected to each end, and several Cogwheels connected end-to-end function the same as multiple shafts would. + +### Adjusting Speed (Gear Ratios) + +Using pairs of Cogwheels and Large Cogwheels, rotational speed can be easily doubled or halved using the mechanic mentioned above. It is possible to connect many pairs of Large Cogwheels and Cogwheels to apply this mechanic repeatedly, up to 256 RPM (Though that limit can be increased or decreased in the Config). + +A Large Cogwheel can also be connected to a Rotation Speed Controller, to adjust speed more precisely. + +### Activating Components + +Some blocks need to be powered by a Cogwheel to function. Those blocks contain a Cogwheel in their texture and can be powered by placing a Cogwheel adjacent to them or a large Cogwheel diagonally, both in the same direction as the block, like a normal Cogwheel. diff --git a/users/andesite-related/shafts.md b/users/andesite-related/shafts.md new file mode 100644 index 0000000..75b08d2 --- /dev/null +++ b/users/andesite-related/shafts.md @@ -0,0 +1,20 @@ +# Shafts + +The shaft is a basic mechanical component in Create. A shaft can be used to connect two mechanical components such that the rotation of one rotates the other. Shafts also serve as the only blocks upon which Mechanical Belts can be placed. + +Shaft + +An Encased Shaft is created by right-clicking a shaft with an Andesite Casing or a Brass Casing, taking up an entire block to allow shafts to cleanly pass through walls. This still allows the shaft to relay rotation but prevents belts from being placed on the shaft. + +## Usage + +### Connecting Components + +When two mechanical components are connected by a shaft, any rotational force provided to either component will also be provided to the other component at the same speed. As such, if both components provide stress, this can cause the machine to become overstressed. + +### Mechanical Belts + +A Mechanical Belt must be placed between two shafts. The shafts must be horizontal, parallel to each other, and perpendicular to the belt itself, and they must be aligned horizontally, vertically, or diagonally\*. No obstruction can exist between the two endpoints with the exception of other shafts. An Andesite/Brass Casing can be placed over any segment of a mechanical belt, including segments that contain shafts, to encase it. + +> [!IMPORTANT] +> You cannot have any other diagonal angles other than 45°. diff --git a/users/andesite-related/waterwheels.md b/users/andesite-related/waterwheels.md new file mode 100644 index 0000000..d9bc82a --- /dev/null +++ b/users/andesite-related/waterwheels.md @@ -0,0 +1,24 @@ +# Waterwheels + +The Water Wheel is a source of rotational power. It generates Rotational Force when water flows over it. + +Waterwheel +Waterwheel + +Due to the fact that the materials required to craft it are easily accessible, the Water Wheel serves as the simplest automatic generator and can be made very early in the game. + +Regular Wheel Stress Capacity = 16SU per RPM (256) + +Large Wheel Stress Capacity = 32SU per RPM (512) + +Total stress capacity can be increased by adding more wheels in parallel. + +## Usage + +When water flows over a Water Wheel, it will begin to rotate. This rotational power can be conveyed to other Components from the Water Wheels' Shaft. Compared to a regular Water Wheel, the Large Water Wheel rotates with half the speed, but generates twice the total stress capacity. You can speed up the Large Water Wheel by simply connecting a regular Water Wheel to it and supplying it with flowing water. + +As long as the water flows around the wheel in one direction, the Wheel will generate Rotational Force. + +## Appearance + +The Water Wheel's appearance can be changed by right-clicking any type of Planks on it. The items will not be consumed. Each texture is automatically generated using the planks and logs of a wood type, allowing for some compatibility with other mods. diff --git a/users/assets/blocks/adjustable_chain_gearshift.png b/users/assets/blocks/adjustable_chain_gearshift.png new file mode 100644 index 0000000..0a02855 Binary files /dev/null and b/users/assets/blocks/adjustable_chain_gearshift.png differ diff --git a/users/assets/blocks/andesite_casing.png b/users/assets/blocks/andesite_casing.png new file mode 100644 index 0000000..cc9c15a Binary files /dev/null and b/users/assets/blocks/andesite_casing.png differ diff --git a/users/assets/blocks/basin.png b/users/assets/blocks/basin.png new file mode 100644 index 0000000..e3a4569 Binary files /dev/null and b/users/assets/blocks/basin.png differ diff --git a/users/assets/blocks/brass_casing.png b/users/assets/blocks/brass_casing.png new file mode 100644 index 0000000..888c4c4 Binary files /dev/null and b/users/assets/blocks/brass_casing.png differ diff --git a/users/assets/blocks/chain_conveyor.png b/users/assets/blocks/chain_conveyor.png new file mode 100644 index 0000000..2f756bd Binary files /dev/null and b/users/assets/blocks/chain_conveyor.png differ diff --git a/users/assets/blocks/clutch.png b/users/assets/blocks/clutch.png new file mode 100644 index 0000000..f253f6e Binary files /dev/null and b/users/assets/blocks/clutch.png differ diff --git a/users/assets/blocks/cogwheel.png b/users/assets/blocks/cogwheel.png new file mode 100644 index 0000000..c4d4e84 Binary files /dev/null and b/users/assets/blocks/cogwheel.png differ diff --git a/users/assets/blocks/copper_casing.png b/users/assets/blocks/copper_casing.png new file mode 100644 index 0000000..523772e Binary files /dev/null and b/users/assets/blocks/copper_casing.png differ diff --git a/users/assets/blocks/depot.png b/users/assets/blocks/depot.png new file mode 100644 index 0000000..069afb8 Binary files /dev/null and b/users/assets/blocks/depot.png differ diff --git a/users/assets/blocks/encased_chain_drive.png b/users/assets/blocks/encased_chain_drive.png new file mode 100644 index 0000000..01e6a91 Binary files /dev/null and b/users/assets/blocks/encased_chain_drive.png differ diff --git a/users/assets/blocks/encased_fan.png b/users/assets/blocks/encased_fan.png new file mode 100644 index 0000000..521d206 Binary files /dev/null and b/users/assets/blocks/encased_fan.png differ diff --git a/users/assets/blocks/gearbox.png b/users/assets/blocks/gearbox.png new file mode 100644 index 0000000..37a941a Binary files /dev/null and b/users/assets/blocks/gearbox.png differ diff --git a/users/assets/blocks/gearshift.png b/users/assets/blocks/gearshift.png new file mode 100644 index 0000000..a257424 Binary files /dev/null and b/users/assets/blocks/gearshift.png differ diff --git a/users/assets/blocks/hand_crank.png b/users/assets/blocks/hand_crank.png new file mode 100644 index 0000000..a79a952 Binary files /dev/null and b/users/assets/blocks/hand_crank.png differ diff --git a/users/assets/blocks/large_cogwheel.png b/users/assets/blocks/large_cogwheel.png new file mode 100644 index 0000000..d290faf Binary files /dev/null and b/users/assets/blocks/large_cogwheel.png differ diff --git a/users/assets/blocks/large_waterwheel.png b/users/assets/blocks/large_waterwheel.png new file mode 100644 index 0000000..637abd2 Binary files /dev/null and b/users/assets/blocks/large_waterwheel.png differ diff --git a/users/assets/blocks/mechanical_crafter.png b/users/assets/blocks/mechanical_crafter.png new file mode 100644 index 0000000..12b7573 Binary files /dev/null and b/users/assets/blocks/mechanical_crafter.png differ diff --git a/users/assets/blocks/mechanical_drill.png b/users/assets/blocks/mechanical_drill.png new file mode 100644 index 0000000..e87d0da Binary files /dev/null and b/users/assets/blocks/mechanical_drill.png differ diff --git a/users/assets/blocks/mechanical_mixer.png b/users/assets/blocks/mechanical_mixer.png new file mode 100644 index 0000000..934a65d Binary files /dev/null and b/users/assets/blocks/mechanical_mixer.png differ diff --git a/users/assets/blocks/mechanical_press.png b/users/assets/blocks/mechanical_press.png new file mode 100644 index 0000000..6bc02b1 Binary files /dev/null and b/users/assets/blocks/mechanical_press.png differ diff --git a/users/assets/blocks/mechanical_saw.png b/users/assets/blocks/mechanical_saw.png new file mode 100644 index 0000000..6188822 Binary files /dev/null and b/users/assets/blocks/mechanical_saw.png differ diff --git a/users/assets/blocks/millstone.png b/users/assets/blocks/millstone.png new file mode 100644 index 0000000..441b9b0 Binary files /dev/null and b/users/assets/blocks/millstone.png differ diff --git a/users/assets/blocks/rotation_speed_controller.png b/users/assets/blocks/rotation_speed_controller.png new file mode 100644 index 0000000..e74b920 Binary files /dev/null and b/users/assets/blocks/rotation_speed_controller.png differ diff --git a/users/assets/blocks/sequenced_gearshift.png b/users/assets/blocks/sequenced_gearshift.png new file mode 100644 index 0000000..fb64b67 Binary files /dev/null and b/users/assets/blocks/sequenced_gearshift.png differ diff --git a/users/assets/blocks/shaft.png b/users/assets/blocks/shaft.png new file mode 100644 index 0000000..beeb1f3 Binary files /dev/null and b/users/assets/blocks/shaft.png differ diff --git a/users/assets/blocks/spout.png b/users/assets/blocks/spout.png new file mode 100644 index 0000000..bd2f6ab Binary files /dev/null and b/users/assets/blocks/spout.png differ diff --git a/users/assets/blocks/steam_engine.png b/users/assets/blocks/steam_engine.png new file mode 100644 index 0000000..6952ccd Binary files /dev/null and b/users/assets/blocks/steam_engine.png differ diff --git a/users/assets/blocks/train_casing.png b/users/assets/blocks/train_casing.png new file mode 100644 index 0000000..caebe66 Binary files /dev/null and b/users/assets/blocks/train_casing.png differ diff --git a/users/assets/blocks/valve_handle.png b/users/assets/blocks/valve_handle.png new file mode 100644 index 0000000..aba99bd Binary files /dev/null and b/users/assets/blocks/valve_handle.png differ diff --git a/users/assets/blocks/vertical_gearbox.png b/users/assets/blocks/vertical_gearbox.png new file mode 100644 index 0000000..e8c30ad Binary files /dev/null and b/users/assets/blocks/vertical_gearbox.png differ diff --git a/users/assets/blocks/waterwheel.png b/users/assets/blocks/waterwheel.png new file mode 100644 index 0000000..138112d Binary files /dev/null and b/users/assets/blocks/waterwheel.png differ diff --git a/users/assets/blocks/windmill_bearing.png b/users/assets/blocks/windmill_bearing.png new file mode 100644 index 0000000..95a3204 Binary files /dev/null and b/users/assets/blocks/windmill_bearing.png differ diff --git a/users/assets/items/andesite_alloy.png b/users/assets/items/andesite_alloy.png new file mode 100644 index 0000000..43ee814 Binary files /dev/null and b/users/assets/items/andesite_alloy.png differ diff --git a/users/assets/items/belt.png b/users/assets/items/belt.png new file mode 100644 index 0000000..e937766 Binary files /dev/null and b/users/assets/items/belt.png differ diff --git a/users/assets/items/brass_hand.png b/users/assets/items/brass_hand.png new file mode 100644 index 0000000..43ee814 Binary files /dev/null and b/users/assets/items/brass_hand.png differ diff --git a/users/assets/items/brass_ingot.png b/users/assets/items/brass_ingot.png new file mode 100644 index 0000000..43ee814 Binary files /dev/null and b/users/assets/items/brass_ingot.png differ diff --git a/users/assets/items/copper_ingot.png b/users/assets/items/copper_ingot.png new file mode 100644 index 0000000..43ee814 Binary files /dev/null and b/users/assets/items/copper_ingot.png differ diff --git a/users/assets/items/goggles.png b/users/assets/items/goggles.png new file mode 100644 index 0000000..22b10d7 Binary files /dev/null and b/users/assets/items/goggles.png differ diff --git a/users/assets/items/zinc_ingot.png b/users/assets/items/zinc_ingot.png new file mode 100644 index 0000000..43ee814 Binary files /dev/null and b/users/assets/items/zinc_ingot.png differ diff --git a/users/assets/ponder_logo.png b/users/assets/ponder_logo.png new file mode 100644 index 0000000..6160c1a Binary files /dev/null and b/users/assets/ponder_logo.png differ diff --git a/users/materials/andesite-alloy.md b/users/materials/andesite-alloy.md new file mode 100644 index 0000000..15c6f09 --- /dev/null +++ b/users/materials/andesite-alloy.md @@ -0,0 +1,71 @@ +# Andesite Alloy + +Andesite Alloy + +Andesite Alloy is a material used in Andesite Casing and simple kinetic blocks, which serves as an entry-point to the mechanical components of Create. Among its many functions, it is an essential ingredient for crafting Shafts and both regular and large Cogwheels. Andesite Alloy is the most basic construction material for components in Create. + +Andesite Alloy cannot be found naturally in the world but can be created through the following methods: + +- Placing two Andesite and two Iron/Zinc nuggets in a diagonal 2x2 pattern +- Mixing one Andesite and one Iron/Zinc nugget with a Mixer in a Basin (more efficient) + +## Application + +Andesite Alloy can be applied to any stripped log manually by right clicking to create Andesite Casings. This process can be automated with the use of Deployers. + +## Important Related Items & Blocks + +| Items | +| ----------------- | +| Hand Crank | +| Clipboard | +| Minecart Coupling | + +| Blocks | +| -------------------------- | +| Analog Lever | +| Andesite Funnel | +| Andesite Table Cover | +| Andesite Tunnel | +| Basin | +| Cart Assembler | +| Chain Conveyor | +| Clutch | +| Cogwheel | +| Contraption Controls | +| Crushing Wheel | +| Deployer | +| Depot | +| Desk Bell | +| Display Board | +| Encased Chaindrive | +| Encased Fan | +| Gantry Carriage | +| Gantry Shaft | +| Gearbox | +| Gearshift | +| Item Hatch | +| Linear Chassis | +| Mechanical Bearing | +| Mechanical Drill | +| Mechanical Harvester | +| Mechanical Mixer | +| Mechanical Plough | +| Mechanical Press | +| Mechanical Piston | +| Mechanical Roller | +| Mechanical Saw | +| Millstone | +| Package Frogport | +| Portable Storage Interface | +| Postboxes | +| Radial Chassis | +| Redstone Link | +| Rope Pulley | +| Shaft | +| Speedometer | +| Sticker | +| Stressometer | +| Table Cloths | +| Vertical Gearbox | +| Windmill Sail | diff --git a/users/materials/brass.md b/users/materials/brass.md new file mode 100644 index 0000000..63c2da3 --- /dev/null +++ b/users/materials/brass.md @@ -0,0 +1,35 @@ +# Brass + +Brass Ingot + +Brass is an alloy obtained by mixing Copper and Zinc together with a Mechanical Mixer, Basin, and Blaze Burner. It is used primarily for crafting brass casing for more advanced mechanical machines. Blocks of Brass can also be used as a beacon base. + +## Important Related Items & Blocks + +| Items | +| ------------------ | +| Attribute Filter | +| Brass Hand | +| Crafter Slot Cover | +| Extendo Grip | +| Wand of Symmetry | + +| Blocks | +| ------------------------- | +| Brass Funnel | +| Brass Tunnel | +| Clockwork Bearing | +| Display Link | +| Elevator Pulley | +| Flywheel | +| Mechanical Arm | +| Mechanical Crafter | +| Placard | +| Pulse Extender | +| Pulse Repeater | +| Pulse Timer | +| Rotation Speed Controller | +| Sequenced Gearshift | +| Smart Chute | +| Smart Observer | +| Threshold Switch | diff --git a/users/materials/copper.md b/users/materials/copper.md new file mode 100644 index 0000000..c59b094 --- /dev/null +++ b/users/materials/copper.md @@ -0,0 +1,33 @@ +# Copper + +Copper + +Copper Ingots are used to create copper casings and fluid components. They can also be mixed with Zinc to create Brass. + +## Important Related Items & Blocks + +| Items | +| ------------------ | +| Brass | +| Copper Ingot | +| Copper Nugget | +| Copper Sheet | +| Crushed Copper Ore | +| Transmitter | + +| Blocks | +| ------------------------ | +| Copper Casing | +| Copper Table Cover | +| Copper Valve Handle | +| Fluid Pipe | +| Fluid Tank | +| Fluid Valve | +| Hose Pulley | +| Item Drain | +| Mechanical Pump | +| Portable Fluid Interface | +| Smart Fluid Pipe | +| Spout | +| Steam Engine | +| Steam Whistle | diff --git a/users/materials/zinc.md b/users/materials/zinc.md new file mode 100644 index 0000000..4070bda --- /dev/null +++ b/users/materials/zinc.md @@ -0,0 +1,5 @@ +# Zinc + +Zinc + +Zinc is mixed with Copper to create Brass. It can also replace Iron in some Create recipes. diff --git a/users/utility/engineers-goggles.md b/users/utility/engineers-goggles.md new file mode 100644 index 0000000..e7e37de --- /dev/null +++ b/users/utility/engineers-goggles.md @@ -0,0 +1,45 @@ +# Engineer's Goggles + +Engineer's Goggles are a wearable item that allow the user to see more details about Create machines and contraptions. + +![Engineer's Goggles](../assets/items/goggles.png) + +## Usage + +While worn in the helmet slot, the Engineer's Goggles will show the stress impact of the viewed machine while it is running. They will also give numbers and highlight the current rotation when looking at a Stressometer or Speedometer. Additionally, they show how much fluid is in a tank along with the total storage capacity of the tank. + +### Detecting Speed + +Upon attaching any rotating component to a network while wearing the Engineer's Goggles, a particle effect will briefly appear rotating around the component, demonstrating the direction of rotation through it's motion and demonstrating the speed of rotation through it's color. + +This particle effect only appears when placing a component, and cannot be used to analyze existing components. + +### Reading Gauges + +Looking at a Speedometer while wearing the Engineer's Goggles will display the exact speed of the system in Rotations Per Minute (RPM), as well as the color coded speed of the system. + +![Speed](https://camo.githubusercontent.com/ec9a8b66ca9cc8eb717d1fe0a56ed85a1fcb66f49f393d1b1ea07aca1bcaa438/68747470733a2f2f692e696d6775722e636f6d2f566e4f417653442e706e67) + +Stressometers can be read the same way, but will instead display the percentage of stress capacity being utilized by the system, the remaining base stress capacity of the system, and the remaining stress capacity of the system at the current RPM. + +![Stress](https://camo.githubusercontent.com/86cdd6610c0cf1e23982494f82b785fa9b9c6be8482d9f40f37c9a8a118cd851/68747470733a2f2f692e696d6775722e636f6d2f6144394530466c2e706e67) + +### Speed Color Code + +🟩 Green represents slow rotation less than `30 RPM`. + +🟦 Blue represents moderate rotation greater than or equal to `30 RPM - 99 RPM`. + +🟪 Purple represents fast rotation greater than or equal to `100 RPM`. + +### Generator Stats + +Looking at a kinetic component which produces rotational force will display the base stress capacity produced by that generator and the stress capacity produced by that generator at the current RPM. + +![Generators](https://camo.githubusercontent.com/807618a032e72481327cd36afae0b1708f9afa0543f4b327ce64a63f07c34fef/68747470733a2f2f692e696d6775722e636f6d2f4f5833317668552e706e67) + +### Kinetic Stats + +Looking at a kinetic component which consumes rotational force will display the base stress impact of that component and the stress impact of that component at the current RPM. + +![Kinetic Stats](https://camo.githubusercontent.com/1be7480639896d9e4547e5fa12eb80d462dfdecaf2748edff582305671f4beb3/68747470733a2f2f692e696d6775722e636f6d2f7247346a4749592e706e67) diff --git a/users/utility/pondering.md b/users/utility/pondering.md new file mode 100644 index 0000000..91ee0a3 --- /dev/null +++ b/users/utility/pondering.md @@ -0,0 +1,49 @@ +# Pondering + +Pondering is an in-game guide system that allows the player to quickly get information about Create blocks. The pondering screen shows an example contraption that explains the functions of the block. + +![Ponder](../assets/ponder_logo.png) + +## Usage + +The full Ponder Index can be accessed through the Create menu by clicking the Engineer's Goggles icon in the pause menu. + +An item can be Pondered by hovering over it in your inventory and holding forward ("W" by default) until the bar below the item is filled up. This displays an animated infographic about the item being pondered. + +## Keybinds + +The keybinds for ponder are the same as those for certain player actions. + +| Keybind | Action | +| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Q** | Activate **Identify Mode**. This pauses the current ponder scene. Hovering over Create elements shows the name of the block and gives the option to ponder those elements. | +| **S** | Restart the current animation. | +| **A** or **D** | Go backwards or forwards a scene (if available). | +| **E** | Close the animation. | + +Comfy Reading does not currently have a keybind, but can be enabled by tapping the button in the bottom right. This slows down the entire animation to help read the text boxes. + +## Navigation + +While Pondering, similar or relevant machines can be viewed by clicking the icon to the left or activating identify mode and holding W over a visible component. After moving away from the initially pondered item, the option to "Think Back" can be found at the bottom left. The player can skip to specific parts of an animation by clicking different sections of the gray bar at the bottom. + +## Categories + +Ponder scenes are sorted into different categories based on the pondered blocks usage and function. The different categories are: + +| Category | Description | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------- | +| Kinetic Blocks | Components which help relaying Rotational Force elsewhere | +| Kinetic Sources | Components which generate Rotational Force | +| Kinetic Appliances | Components which make use of Rotational Force | +| Fluid Manipulators | Components which help relaying and making use of Fluids | +| Item Transportation | Components which help moving items around | +| Logic Components | Components which help with Redstone Engineering | +| Creative Mode | Components not usually available in Survival Mode | +| Movement Anchors | Components which allow the creation of moving Contraptions, animating an attached structure in a variety of ways. | +| Contraption Actors | Components which expose special behavior when attached to a Contraption. | +| Block Attachment Utility | Tools and Components used to assemble structures moved as an animated Contraption. | +| Railway Equipment | Components used in the construction or management of Train contraptions | +| Recent Changes | Components that have been added or changed significantly in recent versions of create | + +Mod authors and pack developers can add their own Ponder categories for their own purposes as well. diff --git a/users/utility/rotation.md b/users/utility/rotation.md new file mode 100644 index 0000000..2783755 --- /dev/null +++ b/users/utility/rotation.md @@ -0,0 +1,46 @@ +# Rotational Force + +Rotational Force is what powers the various machines and the contraptions in the Create mod. + +## Speed + +Speed refers to how quickly a rotational component is spinning; it is measured in Rotations Per Minute (RPM) and can be seen with a Speedometer. The maximum rotation speed of a component is 256 RPM by default (configurable). Any component added to step up speed further, such as a cogwheel on a large cogwheel, will break off. + +Speed can be controlled through several means: + +- A Cogwheel and a Large Cogwheel can be connected together diagonally. One rotation of the large cogwheel is equivalent to 2 rotations of the small one, so the small one will always rotate twice as fast as the large one. +- A Rotation Speed Controller with a large cogwheel can easily change the speed and direction of any input. +- An Adjustable Chain Gearshift can change the speed of Encased Chain Drives connected to it based on redstone signal. + +Higher speeds proportionally raise the stress requirement of a mechanical component. Twice the RPM produces twice the stress. + +## Kinetic Stress + +Stress networks can be combined as long as they rotate in the same direction and speed where they meet. + +Stress is the amount of energy mechanical components need to run and is shared across all components that are connected together in a network; it is measured in Stress Units (SU). The stress requirement or production of a certain component can be seen by looking at it wearing Engineer's Goggles and the total stress of a network can be measured with a Stressometer. + +Each network has a total amount of stress units available to work with, which can be produced by Generators such as: + +- Hand Crank +- Water Wheel +- Windmill Bearing +- Steam Engine + +Mechanical components utilize a certain amount of the SU available to the network depending on their type and the speed they're working at. If more Stress Units are used than are available to the network, it will become overstressed and stop entirely until more stress capacity is added or stress-generating components are removed. + +## Transfer + +There are several ways to transfer rotational energy: + +- Shaft - Transfers rotational force in a straight line. Some components have Shafts built in. +- Cogwheel - Inverts force, doubles or halves speed, can rotate axis 90 degrees. Some components have small cogwheels built in. +- Mechanical Belt - Relay rotation between 2 or more Shafts. +- Encased Chain Drive - Relays rotation, can rotate axis 90 degrees. +- Adjustable Chain Gearshift - When used with an Analog Lever, can manipulate speed between doubling or halving it. +- Gearbox - A miniature version of four connected Large Cogwheels. +- Clutch - Stops outgoing rotation when powered with Redstone. +- Gearshift - Inverts outgoing rotation when powered with Redstone. +- Gantry Carriage - Can move along a line of Gantry Shafts and outputs the rotational force when the shaft is powered with Redstone. +- Sequenced Gearshift - Allows for sequences of specific amounts of rotation. +- Rotation Speed Controller - Outputs a specified speed and direction of rotation.