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

157
Erupe-Configuration.md

@@ -1,28 +1,28 @@
### 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 | |
| CommandPrefix | Sets the in-game Chat Command prefix | ! | | | CommandPrefix | Sets the in-game Chat Command prefix | ! | |
| AutoCreateAccount | Allows users that don't exist to auto create their account from initial login | true | | | 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) | | 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 | | EarthStatus | Enables Pallone Fest, Tower and Conquest War events | 0 | 2=Conquest, 11=Pallone, 21=Tower |
| EarthID | A random event ID | 0 | | | EarthID | A random event ID | 0 | |
| EarthMonsters | Sets the IDs of the monsters targeted in the Conquest War | 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.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.RawEnabled | Enables saving an uncompressed copy of the savedata | false | |
| SaveDumps.OutputDir | The folder that save dumps are saved to | save-backups | | | SaveDumps.OutputDir | The folder that save dumps are saved to | save-backups | |
### `DebugOptions` Configuration ### `DebugOptions` Configuration
@@ -47,60 +47,75 @@
### `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 seconds NetCafe Boost Time lasts for | 7200 | | | 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 | | | 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] | | ClanMemberLimits | Sets the max Clan Members after hitting Rank thresholds (Max. 100) | | [Rank, Members] |
| BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | | | BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | |
| DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | | | DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | |
| 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 | | | HRPMultiplier | Adjusts the multiplier of Hunter Rank Points rewarded for quest completion | 1.00 | |
| GSRPMultiplier | Adjusts the multiplier of G Skill 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 | |
| GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | 1.00 | | | SRPMultiplier | Adjusts the multiplier of Skill Rank Points rewarded for quest completion | 1.00 | |
| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | | | SRPMultiplierNC | Adjusts the multiplier of Skill Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | | | GRPMultiplier | Adjusts the multiplier of G Rank Points rewarded for quest completion | 1.00 | |
| DisableHunterNavi | Disables the Hunter Navi | false | | | GRPMultiplierNC | Adjusts the multiplier of G Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| MezFesSoloTickets | Number of solo tickets given weekly | 5 | | | GSRPMultiplier | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion | 1.00 | |
| MezFesGroupTickets | Number of group tickets given weekly | 1 | | | GSRPMultiplierNC | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion in a NetCafe | 1.00 | |
| MezFesDuration | The duration of MezFes in seconds (start time = end of week - duration) | 172800 | | | ZennyMultiplier | Adjusts the multiplier of Zenny rewarded for quest completion | 1.00 | |
| MezFesSwitchMinigame | Switches the group minigame from Volpakkun Together to Tokotoko Partnya | false | | | ZennyMultiplierNC | Adjusts the multiplier of Zenny rewarded for quest completion in a NetCafe | 1.00 | |
| EnableKaijiEvent | Enabled the Kaiji event in the Rasta Bar (G10 only) | false | | | GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | 1.00 | |
| EnableHiganjimaEvent | Enables the Higanjima event in the Rasta Bar | false | | | GZennyMultiplierNC | Adjusts the multiplier of G Zenny rewarded for quest completion in a NetCafe | 1.00 | |
| EnableNierEvent | Enables the Nier event in the Rasta Bar | false | | | MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | |
| DisableRoad | Disables the Hunting Road | false | | | MaterialMultiplierNC | Adjusts the multiplier of Monster Materials rewarded for quest completion in a NetCafe | 1.00 | |
| SeasonOverride | Enables quests to use the current Season and time | false | | | 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 ### 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. 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 |
|----------|---------------|------------------------------------------------|----------|------------------------------------------------------------------------------------------------| |----------|---------------|------------------------------------------------|----------|---------------------------------------------------------------------------------------|
| Help | help | Shows enabled Chat Commands | enabled | | | Help | help | Shows enabled Chat Commands | enabled | |
| Rights | rights VALUE | Sets the rights integer for your account | disabled | | | Rights | rights VALUE | Sets the rights integer for your account | disabled | |
| Teleport | tele X,Y | Teleports the user to specific x,y coordinates | disabled | | | Teleport | tele X,Y | Teleports the user to specific x,y coordinates | disabled | |
| Reload | reload | Reloads all users and character objects | enabled | | | Reload | reload | Reloads all users and character objects | enabled | |
| KeyQuest | kqf FLAGS | Sets the Key Quest Flag for your character | disabled | | | 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) | | 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 | | | PSN | psn USERNAME | Links the specified PSN to your account | enabled | |
### Ravi Sub Commands ### Ravi Sub Commands
| Name | command | Description | | 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) * 12288 = PC/PS3(R)
### Courses (Subscription Types) ### 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)