https://github.com/jbangdev/jbang-minecraft
https://github.com/jbangdev/jbang-minecraft
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jbangdev/jbang-minecraft
- Owner: jbangdev
- Created: 2020-12-20T00:45:37.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T11:45:07.000Z (about 2 years ago)
- Last Synced: 2025-04-19T11:42:09.339Z (11 months ago)
- Language: Java
- Homepage:
- Size: 10.7 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## JBang with Minecraft
[](#contributors-)
This is a work in progress in trying to see how to make
Minecraft launching and development easier with jbang.
Currently using [sponge](https://www.spongepowered.org) as it seemed
to be the Minecraft server with the best documentation and least
amount of "hacks".
Requirements: Nothing. This will download jbang and java when needed.
### Run Minecraft
If you do not have jbang installed you can run the following:
```shell
curl -sL https://sh.jbang.dev | bash -s -- app setup && jbang sponge@jbangdev/jbang-minecraft
```
if on Windows it is:
```shell
iex "& { $(iwr https://ps.jbang.dev) } app setup"
jbang sponge@jbangdev/jbang-minecraft
```
When you have [jbang](https://jbang.dev) installed you can just run:
```shell
jbang sponge@jbangdev/jbang-minecraft
```
or if you want to run the spongevanilla jar directly - this has the advantage of a simpler classpath; but disadvantage
is that you need to have to specify a very long url and it will not setup `eula.txt`:
```
jbang --java 8 https://repo.spongepowered.org/maven/org/spongepowered/spongevanilla/1.12.2-7.3.0/spongevanilla-1.12.2-7.3.0.jar
```
To run with debugging just add `--debug`, as in `jbang --debug ...` and connect a debugger on port 4004.
### Write a Minecraft plugin
Note: You do not need to run Minecraft with jbang to develop a plugin with jbang. It is completely independent.
Given a Sponge Minecraft install do the following:
```
cd mods
jbang init ExamplePlugin.java
jbang edit --open=code ExamplePlugin.java
```
Then paste the following into the newly created file, overwriting its contents:
```java
//REPOS sponge=https://repo.spongepowered.org/maven
//DEPS org.spongepowered:spongeapi:7.2.0
//JAVA 8
import java.util.Optional;
import org.spongepowered.api.entity.living.player.Player;
import org.spongepowered.api.event.EventListener;
import org.spongepowered.api.event.action.CollideEvent;
import org.spongepowered.api.text.Text;
import org.spongepowered.api.plugin.Plugin;
import org.spongepowered.api.plugin.Plugin;
import org.spongepowered.api.event.Listener;
import org.spongepowered.api.event.game.state.GameStartedServerEvent;
// Imports for logger
import com.google.inject.Inject;
import org.slf4j.Logger;
@Plugin(id = "exampleplugin", name = "Example Plugin", version = "1.0", description = "Example")
public class ExamplePlugin {
@Inject
private Logger logger;
@Listener
public void onServerStart(GameStartedServerEvent event) {
logger.info("Successfully running ExamplePlugin!!!");
}
int counter = 0;
@Listener
public void handle(CollideEvent event) {
logger.info("colliding: " + counter++);
Optional playerOptional = event.getCause().first(Player.class);
playerOptional.ifPresent(player -> {
player.sendMessage(Text.builder("boing").build());
});
}
}
```
It is a very dumb/simple plugin that will just print out to console on every collide event.
Now, to get it build and made visible to sponge simple export the jar:
```
jbang export ExamplePlugin.java
```
You should now have `mods\ExamplePlugin.jar`.
Now restart your Minecraft Server and you should see it start and keep counting up.
For every change you will do the same, export the jar and then restart the server.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
