https://github.com/encodeous/virtualedit
Fast client-side world editing library
https://github.com/encodeous/virtualedit
Last synced: 6 months ago
JSON representation
Fast client-side world editing library
- Host: GitHub
- URL: https://github.com/encodeous/virtualedit
- Owner: encodeous
- License: mit
- Created: 2021-12-31T17:44:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-14T19:17:47.000Z (about 3 years ago)
- Last Synced: 2023-03-03T22:31:33.131Z (almost 3 years ago)
- Language: Java
- Homepage:
- Size: 238 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `VirtualEdit`
*Who said Minecraft worlds have to be real?*
**VirtualEdit** is a *library* for Paper that allows developers to display/hide blocks to/from players client-side. It is able to make gigantic visual edits to the world without breaking a sweat.
### VirtualEdit is useful for:
* Mini-game development by allowing for more creative game design...
- Imagine a parkour that only some players can see
- Making a wall solid for one player, and completely invisible for another.
* Performing non-destructive edits on the world...
*Imagine that your neighbour has a very ugly house that you don't want to see.* With VirtualEdit, you can create a plugin that allows players to hide their neighbours' houses without their neighbours even realising.
* Visualizing builds...
- Want see how a woodland mansion looks in the nether? You can with VirtualEdit!
- Maybe you want to see a `200,000` x `200` x `200,000` block of sponge for some reason...
* And more! (I can't be bothered to think of more use cases. Feel free to make a PR with other cool ideas!)
## `Usage`
Just to reiterate. `VirtualEdit` is a *library* designed for **developers**. It is not a plugin that can be used independently on a server. Other developers are free to create plugins that use VirtualEdit for their own use-cases, like the ones mentioned above.
## `Dependencies`
`VirtualEdit` depends on the following:
- Paper (Bukkit and Spigot are not supported)
- ProtocolLib
### `Maven`
#### Add JitPack as a repository
```xml
jitpack.io
https://jitpack.io
```
#### Add VirtualEdit as a dependency
```xml
com.github.encodeous
VirtualEdit
master-SNAPSHOT
```