README.md

EN | 简中 | 繁中 | JP | RU | FR | KR | VI

Attention: For any extra support, questions, or discussions, check out our Discord.

Notable features

• Basic game features: Logging in, team setup, inventory, basic scene/entity management
• Monster battles working
• Natural world monster/prop/NPC spawns
• Character techniques
• Crafting/Consumables working
• NPC shops handled
• Gacha system
• Mail system
• Friend system (Assists are not working yet)
• Forgotten hall
• Pure Fiction
• Simulated universe (Runs can be finished, but many features are missing)

Running the server and client

Prerequisites

• Java 17 JDK

Recommended

• MongoDB 4.0+

Compiling the server

1. Open your system terminal, and compile the server with ./gradlew jar
2. Create a folder named resources in your server directory
3. Download the Config, TextMap, and ExcelBin folders from https://github.com/Dimbreath/StarRailData and place them into your resources folder.
4. Run the server with java -jar LunarCore.jar from your system terminal. Lunar Core comes with a built-in internal MongoDB server for its database, so no Mongodb installation is required. However, it is highly recommended to install Mongodb anyway.

Connecting with the client (Fiddler method)

1. Log in with the client to an official server and Hoyoverse account at least once to download game data.
2. Install and have Fiddler Classic running.
3. Copy and paste the following code into the Fiddlerscript tab of Fiddler Classic. Remember to save the fiddler script after you copy and paste it:

import System;
import System.Windows.Forms;
import Fiddler;
import System.Text.RegularExpressions;

class Handlers
{
    static function OnBeforeRequest(oS: Session) {
        if (oS.host.EndsWith(".starrails.com") || oS.host.EndsWith(".hoyoverse.com") || oS.host.EndsWith(".mihoyo.com") || oS.host.EndsWith(".bhsr.com")) {
            oS.oRequest.headers.UriScheme = "http";
            oS.host = "localhost"; // This can also be replaced with another IP address.
        }
    }
};

4. If autoCreateAccount is set to true in the config, then you can skip this step. Otherwise, type /account create [account name] in the server console to create an account.
5. Login with your account name, the password field is ignored by the server and can be set to anything.

Server commands

Server commands can be run in the server console or in-game. There is a dummy user named "Server" in every player's friends list that you can message to use in-game commands.

/account {create | delete} [username] (reserved player uid). Creates or deletes an account.
/avatar lv(level) p(ascension) r(eidolon) s(skill levels). Sets the current avatar's properties.
/clear {relics | lightcones | materials | items}. Removes filtered items from the player inventory.
/gender {male | female}. Sets the player's gender.
/give [item id] x[amount] lv[number]. Gives the targetted player an item.
/giveall {materials | avatars | lightcones | relics}. Gives the targeted player items.
/heal. Heals your avatars.
/help. Displays a list of available commands.
/kick @[player id]. Kicks a player from the server.
/mail [content]. Sends the targeted player a system mail.
/permission {add | remove | clear} [permission]. Gives/removes a permission from the targeted player.
/refill. Refill your skill points in open world.
/reload. Reloads the server config.
/scene [scene id] [floor id]. Teleports the player to the specified scene.
/spawn [npc monster id/prop id] s[stage id] x[amount] lv[level] r[radius] <battle monster ids...>. Spawns a monster or prop near the targeted player.
/stop. Stops the server
/unstuck @[player id]. Unstucks an offline player if they're in a scene that doesn't load.
/worldlevel [world level]. Sets the targeted player's equilibrium level.