Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emortaldev/blockscreen
Screencast using Minecraft blocks using Minestom!
https://github.com/emortaldev/blockscreen
minestom minestom-server
Last synced: about 1 month ago
JSON representation
Screencast using Minecraft blocks using Minestom!
- Host: GitHub
- URL: https://github.com/emortaldev/blockscreen
- Owner: emortaldev
- License: mit
- Created: 2022-03-14T18:27:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T02:22:32.000Z (about 1 year ago)
- Last Synced: 2024-08-04T00:13:02.925Z (5 months ago)
- Topics: minestom, minestom-server
- Language: Kotlin
- Homepage:
- Size: 2.14 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-minestom - BlockScreen - Screensharing in Minecraft. (Open Projects)
README
# BlockScreen ๐ฅ๏ธ
## Usage
Note: This can only be used locally, servers generally don't have capturable screens
First, [download the latest jar](https://github.com/emortaldev/BlockScreen/releases/latest/download/BlockScreen-1.0.0-all.jar), then to start:
```java
java -Xmx5G -Xms5G -jar BlockScreen-1.0.0-all.jar
```
or, if you'd like to set a custom width and height in-game:
```java
java -Xmx5G -Xms5G -DcustomBlockWidth=20 -DcustomBlockHeight=10 -jar BlockScreen-1.0.0-all.jar
```
making this smaller sacrifices quality, however can make the performance much more managable (This defaults to screen size รท10 so `192` and `108` on a 1080p monitor)On first startup, BlockScreen will automatically download and unzip the Minecraft textures and average their colours for use later. This can take a while as the download is around ~400mb.
Once in-game, take in the amazing graphics! ๐คฏ BlockScreen will copy your screen into Minecraft! (if everything is black, there's likely an [issue](https://github.com/emortaldev/BlockScreen/issues/new))
You can also use some commands:
| Command Usage | Description |
-|:-
| /dither | Toggles [dithering](https://en.wikipedia.org/wiki/Floyd%E2%80%93Steinberg_dithering) |
| /scaletype | Sets the [scale type](https://github.com/emortaldev/BlockScreen/tree/main/examples), there are only really 2 distinct types which are smooth and default## Compile
First, clone this repository
```
git clone https://github.com/emortaldev/BlockScreen/
```
Then compile with gradle
```yaml
# Windows
gradlew.bat build
# Linux & MacOS
./gradlew build
```