lip setup

Choose the game and the loader of the workspace.

Synopsis

lip setup --game <VERSION> [--build <BUILD>] [--loader <LOADER> | --no-loader] [--accept-eula] [-n | --dry-run] [-h | --help]

Description

lip setup makes the server of the workspace the game <VERSION> of the build <BUILD>, with the loader <LOADER> or without a loader, and keeps the other packages of the workspace that work with them. Run it in an empty directory to create a server, and again whenever you want another game version or loader.

Terms

• The game is the installed package of github.com/LiteLDev/bds, the Minecraft Bedrock Dedicated Server. A workspace has at most one. A workspace without one has no game.
• The build of the game is windows or linux: the Windows server or the Linux server.
• The loader is the installed package of github.com/LiteLDev/LeviLamina. A workspace without one has no loader.
• A LeviLamina version fits a game version when its dependency on github.com/LiteLDev/bds accepts that version.

What it does

In order:

1. It works out the game, the build and the loader from the options. See The loader.
2. It fails, before anything changes, when
   • the build is linux and a loader is asked for: LeviLamina loads only into the Windows server;
   • the game version has no build of that kind (see Game versions and builds);
   • the loader version does not exist or does not fit the game version.
3. It plans the packages. The game is requested from github.com/LiteLDev/bds@<VERSION>, or github.com/LiteLDev/bds#linux@<VERSION> for the build linux; the loader from github.com/LiteLDev/LeviLamina@<version>. Every other explicitly installed package is requested again from the source it was installed from.
   • A package keeps its version when that still works; otherwise it may change version.
   • The game and the loader that the workspace had are uninstalled, unless they are the ones asked for.
   • Dependencies that no explicitly installed package needs any more are uninstalled.
4. It asks about left-out packages, if there are any.
5. It asks you to accept the license, if it installs a game.
6. For the build windows, it installs what the Windows server needs of the system when that is missing: Wine on Linux and macOS, and the Microsoft Visual C++ Redistributable. See Linux and macOS.
7. It installs the packages, as one workspace operation.

When the workspace already has the game and the loader asked for, of the same builds and versions, lip setup installs and uninstalls nothing for them.

The game and the loader are installed explicitly and pinned to their versions. lip install and lip update never change them afterwards; run lip setup again to change them. lip uninstall removes them like any other package.

The loader

levilamina is compared ignoring case.

Game versions and builds

lip takes the list of server builds from https://levimc.org/api/v4/mc/versions/. A build is four numbers, such as 1.21.80.03. It gives two game versions:

So give --game 1.21.80 in general, and --game 1.21.80-patch.3 when you need one particular build. The Windows builds and the Linux builds are separate lists: a version may exist for one and not for the other.

The server itself is downloaded from www.minecraft.net.

The license

The game is under the Minecraft End User License Agreement and the Microsoft Privacy Policy.

When lip setup installs a game, it writes both links and asks whether you accept them. Type yes to go on. With any other answer the command fails before anything changes.

• With --accept-eula, lip does not ask.
• Without it, when standard input or standard error is not a terminal, as in a script, the command fails before anything changes.
• The answer is not recorded. Every setup that installs a game asks again; a setup that leaves the game as it is does not ask.

Left-out packages

An explicitly installed package, other than the game and the loader, is left out when no version of it works with the new game and loader. It can be a mod or any other package.

lip names the left-out packages and asks whether to uninstall them. When you do not answer yes, the command fails before anything changes. When standard input or standard error is not a terminal, lip cannot ask: the command fails and names them. Uninstall them first with lip uninstall, then run lip setup again.

When the remaining packages cannot be installed together at all, the command fails.

lip asks about left-out packages first, then about the license. Both questions come after lip has decided what to do and before it downloads the game.

Options

Output

lip setup has no result: it writes nothing to standard output. Progress, the questions and the final line are messages on standard error.

Exit status

Examples

Create a server of the game 1.21.0 with the newest LeviLamina that fits it:

lip setup --game 1.21.0

Set up a given LeviLamina version, accepting the license in a script:

lip setup --game 1.21.0 --loader levilamina@1.0.0 --accept-eula

Set up the Windows server without a loader:

lip setup --game 1.21.0 --no-loader

Set up the Linux server, which has no loader:

lip setup --game 1.21.0 --build linux

See what moving to another game version would do to the installed packages:

lip setup --game 1.21.50 --dry-run

See also

• Running a server from commands
• Workspaces: the new-server wizard and changing versions in the interface.
• What survives a game change
• lip install, which sets up a server when you install LeviLamina or the server itself.
• lip run