Mirror/Erupe
1
0
Fork 0
mirror of https://github.com/Mezeporta/Erupe.git synced 2025-12-16 08:55:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

update Configuration.md

wish
2023-11-19 23:59:21 +11:00
parent bee784efad
commit a8ef902933
1 changed files with 76 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
Configuration.md

@@ -1,39 +1,38 @@
This portion of the documentation goes over the `config.json` file.
### General Configuration
| Variable | Description | Default | Options |
|------------------------|-----------------------------------------------------------------------------------------------------------------------|-----------|---------------------------------|
| Host | The IP or host address the server is running 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 | This is the language the server will run in. Only English `en` and Japanese `jp` are available, contributions welcome | en | en/jp |
| DisableSoftCrash | | false | |
| HideLoginNotice | This hides the notices that appear on login from `LoginNotices` | true | |
| LoginNotices | This is where you place notices for users, you can have multiple notices | | |
| PatchServerManifest | | | |
| PatchServerFile | | | |
| ScreenshotAPIURL | This is the URL you want user sreenshots to go to | | |
| DeleteOnSaveCorruption | This option flags a character as deleted if they corrupt it, can be used as punishment for cheaters | false | |
| ClientMode | This tells the server what client version it should target | ZZ | Check compatible versions above |
| DevMode | This 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 | |
| DevMode | Enables DevModeOptions to be configured | true | |
### `DevModeOptions` Configuration
| Variable | Description | Default | Options |
|----------------------|---------------------------------------------------------------------------------------------|--------------|----------------------------------|
| AutoCreateAccount | This allows users that don't exist to auto create their account from initial login | true | |
| CleanDB | This cleans the database down | false | |
| MaxLauncherHR | This sets the launcher value to HR7 to allow you to break World HR requirements | false | |
| LogInboundMessages | This will allow inbound messages to be logged to stdout | false | |
| LogOutboundMessages | This will allow outbound messages to be logged to stdout | false | |
| MaxHexdumpLength | This is the maximum amount of hex bytes that will be dumped to stdout | 0 | |
| DivaEvent | This overrides the Diva event stage in game | 0 | 0/1/2/3/-1 |
| FestaEvent | This overrides the Hunter Festival event stage in game | -1 | 0/1/2/3/-1 |
| TournamentEvent | This overrides the Hunter Tournament event stage in game | 0 | 0/1/2/3/-1 |
| MezFesEvent | Enables whether the MezFes event & World are active | true | |
| MezFesAlt | Switches the multiplayer MezFes minigame | false | |
| 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 | Enable various quest debug logs | 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 | |
@@ -42,46 +41,55 @@ This portion of the documentation goes over the `config.json` file.
### `GameplayOptions` Configuration
| Variable | Description | Default | Options |
|----------------------|-----------------------------------------------------------------------------|---------|---------|
| FeaturedWeapons | Number of Active Feature weapons to generate daily | 0 | |
| MaximumNP | Maximum number of NP held by a player | 100000 | |
| MaximumRP | Maximum number of RP held by a player | 100000 | |
| 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 | |
| GUrgentRate | Adjusts the rate of G Urgent quests spawning | 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 | |
| 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 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 | |
### Discord
There is limited Discord capability in Erupe. The feature allows you to replay messages from your server into a channel.
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 of them are really for admins 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 |
|----------|----------------|--------------------------------------------|----------|---------------------|
| Rights | !rights VALUE | Sets the rights integer for your account | disabled | |
| Teleport | !tele X,Y | Teleports user to specific x,y coordinate | 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 | HL,EX,Premium,Boost |
| PSN | !psn USERNAME | Links the specified PSN to your account | enabled | |
| 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 | |
### Ravi Sub Commands
| Name | command | Description |
@@ -95,16 +103,15 @@ There are several chat commands that can be turned on and off. Most of them are
### World `Entries` Configuration
| Config Item | Description | Options |
|-------------|---------------|------------------------------------------------------------|
| Type | Server type | 1=Normal, 2=Cities, 3=Newbie, 4=Tavern, 5=Return, 6=MezFes |
| Season | Server season | 0=Green/Breeding, 1=Orange/Warm, 2=Blue/Cold |
| Config Item | Description | Options |
|-------------|----------------------------|------------------------------------------------------------|
| Type | Server type | 1=Normal, 2=Cities, 3=Newbie, 4=Tavern, 5=Return, 6=MezFes |
| Recommended | Changes quest availability | See below table |
### `Recommend`
This sets the types of Quests that can be ordered from a World.
### `Recommended`
* 0 = All quests
* 1 = Up to 2 star Quests
* 2 = Up to 4 star Quests
* 1 = Up to 2☆ Quests
* 2 = Up to 4☆ star Quests
* 4 = All Quests in HR (Enables G Experience Tab)
* 5 = Only G Rank Quests
* 6 = Minigame World