diff --git a/README.md b/README.md index 669f37573..818236cb3 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ If you want to modify or compile Erupe yourself, please read on. - [Go](https://go.dev/dl/) - [PostgreSQL](https://www.postgresql.org/download/) +# Comptaible Clients +- ZZ +- Z2 +- Z1 + ### 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). @@ -18,12 +23,120 @@ If you want to modify or compile Erupe yourself, please read on. 3. Edit [config.json](./config.json) such that the database password matches your PostgreSQL setup. 4. Run `go build` or `go run .` to compile Erupe. -### Note - -- You will need to acquire and install the client files and quest binaries separately. - ## Resources - [Quest and Scenario Binary Files](https://files.catbox.moe/xf0l7w.7z) - [PewPewDojo Discord](https://discord.gg/CFnzbhQ) - [Community FAQ Pastebin](https://pastebin.com/QqAwZSTC) + + +## Configuration +This portion of the documetation goes over the `config.json` file. + +### General Configuraiton + +| Variable | Description | Default | Options | +| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------- | +| Host | the ip 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. The two options are english `en` and japanese `ja` if you wish to contribute other languages talk to a maintainer. | 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 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 | +| DevMode | This enables DevModeOptions to be configured | true | | + +### `DevModeOptions` Configuraiton + +| Variable | Description | Default | Options | +| -------------------- | -------------------------------------------------------------------------------------------------- | -------- | ----------------------- | +| AutoCreateAccount | This allows users that dont exist to auto create there account from initial login | true | | +| CleanDB | This cleans the databse down | false | | +| MaxLauncherHR | This sets the launcher value to HR7 to allow you to break server HR requirements | 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 | | +| MaxHexdumpLength | This is the 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 | +| FestaEvent | This sets 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 | +| MezFesEvent | Enables whether the MezFes event/world is active | true | | +| MezFesAlt | Switches the multiplayer mesfes event | false | | +| DisableTokenCheck | This disables the random token that is generated at login from being checked | false | | +| QuestDebugTools | Enable various quest debug logs | false | | +| EarthStatusOverride | Enables events pallone fest,tower and conquest | 0 | 21=Tower,11=PalloneFest | | +| EarthIDOverride | A random event ID | 0 | | +| EarthMonsterOverride | ? | 0 | | +| 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 | | + +### `GameplayOptions` Configuraiton + +| 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 | | | +| BonusQuestAllowance | Number of Bonus Point Quests to allow daily | | | +| DailyQuestAllowance | Number of Daily Quests to allow daily | | | +| MezfesSoloTickets | Number of solo tickets given weekly | | | +| MezfesGroupTickets | Number of group tickets given weekly | | | +| GUrgentRate | Adjusts the rate of G Urgent quests spawning | | | +| GCPMultiplier | Adjusts the multiplier of GCP rewarded for quest completion | | | +| GRPMultiplier | Adjusts the multiplier of G Rank Points rewarded for quest completion | | | +| GSRPMultiplier | Adjusts the multiplier of G Skill Rank Points rewarded for quest completion | | | +| GZennyMultiplier | Adjusts the multiplier of G Zenny rewarded for quest completion | | | +| MaterialMultiplier | Adjusts the multiplier of Monster Materials rewarded for quest completion | | | +| ExtraCarves | Grant n extra chances to carve ALL carcasses | | | +| DisableHunterNavi | Disables the Hunter Navi | | | +| EnableHiganjimaEvent | Enables the Higanjima event in the Rasta Bar | | | +| EnableNierEvent | Enables the Nier event in the Rasta Bar | | | +| DisableRoad | Disables the Hunting Road | | | + +### Discord +There is limited discord capability in erupe. That allows you to replay messages from your server into a channel. + +### Commands +There are a series of commands that can be turned on and off. Most of them are really for admins or debugging purposes. + +| Name | command | Description | Options | +| -------- | -------------- | ------------------------------------------------------- | ------------------- | +| Rights | !rights | Changes rights interger to specifc interger | | +| Teleport | !tele | Teleports user to specific x,y,z | | +| Reload | !reload | Flush all objects and users and reload stage you are on | | +| KeyQuest | !kqf | | | +| Course | !course OPTION | Changes the players course | HL,EX,Premium,Boost | +| PSN | !psn USERNAME | Links Erupe account to PSN | | + +### Ravi Sub Commands +| Name | command | Description | Options | +| -------- | -------------------------------- | ----------------------------- | ------- | +| Raviente | !ravi start | Starts Ravi Event | | +| Raviente | !ravi cm / !ravi checkmultiplier | Checks ravi health multiplier | | +| Raviente | !ravi ss | send sedation | | +| Raviente | !ravi sr | send resurrection | | +| Raviente | !ravi rs | request sedation | | + + +## World `Entries` config + +| Config Item | Description | Options | +| ----------- | --------------------------------------------- | -------------------------------------------------------------------- | +| Type | Server type. | 1=Normal, 2=Cities, 3=newbie, 4=Tavern 6=MezFes | +| Season | Server activity. | 0 = Green/Breeding, 1 = Orange/Warm, 2 = Blue/Cold | + +### `Recommend` +This sets the types of quest that can be ordered from a world. +* 0 = All quests +* 1 = Up to 2 star quests +* 2 = Up to 4 star quests +* 4 = All Quests in HR (Enables G Experience Tab) +* 5 = Only G rank quests +* 6 = mini games world there is no place to order quests \ No newline at end of file