Skip to content

dnbard/eclipse-server

Repository files navigation

Eclipse Build Status codecov

Server for online browser game written in NodeJS(back-end) and Pixi(front-end).

screenshot

How to setup

  • clone this repository git clone https://github.com/dnbard/eclipse-server.git
  • install npm dependencies npm install
  • install and run mongod(MongoDB database) - sudo service mongod start
  • run server with nodemon command
  • open URL http://localhost:3000 in browser

Game Menu

Press F1 to open in-game menu(inventory, PVP rating etc). This menu are going to work in /eclipse page(main page) only.

Debug mode

Debug mode are going to enabled by default locally. It will be disabled on Curio and similar environments. Open development tools (F12) and write window.DEBUG to access debug mode at the client-side.

Available commands:

  • showNextWSMessage - will show next message that will come through the WebSockets

How to contribute

  • get task from project kanban board
  • start working on low priority tasks while learning the architecture
  • commit your work and create pull request for review
  • don't forget to write some tests for your code =)

Servers

New version of server are going to be deployed once commit make its way to master branch and pass all tests during the CI process(not created atm - task for it).

Test server - EU Curio server

Additional Tools