Skip to content

Latest commit

 

History

History
131 lines (96 loc) · 4.61 KB

README.md

File metadata and controls

131 lines (96 loc) · 4.61 KB
Raw

Newb X Legacy

Newb X Legacy is a RenderDragon successor to the legacy GLSL shader, Newb Shader. It is an enhanced vanilla shader that focuses on being lightweight and having soft aesthetics. It supports Minecraft Bedrock 1.21+ (Windows/Android/iOS).

Warning

This is an experimental repository, breaking changes are made often.


Screenshots


Downloads

v15 stable (For 1.20.73 or older)
v15 beta (For 1.20.80 or newer)

Nightly builds for Android (ESSL), Windows (DX), and iOS (Metal) can also be found at the Discord server.


Installation

Note

Shaders are not officially supported on Minecraft Bedrock. The following are unofficial ways to load shaders.

Android

  1. Install Patched Minecraft App
  2. Import the resource pack and activate it in global resources.

Windows

  1. Use BetterRenderDragon to enable MaterialBinLoader.
  2. Import the resource pack and activate it in global resources.

Linux / Mac

This method is for mcpelauncher-manifest.

x86_64 arch
  1. Install mcpelauncher-materialbinloader-mod.
  2. Import the resource pack and activate it in global resources.
x86_64, x86, arm64, arm arch
  1. Download mcpelauncher-shadersmod.
  2. Follow this guide to setup.

Building

Install dependencies

  • Git
  • Python 3.11 or higher required
  • Python packages:
    • lazurite (Must be v0.4.0. Newer or older version may not be supported)
    • rich (Must be v13.x.x)

Get source code

git clone https://github.com/devendrn/newb-x-mcbe/
cd newb-x-mcbe

Install dependencies from requirements.txt

Skip if you already have installed those versions.

python -m pip install -r requirements.txt

Setup build environment

Note

On Windows, run .\build.bat instead of ./build.sh for all following commands.

./build.sh setup

This will download shaderc binary and material data required to build shader.


Compile specific shader materials

./build.sh mats

Compiled material.bin files will be inside build/<platform>/

Command usage:

usage: build mats [-h] [-p {android,windows,merged,ios}] [-m M [M ...]] [-s S]

options:
  -h, --help            show this help message and exit
  -p {android,windows,merged,ios}
                        build profile
  -m M [M ...]          build materials (eg: Sky)
  -s S                  subpack config to use (eg: NO_WAVE)

Compile and build full shader pack

./build.sh pack

The final mcpack will be inside build/.

Command usage:

usage: build pack [-h] [-p {android,windows,merged,ios}] [--no-zip] [--no-label] [-v V]

options:
  -h, --help            show this help message and exit
  -p {android,windows,merged,ios}
                        build profile
  --no-zip              don't make archive
  --no-label            don't label materials
  -v V                  version number eg: 46

Tip

If you want to customize pack name, author, version and other details, you can do so in src/newb/pack_config.toml.


Development

Clangd can be used to get code completion and error checks for source files inside include/newb. Fake bgfx header and clangd config are provided for the same.

  • Neovim: Install clangd LSP.
  • VSCode: Install vscode-clangd extension.

License

Source Code: The "Newb Shader" source code is licensed under the MIT License. You are free to modify, distribute, and create derivative works based on the source code.

Compiled Resource Packs (.mcpack files): The compiled resource packs distributed by the "Newb Shader" project and its variant creators are copyrighted works with restrictions. See the COPYRIGHT.txt file within each resource pack for more information.