Mirror/Erupe
1
0
Fork 0
mirror of https://github.com/Mezeporta/Erupe.git synced 2026-02-04 09:15:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

update Erupe-Configuration.md

wish
2023-12-31 13:53:24 +11:00
parent 8f84c0c1f2
commit 1047a0b2c6
1 changed files with 95 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

179
Erupe-Configuration.md

@@ -1,79 +1,89 @@
### General Configuration ### General Configuration
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
|------------------------|---------------------------------------------------------------------------------------------------------------------|-----------|---------| |------------------------|---------------------------------------------------------------------------------------------------------------------|--------------|----------------------------------|
| Host | The IP or host address to allow connections from | 127.0.0.1 | | | Host | The IP or host address to allow connections from | 127.0.0.1 | |
| BinPath | The bin path folder is where you place files needed for various parts of the game such as scenario and quest files | bin | | | BinPath | The bin path folder is where you place files needed for various parts of the game such as scenario and quest files | bin | |
| Language | Sets the language of server-side strings. Only English `en` and Japanese `jp` are available, contributions welcome | en | en/jp | | Language | Sets the language of server-side strings. Only English `en` and Japanese `jp` are available, contributions welcome | en | en/jp |
| DisableSoftCrash | Disables some crash outputs and in-game shutdown timer | false | | | DisableSoftCrash | Disables some crash outputs and in-game shutdown timer | false | |
| HideLoginNotice | Hides the notices that appear on login from `LoginNotices` | true | | | HideLoginNotice | Hides the notices that appear on login from `LoginNotices` | true | |
| LoginNotices | Array of login notices for users, you can have multiple notices | | | | LoginNotices | Array of login notices for users, you can have multiple notices | | |
| PatchServerManifest | See [ZeruLight/Servers](https://github.com/ZeruLight/Servers#mhf-patch-server-api) | | | | PatchServerManifest | See [ZeruLight/Servers](https://github.com/ZeruLight/Servers#mhf-patch-server-api) | | |
| PatchServerFile | See [ZeruLight/Servers](https://github.com/ZeruLight/Servers#mhf-patch-server-api) | | | | PatchServerFile | See [ZeruLight/Servers](https://github.com/ZeruLight/Servers#mhf-patch-server-api) | | |
| ScreenshotAPIURL | See [ZeruLight/Servers](https://github.com/ZeruLight/Servers#mhf-screenshot-bbs-api) | | | | ScreenshotAPIURL | See [ZeruLight/Servers](https://github.com/ZeruLight/Servers#mhf-screenshot-bbs-api) | | |
| DeleteOnSaveCorruption | Flags characters with corrupted savedata as deleted, can be used as punishment for cheaters | false | | | DeleteOnSaveCorruption | Flags characters with corrupted savedata as deleted, can be used as punishment for cheaters | false | |
| ClientMode | Changes the targeted Client Version, see [Client Versions](https://github.com/ZeruLight/Erupe/wiki/Client-Versions) | ZZ | | | ClientMode | Changes the targeted Client Version, see [Client Versions](https://github.com/ZeruLight/Erupe/wiki/Client-Versions) | ZZ | |
| QuestCacheExpiry | Number of seconds decrypted Event Quest data will be cached | 300 | | | QuestCacheExpiry | Number of seconds decrypted Event Quest data will be cached | 300 | |
| DevMode | Enables DevModeOptions to be configured | true | | | CommandPrefix | Sets the in-game Chat Command prefix | ! | |
| AutoCreateAccount | Allows users that don't exist to auto create their account from initial login | true | |
| DefaultCourses | Sets the Courses that will always be enabled by their ID | 1, 23, 24 | |
| EarthStatus | Enables Pallone Fest, Tower and Conquest War events | 0 | 2=Conquest, 11=Pallone, 21=Tower |
| EarthID | A random event ID | 0 | |
| EarthMonsters | Sets the IDs of the monsters targeted in the Conquest War | 0 | |
| SaveDumps.Enabled | Enables save dumps to a folder that is set at `SaveDumps.OutputDir` | true | |
| SaveDumps.RawEnabled | Enables saving an uncompressed copy of the savedata | false | |
| SaveDumps.OutputDir | The folder that save dumps are saved to | save-backups | |
### `DevModeOptions` Configuration ### `DebugOptions` Configuration
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
|----------------------|---------------------------------------------------------------------------------------------|--------------|----------------------------------| |---------------------|---------------------------------------------------------------------------------------------|---------|------------|
| AutoCreateAccount | Allows users that don't exist to auto create their account from initial login | true | | | CleanDB | Deletes all data in the `users`, `characters`, `guilds` tables permanently | false | |
| CleanDB | Deletes all data in the `users`, `characters`, `guilds` tables permanently | false | | | MaxLauncherHR | Always return HR7 on login to allow you to bypass World HR requirements | false | |
| MaxLauncherHR | Always return HR7 on login to allow you to break World HR requirements | false | | | LogInboundMessages | Enables logging inbound messages to stdout | false | |
| LogInboundMessages | Logs inbound messages to stdout | false | | | LogOutboundMessages | Enables logging outbound messages to stdout | false | |
| LogOutboundMessages | Logs outbound messages to stdout | false | | | LogMessageData | Enables logging the data transferred as a hexdump | false | |
| MaxHexdumpLength | Maximum number of hex bytes that will be dumped to stdout | 0 | | | MaxHexdumpLength | Maximum number of hex bytes that will be dumped to stdout | 256 | |
| DivaEvent | Overrides the Diva Defense event status in game | 0 | 0/1/2/3/-1 | | DivaOverride | Overrides the Diva Defense event status in game | 0 | 0/1/2/3/-1 |
| FestaEvent | Overrides the Hunter Festival event status in game | -1 | 0/1/2/3/-1 | | FestaOverride | Overrides the Hunter Festival event status in game | -1 | 0/1/2/3/-1 |
| TournamentEvent | Overrides the Hunter Tournament event status in game | 0 | 0/1/2/3/-1 | | TournamentOverride | Overrides the Hunter Tournament event status in game | 0 | 0/1/2/3/-1 |
| MezFesEvent | Enables the MezFes event and World | true | | | DisableTokenCheck | This disables the random token that is generated at login from being checked, very insecure | false | |
| MezFesAlt | Swaps the multiplayer MezFes minigame | false | | | QuestTools | Enables various quest debug logs | false | |
| DisableTokenCheck | This disables the random token that is generated at login from being checked, very insecure | false | | | ProxyPort | See [rockisch/mhf-dev-proxy](https://github.com/rockisch/mhf-dev-proxy) | 0 | |
| QuestDebugTools | Enables various quest debug logs | false | | | CapLink.Values | Sets values that are checked by the game client | | |
| EarthStatusOverride | Enables Pallone Fest, Tower and Conquest War events | 0 | 2=Conquest, 11=Pallone, 21=Tower | | CapLink.Key | A string secure key | | |
| EarthIDOverride | A random event ID | 0 | | | CapLink.Host | The host address of the CapLink API | | |
| EarthMonsterOverride | Sets the ID of the monster targeted in the Conquest War | 0 | | | CapLink.Port | The port of the CapLink API | 80 | |
| SaveDumps.Enabled | Enables save dumps to a folder that is set at `SaveDumps.OutputDir` | true | |
| SaveDumps.OutputDir | The folder that save dumps are saved to | save-backups | |
### `GameplayOptions` Configuration ### `GameplayOptions` Configuration
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
|--------------------------------|---------------------------------------------------------------------------------------|---------|---------| |--------------------------------|---------------------------------------------------------------------------------------|---------|-----------------|
| FeaturedWeapons | Number of Active Feature weapons to generate daily | 1 | | | FeaturedWeapons | Number of Active Feature weapons to generate daily | 1 | |
| MaximumNP | Maximum number of N Points held by a player | 100000 | | | MaximumNP | Maximum number of N Points held by a player | 100000 | |
| MaximumRP | Maximum number of Ryoudan (Clan) Points held by a player | 50000 | | | MaximumRP | Maximum number of Ryoudan (Clan) Points held by a player | 50000 | |
| MaximumFP | Maximum number of Festa Points held by a player | 120000 | | | MaximumFP | Maximum number of Festa Points held by a player | 120000 | |
| TreasureHuntExpiry | The number of seconds until a Clan Treasure Hunt expires | 604800 | | | TreasureHuntExpiry | The number of seconds until a Clan Treasure Hunt expires | 604800 | |
| DisableLoginBoost | Disables the Login Boost system | false | | | DisableLoginBoost | Disables the Login Boost system | false | |
| DisableBoostTime | Disables the daily NetCafe Boost Time | false | | | DisableBoostTime | Disables the daily NetCafe Boost Time | false | |
| BoostTimeDuration | The number of minutes NetCafe Boost Time lasts for | 120 | | | BoostTimeDuration | The number of seconds NetCafe Boost Time lasts for | 7200 | |
| GuildMealDuration | The number of minutes a Guild Meal can be activated for after cooking | 60 | | | ClanMealDuration | The number of seconds a Clan Meal can be activated for after cooking | 3600 | |
| BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | | | ClanMemberLimits | Sets the max Clan Members after hitting Rank thresholds (Max. 100) | | [Rank, Members] |
| DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | | | BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | |
| MezfesSoloTickets | Number of solo tickets given weekly | 10 | | | DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | |
| MezfesGroupTickets | Number of group tickets given weekly | 4 | | | LowLatencyRaviente | Experimental mode to instantly update global Raviente hitpoints | false | |
| LowLatencyRaviente | Experimental mode to instantly update global Raviente hitpoints | false | | | RegularRavienteMaxPlayers | Changes the maximum players able to sign up to fight Regular Raviente (HR2) | 8 | |
| RegularRavienteMaxPlayers | Changes the maximum players able to sign up to fight Regular Raviente (HR2) | 8 | | | ViolentRavienteMaxPlayers | Changes the maximum players able to sign up to fight Violent Raviente (HR5) | 8 | |
| ViolentRavienteMaxPlayers | Changes the maximum players able to sign up to fight Violent Raviente (HR5) | 8 | | | BerserkRavienteMaxPlayers | Changes the maximum players able to sign up to fight Berserk Raviente (G1) | 32 | |
| BerserkRavienteMaxPlayers | Changes the maximum players able to sign up to fight Berserk Raviente (G1) | 32 | | | ExtremeRavienteMaxPlayers | Changes the maximum players able to sign up to fight Extreme Raviente (G1+G50 weapon) | 32 | |
| ExtremeRavienteMaxPlayers | Changes the maximum players able to sign up to fight Extreme Raviente (G1+G50 weapon) | 32 | | | SmallBerserkRavienteMaxPlayers | Changes the maximum players able to sign up to fight Small Berserk Raviente (G1) | 8 | |
| SmallBerserkRavienteMaxPlayers | Changes the maximum players able to sign up to fight Small Berserk Raviente (G1) | 8 | | | GUrgentRate | Adjusts the rate of G Urgent quests spawning | 0.10 | |
| GUrgentRate | Adjusts the rate of G Urgent quests spawning | 0.10 | | | GCPMultiplier | Adjusts the multiplier of GCP rewarded for quest completion | 1.00 | |
| GCPMultiplier | Adjusts the multiplier of GCP rewarded for quest completion | 1.00 | | | GRPMultiplier | Adjusts the multiplier of G Rank Points rewarded for quest completion | 1.00 | |
| GRPMultiplier | Adjusts the multiplier of G Rank Points rewarded for quest completion | 1.00 | | | GSRPMultiplier | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion | 1.00 | |
| GSRPMultiplier | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion | 1.00 | | | GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | 1.00 | |
| GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | 1.00 | | | MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | |
| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | | | ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | |
| ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | | | DisableHunterNavi | Disables the Hunter Navi | false | |
| DisableHunterNavi | Disables the Hunter Navi | false | | | MezFesSoloTickets | Number of solo tickets given weekly | 5 | |
| EnableKaijiEvent | Enabled the Kaiji event in the Rasta Bar (G10 only) | false | | | MezFesGroupTickets | Number of group tickets given weekly | 1 | |
| EnableHiganjimaEvent | Enables the Higanjima event in the Rasta Bar | false | | | MezFesDuration | The duration of MezFes in seconds (start time = end of week - duration) | 172800 | |
| EnableNierEvent | Enables the Nier event in the Rasta Bar | false | | | MezFesSwitchMinigame | Switches the group minigame from Volpakkun Together to Tokotoko Partnya | false | |
| DisableRoad | Disables the Hunting Road | false | | | EnableKaijiEvent | Enabled the Kaiji event in the Rasta Bar (G10 only) | false | |
| EnableHiganjimaEvent | Enables the Higanjima event in the Rasta Bar | false | |
| EnableNierEvent | Enables the Nier event in the Rasta Bar | false | |
| DisableRoad | Disables the Hunting Road | false | |
| SeasonOverride | Enables quests to use the current Season and time | false | |
### Discord ### Discord
There is limited Discord capability in Erupe. The feature allows you to replay messages from your server into a channel. There is limited Discord capability in Erupe. The feature allows you to replay messages from your server into a channel.
@@ -82,23 +92,24 @@ This may be either be removed or revamped in a future version.
### Commands ### Commands
There are several chat commands that can be turned on and off. Most are for admin or debugging purposes. There are several chat commands that can be turned on and off. Most are for admin or debugging purposes.
| Name | command | Description | Default | Options | | Name | command | Description | Default | Options |
|----------|----------------|------------------------------------------------|----------|------------------------------------------------------------------------------------------------| |----------|---------------|------------------------------------------------|----------|------------------------------------------------------------------------------------------------|
| Rights | !rights VALUE | Sets the rights integer for your account | disabled | | | Help | help | Shows enabled Chat Commands | enabled | |
| Teleport | !tele X,Y | Teleports the user to specific x,y coordinates | disabled | | | Rights | rights VALUE | Sets the rights integer for your account | disabled | |
| Reload | !reload | Reloads all users and character objects | enabled | | | Teleport | tele X,Y | Teleports the user to specific x,y coordinates | disabled | |
| KeyQuest | !kqf FLAGS | Sets the Key Quest Flag for your character | disabled | | | Reload | reload | Reloads all users and character objects | enabled | |
| Course | !course OPTION | Enables/Disables a course for your account | enabled | See [mhfcourse.go](https://github.com/ZeruLight/Erupe/blob/main/common/mhfcourse/mhfcourse.go) | | KeyQuest | kqf FLAGS | Sets the Key Quest Flag for your character | disabled | |
| PSN | !psn USERNAME | Links the specified PSN to your account | enabled | | | Course | course OPTION | Enables/Disables a course for your account | enabled | See [mhfcourse.go](https://github.com/ZeruLight/Erupe/blob/main/common/mhfcourse/mhfcourse.go) |
| PSN | psn USERNAME | Links the specified PSN to your account | enabled | |
### Ravi Sub Commands ### Ravi Sub Commands
| Name | command | Description | | Name | command | Description |
|----------|----------------------------------|-------------------------------| |----------|--------------------------------|-------------------------------|
| Raviente | !ravi start | Starts Ravi Event | | Raviente | ravi start | Starts Ravi Event |
| Raviente | !ravi cm / !ravi checkmultiplier | Checks Ravi Damage Multiplier | | Raviente | ravi cm / ravi checkmultiplier | Checks Ravi Damage Multiplier |
| Raviente | !ravi ss | Send Sedation Support | | Raviente | ravi ss | Send Sedation Support |
| Raviente | !ravi sr | Send Resurrection Support | | Raviente | ravi sr | Send Resurrection Support |
| Raviente | !ravi rs | Request Sedation Support | | Raviente | ravi rs | Request Sedation Support |
### World `Entries` Configuration ### World `Entries` Configuration