mirror/rogueserver
1
0
Fork 0
mirror of https://github.com/pagefaultgames/rogueserver.git synced 2025-04-02 02:57:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
ser3n1ty 2024-05-08 23:40:21 -07:00 committed by GitHub
parent 12b0124bfb
commit cb333cdd71
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
README.md
View File

@ -39,98 +39,37 @@ Make sure that the credentials that you tested to login to the database are put
### src/utils.ts:224-225 (in pokerogue)
Replace both URLs (one on each line) with the local API server address from rogueserver.go (0.0.0.0:8001) (or whatever port you picked)
Now that all of the files are configured: start up powershell as administrator (or save the following as a ps1):
# If you are on Windows
Now that all of the files are configured: start up powershell as administrator:
```
powershell -ep bypass
cd C:\api\server\location\
go run .
```
Then in another run this the first time, then remove the npm install if you plan on running this as a powershell script in the future:
Then in another run this the first time then run `npm run start` from the rogueserver location from then on:
```
powershell -ep bypass
cd C:\rogue\server\location\
npm install
npm run start
```
You will need to allow the port youre running the API (8001) on and port 8000 to accept inbound connections through the [Windows Advanced Firewall](https://www.youtube.com/watch?v=9llH5_CON-Y).
You will need to allow the port youre running the API (8001) on and port 8000 to accept inbound connections through the windows advanced firewall.
This should allow you to reach the game from other computers on the same network.
## Tying to a Domain
If you want to tie it to a domain like I did and make it publicly accessible, there is some extra work to be done.
I setup caddy and would recommend using it as a reverse proxy.
[caddy installation](https://caddyserver.com/docs/install)
once its installed setup a config file for caddy:
# If you are on Linux
In whatever shell you prefer, run the following:
```
pokerogue.exampledomain.com {
reverse_proxy localhost:8000
}
pokeapi.exampledomain.com {
reverse_proxy localhost:8001
}
```
Preferably set up caddy as a service from [here.](https://caddyserver.com/docs/running)
Once this is good to go, take your API url (https://pokeapi.exampledomain.com) and paste it on
### src/utils.ts:224-225
in place of the previous 0.0.0.0:8001 address
Make sure that both 8000 and 8001 are portforwarded on your router.
Test that the server's game and game authentication works from other machines both in and outside of the network. Once this is complete, enjoy!
## Linux
## Required Tools:
- Golang
- Node: **18.3.0**
- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
## Installation:
Once you have all the prerequisites you will need to setup a database.
There are tons of database services you can choose from:
- mysql - [getting started](https://dev.mysql.com/doc/mysql-getting-started/en/)
- mariadb - [getting started](https://mariadb.com/get-started-with-mariadb/)
- etc
I went with MySQL. Once the database is setup, make sure that you can authenticate to the database.
After being able to login to the database, create a database/schema called pokeroguedb.
Select it as the default database and then run the sql queries from sqlqueries.sql. You should now be able to see all of the empty tables.
Edit the following files:
### rogueserver.go:34
Change the 'false' after "debug" to 'true'. This will resolve CORS issues that many users have been having while trying to spin up their own servers.
### rogueserver.go:37
Change the default port if you need to, I set it to 8001.
### rogueserver.go:39-43
Make sure that the credentials that you tested to login to the database are put in here.
### src/utils.ts:224-225 (in pokerogue)
Replace both URLs (one on each line) with the local API server address from rogueserver.go (0.0.0.0:8001) (or whatever port you picked)
Now that all of the files are configured: start up powershell as administrator (or save the following as a ps1):
```
cd C:\api\server\location\
go run .
```
Then in another run this the first time, then remove the npm install if you plan on running this as a powershell script in the future:
```
powershell -ep bypass
go run . &
cd C:\rogue\server\location\
npm install
npm run start
```
You will need to allow the port youre running the API (8001) on and port 8000 to accept inbound connections through the windows advanced firewall.
You will need to allow the ports youre running the API (8001) and port 8000 to accept inbound connections if your firewall is block it. you can run the following to allow incoming connections using UFW
```
sudo ufw allow 8000,8001/tcp
```
This should allow you to reach the game from other computers on the same network.