Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 2.75 KB

README.md

File metadata and controls

61 lines (47 loc) · 2.75 KB

HC-TCG

https://www.reddit.com/r/HermitCraft/comments/10wksaw/hctcg_online/

Node.js

Use Node.js 16-18 (19+ is not supported).

If you don't have Node.js yet we recommend using nvm.

How to run the project

  • First, you must install packages using npm ci - use this instead of npm install to avoid unneccesary changes in package-lock.json
  • The client is compiled, so must be built before use with npm run build
  • The server can then be run using npm run start or npm run server
  • Whilst developing, it may be useful so run the client or server such that they reload if you make a change. This can be done by running npm run client:dev and npm run server:dev respectively.

Configuration

You can configure your instance using the config/server-config.json file.

Key Description
port Server port
clientDevPort Port for vite client server
clientPath Path for the client build used
cors Useful when testing on local network or when your server runs on a different domain
world Identifier for your instance when tracking stats
limits Limits for players' decks
logoSubText Animated text to show next to logo
botUrl Url to report game results to
version Version displayed on the client

Formatting & coding style

We run lint/prettier/tsc as part of the PR process. However if you want to avoid back and forth we recommend adding a pre-commit hook that will test this for you locally every time you create a new commit:

npm run husky

We also recommend to run prettier on save in your editor, this is an example configuration using the prettier extension for VSCode:

// .vscode/settings.json
{
	"[json][jsonc]": {
		"editor.defaultFormatter": "esbenp.prettier-vscode",
		"editor.formatOnSave": true
	},
	"[javascript][typescript][typescriptreact]": {
		"editor.defaultFormatter": "esbenp.prettier-vscode",
		"editor.formatOnSave": true
	},
	"[css][scss]": {
		"editor.defaultFormatter": "esbenp.prettier-vscode",
		"editor.formatOnSave": true
	},
	"typescript.tsdk": "node_modules/typescript/lib"
}