Skip to content

DockerGC is a container that run Grasscutter (anime game) with just a single command.

License

Notifications You must be signed in to change notification settings

YuukiPS/DockerGS

Repository files navigation

DockerGS

DockerGS is a container that run Grasscutter (some anime game) with just a single command.

How to connect to server

Since I don't want to write same post, please visit this

How to create a server:

Docker Version

  • Install Docker + (MongoDB If you want to run outside container)
  • Open Terminal and Enter:
# Database (just once) (use this if you don't have a database outside container or want to use between containers)
docker run --rm -it --name db_gc -p 2777:27017/tcp -d mongo &
# Game server (just once download resources with -download_resource 'yes' after that you can set -download_resource 'no') (remember replace 2.0.0.100 with your pc's ip and don't use "localhost" this is important)
docker run --rm -it \
--name dockergs \
-v resources:/home/dockergs/resources \
-p 22102:22102/udp \
-p 80:80/tcp \
siakbary/dockergs:ubuntu-gc-5.0 \
--database 'mongodb://2.0.0.100:2777' \
--web_ip '2.0.0.100' \
--web_port '80' \
--game_ip '2.0.0.100' \
--game_port '22102' \
--download_resource 'yes' \
--ssl 'false'
--web_url_ssl "false"

or if you have Docker Compose

git clone https://github.com/YuukiPS/DockerGS
cd DockerGS
# docker compose up  # windows
docker-compose up -d # linux
  • Then type "account create yourusername" if there is a new response open the game.
  • Yay

Windows (Jar Only)

  1. Download & Install Java 17 JDK & MongoDB (If you don't have) (Remember this does not require Install Docker.)
  2. Download file zip, scroll down I'm sure you can find it easily
  3. Open file zip and unzip/open again file DockerGS_GC.tar
  4. When you successfully unzip/open you will find "work_gc" folder click it then Extract it to folder you want (if you have an "Official/other version" Grasscutter you can overwrite it)
  5. Make sure you have a (folder,file) "Resources" which you can get from Yuuki
  6. Open Terminal (Make sure you open it by right-clicking on folder that has jar file) then type "java -jar grasscutter.jar"
  7. Have fun :)

Ubuntu (Jar Only)

TODO

Available

Versions OS Platform
5.0 (25) Alpine linux/amd64

Download (Jar Only)

Versions Platform
5.0 (25) linux/amd64

Some Tips:

How to build this?

Source code YuukiPS is closed now because many people are remove "source link,credits" from public server/vip forum download, so we will only provide original Grasscutter Quest or Grasscutter version for docker/jar later.

If you wish to Contribute YuukiPS, please contact me.

Required

Clone this with

git clone https://github.com/YuukiPS/DockerGS
cd DockerGS
cd gs

# 2.0.0.100 is your ip computer, make sure you have mongodb installed

sh run.sh # default build localhost

sh run.sh local res 25 # Get Resources File Based Version Server

sh run.sh local start 25 # run localhost server for without docker
sh run.sh alpine start 25 2.0.0.100 # run localhost server for with docker alpine
sh run.sh ubuntu start 25 2.0.0.100 # run localhost server for with docker ubuntu

sh run.sh local build 25 # Build local aja jar only
sh run.sh alpine build 25 # Build Docker Image Alpine
sh run.sh ubuntu build 25 # Build Docker Image Ubuntu

sh run.sh ubuntu build 25 multi # Build Docker Image Ubuntu

sh run.sh local sync 25 # Sync Grasscutters to Yuuki

sh run.sh data core # Clone Patch Version

Note:

  • If you have a problem with not foundsh: Change CRLF to LF

Command

Variable Info
-db --database IP Address for your database server, note: use computer ip if you want to run on your own pc/server, no "localhost" because it is IP in Container
-webip --web_ip IP/Domain Public Web Server
-webport --web_port Port Public Web Server, if you want http use port 80 and if you want https use 443 (default 80)
-ssl --ssl If this is set to "true" it will make https not working and if it is "false" it will make http not working. please select: (default false)
-weburlssl --web_url_ssl This changes URL "https" or "http", This is useful if you have a reverse proxy and have your own SSL. (default false)
-gameip --game_ip IP Public Game Server
-gameport --game_port Port Public Game Server
-msgwc --message_welcome Chat Welcome Message
-nmsv --name_server Name Server
-nmow --name_owner Server Owner Name
-nmrg --name_region Server Region Name
-mailmsg --mail_message Email welcome when registering for first time
-po --player_online Player limit online (-1 for unlimited)
-loginpass --login_password If you want to be more secure by using password feature at login
-dlres --download_resource Re-download resources if you type "yes" this is useful if you already have a resources folder but there is latest update
-lang --language Server Language and includes commands more info
-j --java -Xms500M -Xmx8G more info
-h --help todo

Port

Port Info
80 Web Server for HTTP. (Not required)
443 Web Server for HTTPS. (required)
22102 Game Communication (udp) (required)

Contribution

Power by Grasscutter ❤️