Skip to content

Commit 2a204cb

Browse files
committed
Reworked Readme
1 parent 47485b4 commit 2a204cb

File tree

4 files changed

+164
-132
lines changed

4 files changed

+164
-132
lines changed

README.md

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,53 @@
55
![Minecraft](https://img.shields.io/badge/minecraft-1.21.5-green?link=https%3A%2F%2Fwww.minecraft.net%2F)
66
![GitHub Downloads](https://img.shields.io/github/downloads/lambda-client/lambda/total)
77
![Discord](https://img.shields.io/discord/834570721070022687?logo=Discord&logoColor=white&link=https%3A%2F%2Fdiscord.gg%2FMBAEzyFn)
8-
![CodeFactor grade](https://img.shields.io/codefactor/grade/github/lambda-client/lambda?color=royalblue)
9-
![GitHub workflow status](https://img.shields.io/github/actions/workflow/status/lambda-client/lambda/build.yml?branch=1.21.5&logo=gradle)
10-
![GitHub contributors](https://img.shields.io/github/contributors/lambda-client/lambda)
11-
![GitHub Repo stars](https://img.shields.io/github/stars/lambda-client/lambda)
8+
![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/lambda-client/lambda?color=royalblue)
9+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lambda-client/lambda/build.yml?branch=1.21.5&logo=gradle)
10+
![GitHub Contributors](https://img.shields.io/github/contributors/lambda-client/lambda)
11+
![GitHub Repo Stars](https://img.shields.io/github/stars/lambda-client/lambda)
1212
![GitHub License](https://img.shields.io/github/license/lambda-client/lambda?logo=gplv3&link=https%3A%2F%2Fwww.gnu.org%2Flicenses%2Fgpl-3.0.en.html)
1313

14-
Lambda is a free, open-source Minecraft Fabric utility mod focused on advanced automation to execute complex, repeatable tasks with minimal micromanagement.
14+
Lambda is a free, open-source Minecraft Fabric utility mod focused on advanced automation to execute complex, repeatable tasks with minimal micromanagement. This is a complete, ground-up rewrite of the original client that you can find here: [Lambda Legacy](https://github.com/lambda-client/lambda).
1515

1616
<p align="center">
17-
<a href="https://github.com/lambda-client/lambda/releases/download/1.0.0/lambda-1.0.0.jar"><img alt="lambda-1.0.0.jar" src="https://raw.githubusercontent.com/lambda-client/assets/main/download_button_1.0.0.png" width="70%" height="70%"></a>
17+
<a href="https://github.com/lambda-client/lambda/releases/download/0.0.1/lambda-0.0.1.jar"><img alt="lambda-0.0.1.jar" src="https://raw.githubusercontent.com/lambda-client/assets/main/download_button_0.0.1.png" width="70%" height="70%"></a>
1818
</p>
1919

2020
<p align="center">
2121
<a href="https://discord.gg/MBAEzyFn"><img src="https://invidget.switchblade.xyz/MBAEzyFn" alt="Link to the lambda discord server https://discord.gg/MBAEzyFn"></a>
2222
</p>
2323

24-
Find our matrix space at [#lambda-client:matrix.org](https://app.element.io/#/room/#lambda-client:matrix.org).
24+
Find our backup matrix space at [\#lambda-client:matrix.org](https://app.element.io/#/room/#lambda-client:matrix.org).
25+
26+
> [\!WARNING]
27+
> **Alpha Status:** This version of Lambda is a complete rewrite (2+ years in the making) and is currently in an **Alpha** state. While highly capable, please expect bugs and incomplete features as we progress toward Beta. Old addons are not compatible with this version.
28+
29+
-----
30+
31+
## Features
32+
33+
### Automation Engine
34+
* **Build Engine:** Full integration with **Litematica** and schematic files for seamless automated building.
35+
* **Block State Handling:** The build engine natively supports special block states including rotations, attachments (doors, signs, bells), half-slabs, stairs, repeater delay, and even edge cases like flower pots with plants.
36+
* **Conflict-Free Orchestration:** A centralized manager system handles all core interactions (placing, breaking, rotating, inventory) to ensure zero conflicts between concurrently running modules.
37+
38+
### Unmatched Performance
39+
* **High-Speed ESP:** Rendering is optimized to handle extreme scenarios—capable of visualizing all obsidian at the 2b2t spawn without dropping frames.
40+
* **Modern Framework:** Built on modern modding frameworks with efficient rendering pipelines that outperform legacy clients.
41+
42+
### Sophisticated User Experience
43+
* **Fine-Grained Control:** Access over **1000+ settings**, allowing you to tune every aspect of the client to your exact needs.
44+
* **Advanced GUI:** The **Dear ImGui** interface is designed for clarity and depth, featuring quick search, context menus, and easy keybind editing.
45+
* **Automation Profiles:** Use linkable presets to apply complex configurations across multiple modules instantly.
46+
47+
### Stability & Safety
48+
* **Anticheat Ready:** Built with **Grim** and other modern anticheats in mind.
49+
* **Type-Safe Commands:** Uses Minecraft's statically typed command system to ensure input accuracy and reliability.
50+
51+
### Specialized Tools
52+
* **HighwayTools:** Completely rewritten for efficient infrastructure maintenance.
53+
54+
-----
2555

2656
## Installation
2757
<a href="https://fabricmc.net/wiki/install"><img src="https://cdn.jonasjones.dev/mod-badges/support-fabric.png" width="150px" alt="Fabric Supported"></a>
@@ -30,19 +60,19 @@ Find our matrix space at [#lambda-client:matrix.org](https://app.element.io/#/ro
3060
3. Get the latest Lambda version here [(download)](https://github.com/lambda-client/lambda/releases/download/1.0.0/lambda-1.0.0.jar)
3161
4. Put the file in your `.minecraft/mods` folder
3262

33-
## FAQ
63+
## Getting Started
3464

3565
How do I...
3666

3767
<details>
38-
<summary>... open the ClickGUI?</summary>
68+
<summary><strong>... open the ClickGUI?</strong></summary>
3969

4070
> Press `Y`.
4171
4272
</details>
4373

4474
<details>
45-
<summary>... execute a command?</summary>
75+
<summary><strong>... I execute a command?</strong></summary>
4676

4777
> Use the ingame chat with the prefix `;`.
4878
@@ -56,11 +86,13 @@ How do I...
5686

5787
[![GitHub contributors](https://contrib.rocks/image?repo=lambda-client/lambda)](https://github.com/lambda-client/lambda/graphs/contributors)
5888

89+
We need the help of the community to support the growth of this project. Whether that be developers contributing to the codebase, creating addons, or users giving feedback.
90+
5991
---
6092

6193
If you have any questions, concerns, or suggestions,
6294
you can visit our [official Discord server](https://discord.gg/MBAEzyFn).
6395

6496
> ### Disclaimer
6597
> Lambda is not affiliated with Mojang Studios. Minecraft is a registered trademark of Mojang Studios.
66-
Use of the Lambda software is subject to the terms outlined in the license agreement [GNU General Public License v3.0](https://github.com/lambda-client/lambda/blob/master/LICENSE.md).
98+
Use of the Lambda software is subject to the terms outlined in the license agreement [GNU General Public License v3.0](https://github.com/lambda-client/lambda/blob/master/LICENSE.md).

src/main/kotlin/com/lambda/interaction/construction/simulation/processing/PlacementProcessor.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,19 @@ import net.minecraft.util.math.BlockPos
2626
* optimize how blocks are simulated. Some blocks might only be placeable on certain sides, so it is
2727
* unnecessary to scan all of them, for example.
2828
*/
29-
3029
interface StateProcessor {
3130
fun acceptsState(state: BlockState, targetState: BlockState): Boolean
31+
3232
context(safeContext: SafeContext)
33-
fun com.lambda.interaction.construction.simulation.processing.PreProcessingInfoAccumulator.preProcess(state: BlockState, targetState: BlockState, pos: BlockPos)
33+
fun PreProcessingInfoAccumulator.preProcess(state: BlockState, targetState: BlockState, pos: BlockPos)
3434
}
3535

3636
interface PropertyPreProcessor {
3737
fun acceptsState(targetState: BlockState): Boolean
38-
fun com.lambda.interaction.construction.simulation.processing.PreProcessingInfoAccumulator.preProcess(state: BlockState, targetState: BlockState)
38+
fun PreProcessingInfoAccumulator.preProcess(state: BlockState, targetState: BlockState)
3939
}
4040

4141
interface PropertyPostProcessor {
4242
fun acceptsState(state: BlockState, targetState: BlockState): Boolean
43-
fun com.lambda.interaction.construction.simulation.processing.PreProcessingInfoAccumulator.preProcess(state: BlockState, targetState: BlockState)
43+
fun PreProcessingInfoAccumulator.preProcess(state: BlockState, targetState: BlockState)
4444
}

src/main/kotlin/com/lambda/interaction/construction/simulation/processing/PreProcessingInfo.kt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,38 @@ import net.minecraft.util.math.BlockPos
2727
import net.minecraft.util.math.Direction
2828

2929
interface PreProcessingInfo {
30-
val surfaceScan: SurfaceScan
31-
val ignore: Set<Property<*>>
32-
val sides: Set<Direction>
30+
val surfaceScan: SurfaceScan
31+
val ignore: Set<Property<*>>
32+
val sides: Set<Direction>
3333
val item: Item?
3434
val expectedState: BlockState
3535
val placing: Boolean
3636
val noCaching: Boolean
3737

38-
companion object {
39-
context(_: AutomatedSafeContext)
40-
fun default(targetState: TargetState, pos: BlockPos) = object : PreProcessingInfo {
38+
companion object {
39+
context(_: AutomatedSafeContext)
40+
fun default(targetState: TargetState, pos: BlockPos) = object : PreProcessingInfo {
4141
override val surfaceScan = SurfaceScan.DEFAULT
42-
override val ignore = setOf<Property<*>>()
43-
override val sides = Direction.entries.toSet()
44-
override val item = targetState.getStack(pos).item
45-
override val expectedState = targetState.getState(pos)
46-
override val placing = true
47-
override val noCaching = true
42+
override val ignore = setOf<Property<*>>()
43+
override val sides = Direction.entries.toSet()
44+
override val item = targetState.getStack(pos).item
45+
override val expectedState = targetState.getState(pos)
46+
override val placing = true
47+
override val noCaching = true
4848
}
49-
}
49+
}
5050
}
5151

5252
class PreProcessingInfoAccumulator(
5353
override var expectedState: BlockState,
5454
override var item: Item?,
5555
override var surfaceScan: SurfaceScan = SurfaceScan.DEFAULT,
56-
override val ignore: MutableSet<Property<*>> = _root_ide_package_.com.lambda.interaction.construction.simulation.processing.ProcessorRegistry.postProcessedProperties.toMutableSet(),
56+
override val ignore: MutableSet<Property<*>> = ProcessorRegistry.postProcessedProperties.toMutableSet(),
5757
override val sides: MutableSet<Direction> = Direction.entries.toMutableSet(),
5858
override var placing: Boolean = true,
5959
override var noCaching: Boolean = false,
6060
var omitPlacement: Boolean = false
61-
) : com.lambda.interaction.construction.simulation.processing.PreProcessingInfo {
61+
) : PreProcessingInfo {
6262
@InfoAccumulator
6363
fun offerSurfaceScan(scan: SurfaceScan) {
6464
if (scan.mode.priority > surfaceScan.mode.priority) {
@@ -110,7 +110,7 @@ class PreProcessingInfoAccumulator(
110110
}
111111

112112
@InfoAccumulator
113-
fun complete(): com.lambda.interaction.construction.simulation.processing.PreProcessingInfo = this
113+
fun complete(): PreProcessingInfo = this
114114

115115
companion object {
116116
@DslMarker

0 commit comments

Comments
 (0)