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

update wiki

wish
2024-02-10 17:10:09 +11:00
parent 4f83b8bebd
commit 5123a74a8c
2 changed files with 196 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

219
Enumerations.md

@@ -1,126 +1,129 @@
# Distribution Types
Distributions are available from the guide girl at the entrance of Mezaporta.
These control which menu in the guide girl your distribution will show up.
| ID | Name |
| --- | ----------------- |
| 0 | Bought |
| 1 | Event |
| 2 | Compensation |
| 4 | Promotion |
| 6 | Subscription |
| 7 | Event Item |
| 8 | Promotion Item |
| 9 | Subscription Item |
Distributions are available from the Guide near the entrance of Mezeporta.
These control which menu at the Guide your Distribution will show up.
| ID | Name |
|----|-------------------|
| 0 | Bought |
| 1 | Event |
| 2 | Compensation |
| 4 | Promotion |
| 6 | Subscription |
| 7 | Event Item |
| 8 | Promotion Item |
| 9 | Subscription Item |
# Item Types
These are used to define what sort of item you would like to receive from a distribution or event tent distribution.
| ID | type |
| --- | ------------------- |
| 0 | Legs |
| 1 | Head |
| 2 | Chest |
| 3 | Arms |
| 4 | Waist |
| 5 | Melee |
| 6 | Ranged |
| 7 | Item |
| 8 | Furniture |
| 9 | UNKNOWN |
| 10 | Zenny |
| 11 | UNKNOWN |
| 12 | Festival Points |
| 13 | UNKNOWN |
| 14 | Tore Points |
| 15 | Poogie Outfits |
| 16 | Restyle Points |
| 17 | N Points |
| 18 | Goocoo Outfits |
| 19 | Gacha Coins |
| 20 | Trial Gacha Coins |
| 21 | Frontier Points(FP) |
| 22 | UNKNOWN |
| 23 | Ryoudan Points (RP) |
| 24 | UNKNOWN |
| 25 | Bond Points |
| 26 | UNKNOWN |
| 27 | UNKNOWN |
| 28 | Special Hall |
| 29 | Song Note |
| 30 | Item box pages |
| 31 | Equipment box pages |
These define the item type you would receive from a Distribution or Event Tent Distribution.
| ID | type |
|----|----------------------|
| 0 | Legs |
| 1 | Head |
| 2 | Chest |
| 3 | Arms |
| 4 | Waist |
| 5 | Melee |
| 6 | Ranged |
| 7 | Item |
| 8 | Furniture |
| 9 | UNKNOWN |
| 10 | Zenny |
| 11 | UNKNOWN |
| 12 | Festival Points |
| 13 | UNKNOWN |
| 14 | Tore Points |
| 15 | Poogie Outfits |
| 16 | Restyle Points |
| 17 | N Points |
| 18 | Goocoo Outfits |
| 19 | Gacha Koban |
| 20 | Trial Gacha Koban |
| 21 | Frontier Points (FP) |
| 22 | UNKNOWN |
| 23 | Ryoudan Points (RP) |
| 24 | UNKNOWN |
| 25 | Bond/Kizuna Points |
| 26 | UNKNOWN |
| 27 | UNKNOWN |
| 28 | Special Hall |
| 29 | Song Note |
| 30 | Item Box pages |
| 31 | Equipment Box pages |
# Course Types
| ID | Course |
| ------- | ----------------------------------------------- |
| 1 | Trial, TL |
| 2 | HunterLife, HL |
| 3 | Extra, ExtraA, EX |
| 4 | ExtraB |
| 5 | Mobile |
| 6 | Premium |
| 7 | Pallone, ExtraC |
| 8 | Assist, Legend, Rasta |
| 9 | N |
| 10 | Hiden, Secret |
| 11 | Hunter Support, Hunter Aid, Support, Aid, Royal |
| 12 | NBoost, Net Cafe Boost, Boost |
| 13 - 19 | show up as (unknown) |
| 20 | DEBUG |
| 21 | COG_LINK_EXPIRED |
| 22 | 360_GOLD |
| 23 | PS3_TROP |
| 24 | COG |
| 25 | CAFE_SP |
| 26 | NetCafe, Cafe, Official Cafe, Official |
| 27 | HLRenewing, HLR, HLRenewal, HLRenew, CardHL |
| 28 | EXRenewing, EXR, EXRenewal, EXRenew, CardEX |
| 29 | Free |
| 30 | Real NetCafe course |
| ID | Course |
|---------|-------------------------------------------------------|
| 1 | TRIAL (Trial, TL) |
| 2 | BASIC (HunterLife, HL) |
| 3 | EXTRA_A (Extra, ExtraA, EX) |
| 4 | EXTRA_B (ExtraB) |
| 5 | MOBILE (Mobile) |
| 6 | PREMIUM (Premium) |
| 7 | PALLONE (Pallone, ExtraC) |
| 8 | LEGEND (Assist, Legend, Rasta) |
| 9 | XBCAFE (N) |
| 10 | SECRET (Hiden, Secret) |
| 11 | ROYAL (HunterSupport, HunterAid, Support, Aid, Royal) |
| 12 | NBOOST (NBoost, NetCafeBoost, Boost) |
| 13 - 19 | show up as (unknown) |
| 20 | DEBUG |
| 21 | COG_LINK_EXPIRED |
| 22 | 360_GOLD |
| 23 | PS3_TROP |
| 24 | COG |
| 25 | CAFE_SP |
| 26 | OFFICIAL (NetCafe, Cafe, OfficialCafe, Official) |
| 27 | CARD (HLRenewing, HLR, HLRenewal, HLRenew, CardHL) |
| 28 | CARD_EX (EXRenewing, EXR, EXRenewal, EXRenew, CardEX) |
| 29 | FREE |
| 30 | NETCAFE |
# Event Quests
## Quest Types
| Name | Type |
|-----------------------|-------|
| Frontier Quests | 5 |
| Festa Winners | 8 |
| Campaign | 9 |
| E.Dragon Quests | 10 |
| Special Quests | 11 |
| VS | 13 |
| Goushu | 14 |
| Goushu (Premium) | 15 |
| Ravi (Normal) | 16 |
| HR Event | 18 |
| Ravi (Violent) | 22 |
| Series | 24 |
| Daily | 26 |
| G Event | 28 |
| G Daily | 30 |
| G Urgent | 31 |
| HR Exotic | 38 |
| G Exotic | 39 |
| Ravi (Berserk) | 40 |
| Zenith | 43 |
| Interception | 46 |
| Interception Branch | 47 |
| Interception Urgent | 48 |
| Ravi (Extreme) | 50 |
| Ravi (Small) | 51 |
| Superior | 52 |
| G Superior | 53 |
| G Armor | 54 |
| Name | Type |
|----------------------|-------|
| Frontier Quests | 5 |
| Festa Winners | 8 |
| Campaign | 9 |
| Elder Dragon Quests | 10 |
| Special Quests | 11 |
| VS | 13 |
| Goushu | 14 |
| Goushu (Premium) | 15 |
| Ravi (Normal) | 16 |
| HR Event | 18 |
| Ravi (Violent) | 22 |
| Series | 24 |
| Daily | 26 |
| G Event | 28 |
| G Daily | 30 |
| G Urgent | 31 |
| HR Exotic | 38 |
| G Exotic | 39 |
| Ravi (Berserk) | 40 |
| Zenith | 43 |
| Interception | 46 |
| Interception Branch | 47 |
| Interception Urgent | 48 |
| Ravi (Extreme) | 50 |
| Ravi (Small Berserk) | 51 |
| Superior | 52 |
| G Superior | 53 |
| G Armor | 54 |
## Quest Flags
| Season/Time | Flag |
|------------------|-------|
| Automatic | 0 |
| Warm/Day | 10 |
| Warm/Night | 18 |
| Cold/Day | 12 |
| Cold/Night | 32 |
| Breeding/Day | 9 |
| Warm/Day | 10 |
| Cold/Day | 12 |
| Breeding/Night | 17 |
| Warm/Night | 18 |
| Cold/Night | 32 |
## Mark
| Type | Bitfield |
@@ -129,5 +132,3 @@ These are used to define what sort of item you would like to receive from a dist
| Recommended | 1 |
| New | 2 |
| Refine | 4 |

