search

ai-economy-simulator / ecosim-server

Apache License 2.0
0 stars 3 forks source link

readme

AI Economy Simulator

Game Server and AI engine for the project.

Development Setup

  1. Fork and Clone the repository locally.

  2. Install Node.js v20, preferable using Node Version Manager (nvm). After installing nvm, you can run nvm install --lts to do that. Then, run nvm use --lts to switch to the correct version.

  3. Run npm i to install all the required dependencies.

  4. 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

  1. Run npm start. Once the server starts, open localhost with the correct port in the browser. Most probably, it would be http://localhost:2567.

  2. Use http://localhost:2567 for client playground and http://localhost:2567/colyseus for monitor.

Contributing Guidelines

  1. Raise PRs only to the main branch.

  2. There is a pre-commit hook for prettier. Please honor it, and report a bug if it does not execute automatically.

  3. Resolve all merge conflicts unless states otherwise.

Special Credits

This project has been created using ⚔️ colyseus - Multiplayer Framework for Node.js