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

readme review pass 1

Browse Source
This commit is contained in:
wish
2023-07-08 00:55:26 +10:00
parent 5af40ab46a
commit cf1da979ec
1 changed files with 65 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
README.md
View File

@@ -11,18 +11,17 @@ If you want to modify or compile Erupe yourself, please read on.
- [Go](https://go.dev/dl/) - [Go](https://go.dev/dl/)
- [PostgreSQL](https://www.postgresql.org/download/) - [PostgreSQL](https://www.postgresql.org/download/)
# Comptaible Clients ## Client Compatiblity
## Platforms ### Platforms
- PC - PC
- PS3 - PS3
- PSVita - PSVita
- Wii U - Wii U
## Versions ### Versions
- ZZ - ZZ (Z3)
- Z2 - Z2
- Z1 - Z1
### Installation ### Installation
1. Bring up a fresh database by using the [backup file attached with the latest release](https://github.com/ZeruLight/Erupe/releases/latest/download/SCHEMA.sql). 1. Bring up a fresh database by using the [backup file attached with the latest release](https://github.com/ZeruLight/Erupe/releases/latest/download/SCHEMA.sql).
@@ -34,87 +33,86 @@ If you want to modify or compile Erupe yourself, please read on.
- [Quest and Scenario Binary Files](https://files.catbox.moe/xf0l7w.7z) - [Quest and Scenario Binary Files](https://files.catbox.moe/xf0l7w.7z)
- [PewPewDojo Discord](https://discord.gg/CFnzbhQ) - [PewPewDojo Discord](https://discord.gg/CFnzbhQ)
- [Community FAQ Pastebin](https://pastebin.com/QqAwZSTC)
## Configuration ## Configuration
This portion of the documetation goes over the `config.json` file. This portion of the documentation goes over the `config.json` file.
### General Configuraiton ### General Configuration
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------- | |------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------------------|
| Host | the ip the server is running from | 127.0.0.1 | | | 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 | | | 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. The two options are english `en` and japanese `ja` if you wish to contribute other languages talk to a maintainer. | en | en/jp | | Language | This is the language the server will run in. Only English `en` and Japanese `ja` are available, if you wish to contribute to tranlation, get in touch | en | en/jp |
| DisableSoftCrash | | false | | | DisableSoftCrash | | false | |
| HideLoginNotice | This hides the notices that appear on login from `LoginNotices` | true | | | 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 | | | | LoginNotices | This is where you place notices for users, you can have multiple notices | | |
| PatchServerManifest | | | | | PatchServerManifest | | | |
| PatchServerFile | | | | | PatchServerFile | | | |
| ScreenshotAPIURL | This is the url you want user sreenshots to go to. | | | | ScreenshotAPIURL | This is the URL you want user sreenshots to go to | | |
| DeleteOnSaveCorruption | This option deletes a users save if they corrupt it from the database. Can be used as punishment for cheaters | false | | | DeleteOnSaveCorruption | This option deletes a users save if they corrupt it from the database, can be used as punishment for cheaters | false | |
| ClientMode | This tells the server what client it should run for | ZZ | Check compatible versions above | | ClientMode | This tells the server what client it should run for | ZZ | Check compatible versions above |
| DevMode | This enables DevModeOptions to be configured | true | | | DevMode | This enables DevModeOptions to be configured | true | |
### `DevModeOptions` Configuraiton ### `DevModeOptions` Configuraiton
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
| -------------------- | -------------------------------------------------------------------------------------------------- | -------- | ----------------------- | |----------------------|----------------------------------------------------------------------------------------------------|----------|-------------------------|
| AutoCreateAccount | This allows users that dont exist to auto create there account from initial login | true | | | AutoCreateAccount | This allows users that don't exist to auto create there account from initial login | true | |
| CleanDB | This cleans the databse down | false | | | CleanDB | This cleans the database down | false | |
| MaxLauncherHR | This sets the launcher value to HR7 to allow you to break server HR requirements | 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 in the stdout terminal you run the applicaiton from | false | | | LogInboundMessages | This will allow inbound messages to be logged in the stdout terminal you run the applicaiton from | false | |
| LogOutboundMessages | This will allow outbound messages to be logged in the stdout terminal you run the applicaiton from | false | | | LogOutboundMessages | This will allow outbound messages to be logged in the stdout terminal you run the applicaiton from | false | |
| MaxHexdumpLength | This is the amount of hex that will be dumped to stdout along side a message | 0 | | | MaxHexdumpLength | This is the maximum amount of hex that will be dumped to stdout along side a message | 0 | |
| DivaEvent | This sets the Dive event stage in game | 2 | 0/1/2/3/-1 | | DivaEvent | This overrides the Diva event stage in game | 2 | 0/1/2/3/-1 |
| FestaEvent | This sets the Hunter Festival event stage in game | 2 | 0/1/2/3/-1 | | FestaEvent | This overrides the Hunter Festival event stage in game | 2 | 0/1/2/3/-1 |
| TournamentEvent | This sets the Hunter Tournement event stage in game | 2 | 0/1/2/3/-1 | | TournamentEvent | This overrides the Hunter Tournament event stage in game | 2 | 0/1/2/3/-1 |
| MezFesEvent | Enables whether the MezFes event/world is active | true | | | MezFesEvent | Enables whether the MezFes event & World are active | true | |
| MezFesAlt | Switches the multiplayer mesfes event | false | | | MezFesAlt | Switches the multiplayer MezFes event | false | |
| DisableTokenCheck | This disables the random token that is generated at login from being checked | 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 | Enable various quest debug logs | false | |
| EarthStatusOverride | Enables events pallone fest,tower and conquest | 0 | 21=Tower,11=PalloneFest | | | EarthStatusOverride | Enables Pallone Fest, Tower and Conquest War events | 0 | 21=Tower,11=PalloneFest | |
| EarthIDOverride | A random event ID | 0 | | | EarthIDOverride | A random event ID | 0 | |
| EarthMonsterOverride | ? | 0 | | | EarthMonsterOverride | Sets the ID of the monster targeted in the Conquest War | 0 | |
| SaveDumps.Enables | Enables save dumps to a folder that is set at `SaveDumps.OutputDir` | true | | | SaveDumps.Enables | Enables save dumps to a folder that is set at `SaveDumps.OutputDir` | true | |
| SaveDumps.OutputDir | The folder that save dumps are saved to | savedata | | | SaveDumps.OutputDir | The folder that save dumps are saved to | savedata | |
### `GameplayOptions` Configuraiton ### `GameplayOptions` Configuraiton
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
| -------------------- | --------------------------------------------------------------------------- | ------- | ------- | |----------------------|-----------------------------------------------------------------------------|---------|---------|
| FeaturedWeapons | Number of Active Feature weapons to generate daily | 0 | | | FeaturedWeapons | Number of Active Feature weapons to generate daily | 0 | |
| MaximumNP | Maximum number of NP held by a player | 100000 | | | MaximumNP | Maximum number of NP held by a player | 100000 | |
| MaximumRP | Maximum number of RP held by a player | 100000 | | | MaximumRP | Maximum number of RP held by a player | 100000 | |
| 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 minutes NetCafe Boost Time lasts for | 120 | |
| GuildMealDuration | The number of minutes a Guild Meal can be activated for after cooking | | | | GuildMealDuration | The number of minutes a Guild Meal can be activated for after cooking | 60 | |
| BonusQuestAllowance | Number of Bonus Point Quests to allow daily | | | | BonusQuestAllowance | Number of Bonus Point Quests to allow daily | 3 | |
| DailyQuestAllowance | Number of Daily Quests to allow daily | | | | DailyQuestAllowance | Number of Daily Quests to allow daily | 1 | |
| MezfesSoloTickets | Number of solo tickets given weekly | | | | MezfesSoloTickets | Number of solo tickets given weekly | 10 | |
| MezfesGroupTickets | Number of group tickets given weekly | | | | MezfesGroupTickets | Number of group tickets given weekly | 4 | |
| GUrgentRate | Adjusts the rate of G Urgent quests spawning | | | | GUrgentRate | Adjusts the rate of G Urgent quests spawning | 10 | |
| GCPMultiplier | Adjusts the multiplier of GCP rewarded for quest completion | | | | GCPMultiplier | Adjusts the multiplier of GCP rewarded for quest completion | 1.00 | |
| GRPMultiplier | Adjusts the multiplier of G Rank Points rewarded for quest completion | | | | 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 | | | | 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 | | | | GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | 1.00 | |
| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | | | | MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | 1.00 | |
| ExtraCarves | Grant n extra chances to carve ALL carcasses | | | | ExtraCarves | Grant n extra chances to carve ALL carcasses | 0 | |
| DisableHunterNavi | Disables the Hunter Navi | | | | DisableHunterNavi | Disables the Hunter Navi | false | |
| EnableHiganjimaEvent | Enables the Higanjima event in the Rasta Bar | | | | EnableHiganjimaEvent | Enables the Higanjima event in the Rasta Bar | false | |
| EnableNierEvent | Enables the Nier event in the Rasta Bar | | | | EnableNierEvent | Enables the Nier event in the Rasta Bar | false | |
| DisableRoad | Disables the Hunting Road | | | | DisableRoad | Disables the Hunting Road | false | |
### Discord ### Discord
There is limited discord capability in erupe. That 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.
This may be either be removed or revamped in a future version.
### Commands ### Commands
There are a series of 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 of them are really for admins or debugging purposes.
| Name | command | Description | Options | | Name | command | Description | Options |
| -------- | -------------- | ------------------------------------------------------- | ------------------- | |----------|----------------|---------------------------------------------------------|---------------------|
| Rights | !rights | Changes rights interger to specifc interger | | | Rights | !rights | Changes rights interger to specifc interger | |
| Teleport | !tele | Teleports user to specific x,y,z | | | Teleport | !tele | Teleports user to specific x,y,z | |
| Reload | !reload | Flush all objects and users and reload stage you are on | | | Reload | !reload | Flush all objects and users and reload stage you are on | |
@@ -124,20 +122,20 @@ There are a series of commands that can be turned on and off. Most of them are r
### Ravi Sub Commands ### Ravi Sub Commands
| Name | command | Description | Options | | Name | command | Description | Options |
| -------- | -------------------------------- | ----------------------------- | ------- | |----------|----------------------------------|-------------------------------|---------|
| Raviente | !ravi start | Starts Ravi Event | | | Raviente | !ravi start | Starts Ravi Event | |
| Raviente | !ravi cm / !ravi checkmultiplier | Checks ravi health multiplier | | | Raviente | !ravi cm / !ravi checkmultiplier | Checks Ravi health multiplier | |
| Raviente | !ravi ss | send sedation | | | Raviente | !ravi ss | Send sedation | |
| Raviente | !ravi sr | send resurrection | | | Raviente | !ravi sr | Send resurrection | |
| Raviente | !ravi rs | request sedation | | | Raviente | !ravi rs | Request sedation | |
## World `Entries` config ## World `Entries` config
| Config Item | Description | Options | | Config Item | Description | Options |
| ----------- | --------------------------------------------- | -------------------------------------------------------------------- | |-------------|------------------|------------------------------------------------------------|
| Type | Server type. | 1=Normal, 2=Cities, 3=newbie, 4=Tavern 6=MezFes | | Type | Server type. | 1=Normal, 2=Cities, 3=Newbie, 4=Tavern, 5=Return, 6=MezFes |
| Season | Server activity. | 0 = Green/Breeding, 1 = Orange/Warm, 2 = Blue/Cold | | Season | Server activity. | 0=Green/Breeding, 1=Orange/Warm, 2=Blue/Cold |
### `Recommend` ### `Recommend`
This sets the types of quest that can be ordered from a world. This sets the types of quest that can be ordered from a world.
@@ -146,4 +144,4 @@ This sets the types of quest that can be ordered from a world.
* 2 = Up to 4 star quests * 2 = Up to 4 star quests
* 4 = All Quests in HR (Enables G Experience Tab) * 4 = All Quests in HR (Enables G Experience Tab)
* 5 = Only G rank quests * 5 = Only G rank quests
* 6 = mini games world there is no place to order quests * 6 = Mini games world there is no place to order quests