Skip to content

Revamped the README and fixed grammer and punctuation. #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2022
Merged

Revamped the README and fixed grammer and punctuation. #389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ How do I...
<details>
<summary>... open the ClickGUI?</summary>

> Press `Y`
> Press `Y`.

</details>

<details>
<summary>... execute a command?</summary>

> Use the ingame chat with the prefix `;`
> Use the ingame chat with the prefix `;`.

</details>

Expand All @@ -55,15 +55,15 @@ How do I...
<details>
<summary>... export KAMI blue config to Lambda?</summary>

> Rename `.minecraft/kamiblue` to `.minecraft/lambda`
> Note that this might cause stability issues.
> Rename `.minecraft/kamiblue` to `.minecraft/lambda`.
> Please note that this might cause stability issues.

</details>

<details>
<summary>... fix most crashes on startup?</summary>

> Possibly you have multiple mods loaded. Forge loads mods in alphabetical order, so you can change the name of the Mod jar to make it load earlier or later. Add for example an exclamation mark to lambda jar to make it load first.
> You may have multiple mods loaded. Forge loads mods in alphabetical order, so you can change the name of the Mod jar to make it load earlier or later. Add for example an exclamation mark to lambda jar to make it load first.
> If you got `Error: java.lang.IllegalAccessError: tried to access field net.minecraft.util.math.Vec3i.field_177962_a from class baritone.k` remove the `-noverify` tag from your arguments.

</details>
Expand All @@ -72,21 +72,21 @@ How do I...
<summary>... fix problems with Gradle?</summary>

> Make sure you have a Java 8 JDK installed and in your PATH.
We recommend using the [Temurin](https://adoptium.net/?variant=openjdk8&jvmVariant=hotspot/) distribution of OpenJDK
We advise using the [Temurin](https://adoptium.net/?variant=openjdk8&jvmVariant=hotspot/) distribution of OpenJDK.

</details>

<details>
<summary>... reset the ClickGUI scale?</summary>

> Run the command `;set clickgui scale 100`
> Run the command `;set clickgui scale 100`.

</details>

<details>
<summary>... crashing with liteloader?</summary>

> Use liteloader as a forge mod, it is available [here](https://jenkins.liteloader.com/view/1.12.2/job/LiteLoader%201.12.2/lastSuccessfulBuild/artifact/build/libs/liteloader-1.12.2-SNAPSHOT-release.jar)
> Use liteloader as a forge mod, it is available [here](https://jenkins.liteloader.com/view/1.12.2/job/LiteLoader%201.12.2/lastSuccessfulBuild/artifact/build/libs/liteloader-1.12.2-SNAPSHOT-release.jar).
</details>

<p align="center">
Expand All @@ -103,24 +103,24 @@ git clone https://github.com/lambda-client/lambda
```

Run `setupWorkspace.sh` to initialize the environment.
With terminal on Linux or [Git Bash](https://gitforwindows.org/) for Windows
Use your terminal on Linux or [Git Bash](https://gitforwindows.org/) for Windows.
```
./setupWorkspace.sh
```

### Setup IDE

In this guide we will use [IntelliJ IDEA](https://www.jetbrains.com/idea/) as IDE.
In this guide we will use [IntelliJ IDEA](https://www.jetbrains.com/idea/) as our IDE.
1. Open the project from `File > Open...`
2. Let the IDE collect dependencies and index the code.
3. Goto `File > Project Structure... > SDKs` and make sure an SDK for Java 8 is installed and selected, if not download
it [here](https://adoptium.net/?variant=openjdk8&jvmVariant=hotspot/)
one [here](https://adoptium.net/?variant=openjdk8&jvmVariant=hotspot/).

### Gradle build

Test if the environment is set up correctly by building the client and run it inside IDE using the Gradle tab on the right side of the IDE.
Test if the environment is set up correctly by building the client and running it inside the IDE using the Gradle tab on the right side of the IDE.
1. Go to `lambda > Tasks > build > runClient` in the Gradle tab and run the client.
2. To build the client as a jar run `lambda > Tasks > build > build`. Gradle will create a new directory called `build`. The final built jar will be in `build/libs`
2. To build the client as a jar run `lambda > Tasks > build > build`. Gradle will create a new directory called `build`. The final built jar will be in `build/libs`.

## Thanks to

Expand Down