Skip to content

Quickstart

Before You Begin

We strongly recommend using lip for mod installation. If you have not installed it locally yet, please go ahead and check it out.

The following content is for a quick start with using lip.

Tip

Not accustomed to using command-line tools? You can use LipUI.

Installing LeviLamina

First, create a new directory for your Minecraft server and enter it:

Bash
1
2
mkdir myserver
cd myserver

Then, install LeviLamina bundled with Minecraft Bedrock Server using lip:

Bash
1
lip install github.com/LiteLDev/LeviLamina

Running the Server

To start the server, simply run bedrock_server_mod.exe:

Bash
1
./bedrock_server_mod.exe

Updating LeviLamina

Don't update LeviLamina in the same location when it comes to data security. Instead, we recommend creating a new directory, installing the new version of LeviLamina there, and subsequently copying the worlds directory from the old location to the new location. Then, follow the instructions provided by the mod developers to migrate the configuration files and data files of the mods you are using to the new directory.

Finding Mods

Before installing a mod, you'll need to find what you want to install. The best place to find mods is lip index, lip's official mod registry, but you can also find many mods on MineBBS and other places around the web.

Installing Mods

For most mods, especially those on lip index, installation is as simple as running lip install <mod>.

For example, to install levianticheat, you would run:

Bash
1
lip install github.com/LiteLDev/LeviAntiCheat

Or install a specific version:

Bash
1
lip install github.com/LiteLDev/[email protected]

However, some mods may require additional steps to install. Follow the instructions provided by the mod developers to install the mods you are using.

Troubleshooting

If the problem occurred during playing the game, the first step to troubleshooting installing mods is to check the log of your server. Your server's most recent logs will be stored to the logs/server-latest.log file. You may need to scroll near the beginning of this file to see when mods were loaded.

Check FAQ for frequently occurring problems.

If you see something like this:

Text Only
1
ERROR: failed to parse and download specifier string list: failed to install specifier: failed to download from all Go proxies: failed to download from all Go proxies: [failed to download file: cannot download file (HTTP 404 Not Found): https://goproxy.io/github.com/tooth-hub/mymod/@v/v1.1.0.zip]

This means that the version of the mod you tried to install does not exist. You should double-check that you typed the mod name and version correctly.

If you see something like this:

Text Only
1
ERROR: failed to resolve dependencies: installed tooth github.com/tooth-hub/othermod does not match dependency 1.20.41

This means that the version of the mod you tried to install is incompatible with the installed version of another mod, LeviLamina or BDS. Try to install another version of the mod or update the installed mod.

If your network cannot directly access GitHub or GoProxy, you can set up a proxy or mirror:

Configuring a Proxy or Mirror

If you have a proxy available , use the following command to configure the proxy (supports socks5, http, https):

Bash
1
lip config ProxyURL <proxy-url>

If you have mistakenly configured a proxy server when you don't have one, you can unconfigure it with the following command:

Bash
1
lip config ProxyURL ""

For example, if your proxy address is http://127.0.0.1:8080, you can use the following command to configure the proxy:

Bash
1
lip config ProxyURL http://127.0.0.1:8080

If you do not have a proxy available locally, you can use the following commands to configure a mirror source:

Bash
1
2
lip config GoModuleProxyURL <go-module-proxy-url>
lip config GitHubMirrorURL <github-mirror-url>