Skip to content

Commit cff09b3

Browse files
author
Doogie13
committed
long jump
1 parent 135bd60 commit cff09b3

7 files changed

Lines changed: 41 additions & 216 deletions

File tree

README.md

Lines changed: 2 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,3 @@
1-
# Lambda Plugin SDK
1+
#LongJump
22

3-
This project in an example to show how a proper plugin for [Lambda Client](https://github.com/lambda-client/lambda) is set up.
4-
The advantage of plugins for a utility mod is that they allow the user to decide what features their personalized client will have. Plugins work in plug and play manner, and can be downloaded and activated inside the ingame menu without reloading the client as long as no mixins are used for the plugin.
5-
If you are scared about the Kotlin in this project be aware that Kotlin is a wrapper language for Java. That means that plugins can also be natively written in Java.
6-
7-
## Setup
8-
9-
To achieve coding building and publishing your own plugin most of the following steps are required.
10-
11-
### Fork
12-
This is a template repository and can be used as a base to create a custom plugin. Press the `Use as template` button on GitHub to automatically create a linked fork to this repository.
13-
14-
### Clone Repository
15-
16-
Clone the repository to your local machine. Use the link of either your fork or the main repository.
17-
```
18-
git clone https://github.com/lambda-client/plugin-sdk
19-
```
20-
21-
### Setup IDE
22-
23-
In this guide we will use [IntelliJ IDEA](https://www.jetbrains.com/idea/) as IDE.
24-
1. Open the project from `File > Open...`
25-
2. Let the IDE collect dependencies and index the code.
26-
3. Goto `File > Project Structure... > SDKs` and make sure an SDK for Java 8 is installed and selected, if not download
27-
it [here](https://adoptopenjdk.net/index.html?variant=openjdk8&jvmVariant=hotspot)
28-
4. Run the `genIntellijRuns` Gradle task, or run `./gradlew genIntellijRuns`
29-
30-
### Configure Gradle
31-
32-
Test if the environment is set up correctly by building the plugin jar using the Gradle tab on the right side of the IDE.
33-
1. Go to `PluginExample > Tasks > build > jar` in the Gradle tab and run the script
34-
2. IntelliJ will create a new directory called `build`. The final built jar will be in `build/libs`
35-
36-
### Config
37-
38-
Configure the metadata of your plugin in `plugin_info.json`.
39-
The flag `main_class` must contain the target main class `Plugin` in this case it is `PluginExample.kt`
40-
41-
### Plugin
42-
43-
The plugin main class will act as a register for the functions a plugin can provide.
44-
For example when a new module class is created you have to add this to the `onLoad()` function of the plugin class.
45-
```
46-
modules.add(ModuleExample)
47-
```
48-
Every service is required to be added to the main class in order to index the contents.
49-
50-
### PluginModule
51-
52-
A module represents a utility module inside the game.
53-
The `PluginModule` class acts as a wrapper for `Module` class. For many examples on how a module can work check out the [native modules](https://github.com/lambda-client/lambda/tree/master/src/main/kotlin/com/lambda/client/module/modules) of lambda, or the given example in this project.
54-
The difference from the native `Module` class is that each component of a plugin requires a reference to the main `Plugin` class.
55-
```
56-
pluginMain = PluginExample
57-
```
58-
Every PluginModule class will need to be registered to the main plugin class
59-
60-
### ClientCommand
61-
62-
Plugins use the same class as the native client for registering commands. Feel free to check out the [commands of Lambda Client](https://github.com/lambda-client/lambda/tree/master/src/main/kotlin/com/lambda/client/command/commands) as a reference.
63-
64-
### PluginLabelHud
65-
66-
A LabelHud is used to display information in the player GUI.
67-
The `PluginLabelHud` class acts as a wrapper for `LabelHud` class. For many examples on how a hud can work check out the [native hud elements](https://github.com/lambda-client/lambda/tree/master/src/main/kotlin/com/lambda/client/gui/hudgui/elements) of lambda, or the given example in this project.
68-
The difference to the native `LabelHud` class is that a referral to the main plugin class is given in the object data.
69-
```
70-
pluginMain = PluginExample
71-
```
72-
Every `PluginLabelHud` class will need to be registered to the main `Plugin` class.
73-
74-
### Background Jobs
75-
76-
If coroutines are needed background jobs can be registered using
77-
```
78-
bgJobs.add(BackgroundJob)
79-
```
80-
81-
### Mixin
82-
Example coming soon. Plugin won't be able to hot reload anymore because mixins need to be triggered on client start.
83-
84-
### Build
85-
86-
1. Go to `PluginExample > Tasks > build > jar` in the Gradle tab and run the script
87-
2. IntelliJ will create a new directory called `build` the final built jar will be in `build/libs`
88-
3. Put the `ExamplePlugin-1.0.jar` into your `./minecraft/lambda/plugins` folder and run the game.
89-
90-
### Publish (coming soon)
91-
92-
Insert the link of your created fork into the plugin manager to load the plugin, or transfer your repository to official
93-
plugin [organization of Lambda](https://github.com/lambda-plugins/). After review, your plugin may get added to the native
94-
marketplace.
3+
for cool kids

src/main/kotlin/CommandExample.kt

Lines changed: 0 additions & 27 deletions
This file was deleted.

src/main/kotlin/LabelHudExample.kt

Lines changed: 0 additions & 17 deletions
This file was deleted.

src/main/kotlin/LongJump.kt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import com.lambda.client.event.events.PlayerTravelEvent
2+
import com.lambda.client.module.Category
3+
import com.lambda.client.module.modules.player.LagNotifier
4+
import com.lambda.client.plugin.api.PluginModule
5+
import com.lambda.client.util.threads.safeListener
6+
7+
internal object LongJump : PluginModule(
8+
name = "ModuleExample",
9+
category = Category.MISC,
10+
description = "LongJump",
11+
pluginMain = LongJumpController
12+
) {
13+
private val farSpeed by setting("Speed", 1.0f, 0.0f..10.0f, 0.1f, description = "Long Jump Factor")
14+
private val disableOnRubberband by setting("Rubberband disable", false)
15+
16+
init {
17+
safeListener<PlayerTravelEvent> {
18+
19+
if (mc.player.motionY == 0.0030162615090425808) {
20+
21+
mc.player.jumpMovementFactor = farSpeed
22+
23+
}
24+
25+
if (LagNotifier.paused && disableOnRubberband) {
26+
27+
disable()
28+
29+
}
30+
31+
}
32+
}
33+
}
Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
import com.lambda.client.plugin.api.Plugin
22

3-
internal object PluginExample: Plugin() {
3+
internal object LongJumpController: Plugin() {
44

55
override fun onLoad() {
66
// Load any modules, commands, or HUD elements here
7-
modules.add(ModuleExample)
8-
commands.add(CommandExample)
9-
hudElements.add(LabelHudExample)
7+
modules.add(LongJump)
108
}
119

1210
override fun onUnload() {

src/main/kotlin/ModuleExample.kt

Lines changed: 0 additions & 70 deletions
This file was deleted.
Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
{
2-
"name": "PluginExample",
2+
"name": "LongJump",
33
"version": "1.0",
44
"authors": [
5-
"me",
6-
"you"
5+
"Doogie13"
76
],
8-
"description": "does absolutely nothing",
7+
"description": "zoom",
98
"url": "",
109
"min_api_version": "2.05.01",
1110
"required_plugins": [],
12-
"main_class": "PluginExample",
11+
"main_class": "LongJumpController",
1312
"hot_reload": true
1413
}

0 commit comments

Comments
 (0)