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

Make README.md adequate to Markdown Style Standards

Browse Source
This commit is contained in:
Evotushon
2023-04-24 16:26:56 +02:00
parent 6fecfdd63f
commit 75a803f1a2
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,19 +1,29 @@
# Erupe Community Edition # Erupe Community Edition
## Setup ## Setup
If you are only looking to install Erupe, please use [a pre-compiled binary](https://github.com/ZeruLight/Erupe/releases/latest). If you are only looking to install Erupe, please use [a pre-compiled binary](https://github.com/ZeruLight/Erupe/releases/latest).
If you want to modify or compile Erupe yourself, please read on. If you want to modify or compile Erupe yourself, please read on.
### Requirements ### Requirements
- [Go](https://go.dev/dl/) - [Go](https://go.dev/dl/)
- [PostgreSQL](https://www.postgresql.org/download/) - [PostgreSQL](https://www.postgresql.org/download/)
### 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).
2. Run each script under [patch-schema](./patch-schema) as they introduce newer schema. 2. Run each script under [patch-schema](./patch-schema) as they introduce newer schema.
3. Edit [config.json](./config.json) such that the database password matches your PostgreSQL setup. 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. 4. Run `go build` or `go run .` to compile Erupe.
### Note ### Note
- You will need to acquire and install the client files and quest binaries separately. - You will need to acquire and install the client files and quest binaries separately.
# Resources
## Resources
- [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) - [Community FAQ Pastebin](https://pastebin.com/QqAwZSTC)ter