Game Server and AI engine for the project.
-
Fork and Clone the repository locally.
-
Install
Node.js v20
, preferable using Node Version Manager (nvm
). After installingnvm
, you can runnvm install --lts
to do that. Then, runnvm use --lts
to switch to the correct version. -
Run
npm i
to install all the required dependencies. -
Create a file
.env.development
in the root directory of the project with the following contents. Do get your own OpenAI API Key by creating an account of their platform https://help.openai.com/en/articles/4936850-where-do-i-find-my-api-key
PLAYER_CHANCE_LENGTH=5000
OPENAI_API_KEY=<<Your API Key>>
OPENAI_MODEL=gpt-3.5-turbo-1106
OPENAI_RUN_POLLING_INTERVAL=500
OPENAI_RUN_POLLING_TIMEOUT=5000
-
Run
npm start
. Once the server starts, open localhost with the correct port in the browser. Most probably, it would behttp://localhost:2567
. -
Use
http://localhost:2567
for client playground andhttp://localhost:2567/colyseus
for monitor.
-
Raise PRs only to the
main
branch. -
There is a pre-commit hook for
prettier
. Please honor it, and report a bug if it does not execute automatically. -
Resolve all merge conflicts unless states otherwise.
This project has been created using ⚔️ colyseus
- Multiplayer Framework for Node.js