Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dnbard/eclipse-server

browser-game gamedev pixi

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/dnbard/eclipse-server
Owner: dnbard
Created: 2016-09-18T20:14:34.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2016-12-17T09:33:25.000Z (about 8 years ago)
Last Synced: 2024-11-27T13:46:53.613Z (2 months ago)
Topics: browser-game, gamedev, pixi
Language: JavaScript
Homepage: https://curio.herokuapp.com/
Size: 3.64 MB
Stars: 3
Watchers: 5
Forks: 1
Open Issues: 17
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Eclipse [![Build Status](https://travis-ci.org/dnbard/eclipse-server.svg?branch=master)](https://travis-ci.org/dnbard/eclipse-server) [![codecov](https://codecov.io/gh/dnbard/eclipse-server/branch/master/graph/badge.svg)](https://codecov.io/gh/dnbard/eclipse-server)

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

![screenshot](https://raw.githubusercontent.com/dnbard/eclipse-server/master/presentation/01.png)

## 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](https://github.com/dnbard/eclipse-server/projects/1)

* 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](https://github.com/dnbard/eclipse-server/issues/5) for it).

Test server - EU [Curio](https://curio.herokuapp.com/) ![server](https://curio.herokuapp.com/server/badge)

## Additional Tools

* [Image Preparation Tool](https://github.com/dnbard/eclipse-image-process)