ashpr/jevil repository overview

⁠JEvil

Javascript port of XEvil using the Phaser framework for mostly rendering purposes. This is a 'for fun' project to explore the possibilites of game-dev within the browser.

JEvil uses an Entity-Component system.

⁠Features

Simple tile + entity collision system. Ability to read from Tiled tile maps. Simple physics system (Gravity, movement, etc). Multiplayer Support using delta compressed packets over Socket.IO.

⁠Installation

Clone the git repo using your preferred Git client. Navigate to the repo folder npm install node jevil.js

⁠Usage

Open up http://localhost:3000/⁠ in your browser.

⁠Development

The front end is managed using Webpack. You'll need to install Webpack through npm using 'npm install -g webpack' Then do 'webpack --watch' to allow webpack to constantly and efficiently update the code for the frontend.

⁠Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request!

⁠Why not use Phasers physics system?

The multiplayer is inspired by Valves Source multiplayer component. Read more about it here: https://developer.valvesoftware.com/wiki/Source_Multiplayer_Networking⁠ In order for this to work, the physics must be emulated on the server side which is not possible using Phaser (unless you run a Phaser instance in PhantomJS which is incredibly hacky imo)

⁠Critical TODOs

• Lag compensation on the client to minimise 'jittering';
• Ability to attack other players
• Items
• Projectiles
• Some sort of gamemode script
• Tidy up!
• Many others..

⁠License

The MIT License (MIT)

Copyright (c) [year] [fullname]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.