157
Erupe-Configuration.md

@@ -1,28 +1,28 @@
### 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 | |
| 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 | See [Course Types](https://github.com/ZeruLight/Erupe/wiki/Erupe-Configuration#courses-subscription-types) |
| 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 | |
| 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 | See [Enumerations](https://github.com/ZeruLight/Erupe/wiki/Enumerations#course-types) |
| 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 | |
### `DebugOptions` Configuration
@@ -47,60 +47,75 @@
### `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 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 | |
| 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 | |
| HRPMultiplier | Adjusts the multiplier of Hunter Rank Points rewarded for quest completion | 1.00 | |
| HRPMultiplierNC | Adjusts the multiplier of Hunter Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| SRPMultiplier | Adjusts the multiplier of Skill Rank Points rewarded for quest completion | 1.00 | |
| SRPMultiplierNC | Adjusts the multiplier of Skill Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| GRPMultiplier | Adjusts the multiplier of G Rank Points rewarded for quest completion | 1.00 | |
| GRPMultiplierNC | Adjusts the multiplier of G Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| GSRPMultiplier | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion | 1.00 | |
| GSRPMultiplierNC | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| ZennyMultiplier | Adjusts the multiplier of Zenny rewarded for quest completion | 1.00 | |
| ZennyMultiplierNC | Adjusts the multiplier of Zenny rewarded for quest completion in a NetCafe | 1.00 | |
| GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | 1.00 | |
| GZennyMultiplierNC | Adjusts the multiplier of G Zenny rewarded for quest completion in a NetCafe | 1.00 | |
| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | |
| MaterialMultiplierNC | Adjusts the multiplier of Monster Materials rewarded for quest completion in a NetCafe | 1.00 | |
| GMaterialMultiplier | Adjusts the multiplier of G Monster Materials rewarded for quest completion | 1.00 | |
| GMaterialMultiplierNC | Adjusts the multiplier of G Monster Materials rewarded for quest completion in a NetCafe | 1.00 | |
| ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | |
| ExtraCarvesNC | Grant n extra chances to carve ALL carcasses in a NetCafe | 0 | |
| GExtraCarves | Grant n extra chances to carve ALL G Rank carcasses | 0 | |
| GExtraCarvesNC | Grant n extra chances to carve ALL G Rank carcasses in a NetCafe | 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.
There is limited Discord capability in Erupe. The feature allows you to relay 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 are for admin or debugging purposes.
| 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 | |
| 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 [Enumerations](https://github.com/ZeruLight/Erupe/wiki/Enumerations#course-types) |
| PSN | psn USERNAME | Links the specified PSN to your account | enabled | |
### Ravi Sub Commands
| Name | command | Description |
@@ -139,4 +154,4 @@ There are several chat commands that can be turned on and off. Most are for admi
* 12288 = PC/PS3(R)
### Courses (Subscription Types)
[Check them out here](https://github.com/ZeruLight/Erupe/wiki/Enumerations#course-types)
See [Enumerations](https://github.com/ZeruLight/Erupe/wiki/Enumerations#course-types)