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

Update README.md

Browse Source
This commit is contained in:
ser3n1ty 2024-05-08 19:46:42 -07:00 committed by GitHub
parent d3bc315b04
commit 8563e61880
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,25 +1,25 @@
# rogueserver # rogueserver
Hosting in Docker # Hosting in Docker
It is advised that you host this in a docker container as it will be much easier to manage. It is advised that you host this in a docker container as it will be much easier to manage.
There is a sample docker-compose file for setting up a docker container to setup this server. There is a sample docker-compose file for setting up a docker container to setup this server.
Self Hosting outside of Docker: # Self Hosting outside of Docker:
Windows: ## Windows:
Recommended Tools: Recommended Tools:
Chocolatey (https://chocolatey.org/install) Chocolatey (https://chocolatey.org/install)
Required Tools: ## Required Tools:
Golang Golang
Node: 18.3.0 Node: 18.3.0
npm: how to install (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
Installation: ## Installation:
Once you have all the prerequisites you will need to setup a database. Once you have all the prerequisites you will need to setup a database.
There are tons of database services you can choose from: There are tons of database services you can choose from:
mysql - getting started (https://dev.mysql.com/doc/mysql-getting-started/en/) mysql - [getting started](https://dev.mysql.com/doc/mysql-getting-started/en/)
mariadb - getting started (https://mariadb.com/get-started-with-mariadb/) mariadb - [getting started](https://mariadb.com/get-started-with-mariadb/)
etc etc
I went with MySQL. Once the database is setup, make sure that you can authenticate to the database. I went with MySQL. Once the database is setup, make sure that you can authenticate to the database.
@ -27,16 +27,16 @@ After being able to login to the database, create a database/schema called poker
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. 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: Edit the following files:
##### rogueserver.go:34 ### 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. 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 ### rogueserver.go:37
Change the default port if you need to, I set it to 8001. Change the default port if you need to, I set it to 8001.
##### rogueserver.go:39-43 ### rogueserver.go:39-43
Make sure that the credentials that you tested to login to the database are put in here. Make sure that the credentials that you tested to login to the database are put in here.
##### src/utils.ts:224-225 (in pokerogue) ### 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) 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): Now that all of the files are configured: start up powershell as administrator (or save the following as a ps1):
@ -56,9 +56,14 @@ 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 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 parts on the network. If you want to tie it to a domain like I did, there is some extra work to be done. 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. I setup caddy and would recommend using it as a reverse proxy.
caddy installation - (https://caddyserver.com/docs/install) [caddy installation](https://caddyserver.com/docs/install)
once its installed setup a config file for caddy: once its installed setup a config file for caddy:
pokerogue.exampledomain.com { pokerogue.exampledomain.com {
@ -68,10 +73,10 @@ pokeapi.exampledomain.com {
reverse_proxy localhost:8001 reverse_proxy localhost:8001
} }
Preferably set up caddy as a service from here: https://caddyserver.com/docs/running 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 Once this is good to go, take your API url (https://pokeapi.exampledomain.com) and paste it on
##### src/utils.ts:224-225 ### src/utils.ts:224-225
in place of the previous 0.0.0.0:8001 address in place of the previous 0.0.0.0:8001 address
Make sure that both 8000 and 8001 are portforwarded on your router. Make sure that both 8000 and 8001 are portforwarded on your router.