Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecymaera/minecraft-spider
https://github.com/thecymaera/minecraft-spider
minecraft
Last synced: about 18 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/thecymaera/minecraft-spider
- Owner: TheCymaera
- Created: 2024-03-20T11:57:35.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-22T11:24:33.000Z (5 days ago)
- Last Synced: 2024-12-22T12:23:25.828Z (5 days ago)
- Topics: minecraft
- Language: Kotlin
- Homepage:
- Size: 241 KB
- Stars: 410
- Watchers: 11
- Forks: 26
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spider
## Introduction
This plugin was developed for a video series about procedural animations.
1. Procedural Walking Animation: https://youtu.be/Hc9x1e85L0w
2. Procedural Galloping Animation: https://youtu.be/r70xJytj0sw
3. Procedurally Animated Robots: https://youtu.be/PSnPOYeTW-0
This plugin is very experimental and untested in multiplayer. Use at your own risk.
## Installation
1. Download the JAR from the [releases page](https://github.com/TheCymaera/minecraft-spider/releases/).
2. Set up a [Paper](https://papermc.io/downloads) or [Spigot](https://getbukkit.org/download/spigot) server. (Instructions below)
3. Add the JAR to the `plugins` folder.
4. Download the world folder from [Planet Minecraft](https://www.planetminecraft.com/project/spider-garden/).
5. Place the world folder in the server directory. Name it `world`.
## Running a Server
1. Download a 1.21 server JAR from [Paper](https://papermc.io/downloads) or [Spigot](https://getbukkit.org/download/spigot).
2. Run the following command `java -Xmx1024M -Xms1024M -jar server.jar nogui`.
3. I typically use the Java runtime bundled with my Minecraft installation so as to avoid version conflicts.
- In Modrinth, you can find the Java runtime location inside the profile options menu.
4. Accept the EULA by changing `eula=false` to `eula=true` in the `eula.txt` file.
5. Join the server with `localhost` as the IP address.
## Commands
Autocomplete will show available options.
Get control items:
```
/items
```
Load preset:
```
/preset
/preset hexbot 1 4
```
Load torso or leg model
```
/torso_model
/leg_model
```
Modify or get options
```
/options gait maxSpeed 3
/options gait maxSpeed
```
Scale the spider
```
/scale 2
```
Play splay animation (Spider must be spawned)
```
/splay
```
Change eye or blinking lights palette
```
/animated_palette eye cyan_blinking_lights
/animated_palette blinking_lights red_blinking_lights
# Custom palette (block_id, block_brightness, sky_brightness)+
/animated_palette eye custom minecraft:stone 15 15 minecraft:redstone_block 15 15
```
Fine-grained model modification
```
/modify_model <...selectors> <...operations>
# Selectors can be either a block id or a tag
# e.g. Select all cloaks in the torso
/modify_model cloak torso ...
# e.g. Select diamond blocks and netherite blocks
/modify_model minecraft:diamond_block or minecraft:netherite_block ...
# Set block
/modify_model cloak set_block minecraft:gray_concrete
# Set brightness
/modify_model cloak brightness 0 7
# Copy block from the world
/modify_model cloak copy_block ~ ~1 ~
```
Stealth Variant Example:
```
/torso_model stealth
/scale 1.3
/modify_model cloak set_block minecraft:gray_concrete
/modify_model cloak or minecraft:netherite_block or minecraft:cauldron or minecraft:anvil or minecraft:gray_shulker_box brightness 0 7
# You may need to pick a different brightness depending on your shaders
```
Copy block examples used in the video:
```
/modify_model cloak torso copy_block ~ ~1 ~
/modify_model cloak tibia copy_block ~ ~1 ~
/modify_model cloak tip copy_block ~ ~1 ~
```
## Development
1. Clone or download the repo.
2. Run Maven `package` to build the plugin. The resulting JAR will be in the `target` folder.
3. For convenience, set up a symlink and add the link to the server `plugins` folder.
- Windows: `mklink /D newFile.jar originalFile.jar`
- Mac/Linux: `ln -s originalFile.jar newFile.jar `
## License
You may use the plugin and source code for both commercial or non-commercial purposes.
Attribution is appreciated but not due.
Do not resell without making substantial changes.