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
| Variable | Description | Default | Options |
|------------------------|---------------------------------------------------------------------------------------------------------------------|-----------|---------|
| 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 | |
| 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 | |
| HideLoginNotice | Hides the notices that appear on login from `LoginNotices` | true | |
| 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) | | |
| 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) | | |
| 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 | |
| QuestCacheExpiry | Number of seconds decrypted Event Quest data will be cached | 300 | |
| DevMode | Enables DevModeOptions to be configured | true | |
| Variable | Description | Default | Options |
|------------------------|---------------------------------------------------------------------------------------------------------------------|--------------|----------------------------------|
| 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 | |
| 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 | |
| HideLoginNotice | Hides the notices that appear on login from `LoginNotices` | true | |
| 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) | | |
| 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) | | |
| 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 | |
| QuestCacheExpiry | Number of seconds decrypted Event Quest data will be cached | 300 | |
| 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 |
|----------------------|---------------------------------------------------------------------------------------------|--------------|----------------------------------|
| 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 | |
| MaxLauncherHR | Always return HR7 on login to allow you to break World HR requirements | false | |
| LogInboundMessages | Logs inbound messages to stdout | false | |
| LogOutboundMessages | Logs outbound messages to stdout | false | |
| MaxHexdumpLength | Maximum number of hex bytes that will be dumped to stdout | 0 | |
| DivaEvent | 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 |
| TournamentEvent | Overrides the Hunter Tournament event status in game | 0 | 0/1/2/3/-1 |
| MezFesEvent | Enables the MezFes event and World | true | |
| MezFesAlt | Swaps the multiplayer MezFes minigame | false | |
| DisableTokenCheck | This disables the random token that is generated at login from being checked, very insecure | false | |
| QuestDebugTools | Enables various quest debug logs | false | |
| EarthStatusOverride | Enables Pallone Fest, Tower and Conquest War events | 0 | 2=Conquest, 11=Pallone, 21=Tower |
| EarthIDOverride | A random event ID | 0 | |
| EarthMonsterOverride | Sets the ID of the monster targeted in the Conquest War | 0 | |
| 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 | |
| Variable | Description | Default | Options |
|---------------------|---------------------------------------------------------------------------------------------|---------|------------|
| 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 | |
| LogInboundMessages | Enables logging inbound messages to stdout | false | |
| LogOutboundMessages | Enables logging 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 | 256 | |
| DivaOverride | Overrides the Diva Defense event status in game | 0 | 0/1/2/3/-1 |
| FestaOverride | Overrides the Hunter Festival event status in game | -1 | 0/1/2/3/-1 |
| TournamentOverride | Overrides the Hunter Tournament event status in game | 0 | 0/1/2/3/-1 |
| DisableTokenCheck | This disables the random token that is generated at login from being checked, very insecure | false | |
| QuestTools | Enables various quest debug logs | false | |
| ProxyPort | See [rockisch/mhf-dev-proxy](https://github.com/rockisch/mhf-dev-proxy) | 0 | |
| CapLink.Values | Sets values that are checked by the game client | | |
| CapLink.Key | A string secure key | | |
| CapLink.Host | The host address of the CapLink API | | |
| CapLink.Port | The port of the CapLink API | 80 | |
### `GameplayOptions` Configuration
| Variable | Description | Default | Options |
|--------------------------------|---------------------------------------------------------------------------------------|---------|---------|
| FeaturedWeapons | Number of Active Feature weapons to generate daily | 1 | |
| MaximumNP | Maximum number of N Points held by a player | 100000 | |
| MaximumRP | Maximum number of Ryoudan (Clan) Points held by a player | 50000 | |
| MaximumFP | Maximum number of Festa Points held by a player | 120000 | |
| TreasureHuntExpiry | The number of seconds until a Clan Treasure Hunt expires | 604800 | |
| DisableLoginBoost | Disables the Login Boost system | false | |
| DisableBoostTime | Disables the daily NetCafe Boost Time | false | |
| BoostTimeDuration | The number of minutes NetCafe Boost Time lasts for | 120 | |
| GuildMealDuration | The number of minutes a Guild Meal can be activated for after cooking | 60 | |
| BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | |
| DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | |
| MezfesSoloTickets | Number of solo tickets given weekly | 10 | |
| MezfesGroupTickets | Number of group tickets given weekly | 4 | |
| 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 | |
| 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 | |
| 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 | |
| GUrgentRate | Adjusts the rate of G Urgent quests spawning | 0.10 | |
| 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 | |
| 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 | |
| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | |
| ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | |
| DisableHunterNavi | Disables the Hunter Navi | 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 | |
| Variable | Description | Default | Options |
|--------------------------------|---------------------------------------------------------------------------------------|---------|-----------------|
| FeaturedWeapons | Number of Active Feature weapons to generate daily | 1 | |
| MaximumNP | Maximum number of N Points held by a player | 100000 | |
| MaximumRP | Maximum number of Ryoudan (Clan) Points held by a player | 50000 | |
| MaximumFP | Maximum number of Festa Points held by a player | 120000 | |
| TreasureHuntExpiry | The number of seconds until a Clan Treasure Hunt expires | 604800 | |
| DisableLoginBoost | Disables the Login Boost system | false | |
| DisableBoostTime | Disables the daily NetCafe Boost Time | false | |
| BoostTimeDuration | The number of seconds NetCafe Boost Time lasts for | 7200 | |
| ClanMealDuration | The number of seconds a Clan Meal can be activated for after cooking | 3600 | |
| ClanMemberLimits | Sets the max Clan Members after hitting Rank thresholds (Max. 100) | | [Rank, Members] |
| BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | |
| DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | |
| 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 | |
| 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 | |
| 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 | |
| GUrgentRate | Adjusts the rate of G Urgent quests spawning | 0.10 | |
| 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 | |
| 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 | |
| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | |
| ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | |
| DisableHunterNavi | Disables the Hunter Navi | false | |
| MezFesSoloTickets | Number of solo tickets given weekly | 5 | |
| MezFesGroupTickets | Number of group tickets given weekly | 1 | |
| MezFesDuration | The duration of MezFes in seconds (start time = end of week - duration) | 172800 | |
| MezFesSwitchMinigame | Switches the group minigame from Volpakkun Together to Tokotoko Partnya | 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
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
There are several chat commands that can be turned on and off. Most are for admin or debugging purposes.
| Name | command | Description | Default | Options |
|----------|----------------|------------------------------------------------|----------|------------------------------------------------------------------------------------------------|
| Rights | !rights VALUE | Sets the rights integer for your account | disabled | |
| Teleport | !tele X,Y | Teleports the user to specific x,y coordinates | disabled | |
| Reload | !reload | Reloads all users and character objects | enabled | |
| KeyQuest | !kqf FLAGS | Sets the Key Quest Flag for your character | disabled | |
| 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 | |
| Name | command | Description | Default | Options |
|----------|---------------|------------------------------------------------|----------|------------------------------------------------------------------------------------------------|
| Help | help | Shows enabled Chat Commands | enabled | |
| Rights | rights VALUE | Sets the rights integer for your account | disabled | |
| Teleport | tele X,Y | Teleports the user to specific x,y coordinates | disabled | |
| Reload | reload | Reloads all users and character objects | enabled | |
| KeyQuest | kqf FLAGS | Sets the Key Quest Flag for your character | disabled | |
| 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
| Name | command | Description |
|----------|----------------------------------|-------------------------------|
| Raviente | !ravi start | Starts Ravi Event |
| Raviente | !ravi cm / !ravi checkmultiplier | Checks Ravi Damage Multiplier |
| Raviente | !ravi ss | Send Sedation Support |
| Raviente | !ravi sr | Send Resurrection Support |
| Raviente | !ravi rs | Request Sedation Support |
| Name | command | Description |
|----------|--------------------------------|-------------------------------|
| Raviente | ravi start | Starts Ravi Event |
| Raviente | ravi cm / ravi checkmultiplier | Checks Ravi Damage Multiplier |
| Raviente | ravi ss | Send Sedation Support |
| Raviente | ravi sr | Send Resurrection Support |
| Raviente | ravi rs | Request Sedation Support |
### World `Entries` Configuration