Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 3.15 KB

README.md

File metadata and controls

108 lines (80 loc) · 3.15 KB
Raw

Dilia - Game Editor for Renaissance Build Status

Dilia is a dedicated game editor for the Renaissance project. The editor can be used for your own project, you'll probably want to fork it to adapt it to your needs.

This editor is designed to be used by multiple users with different backgrounds. One of the long term goals is to facilitate the integration of the creation or modification of quests, monsters, scripts, maps and skins that are then "automatically" integrated in the game.

Dilia is made of two part: a node.js server and a web client. In order to work properly, the server has a few requirements:

  • NodeJS version 6 or above.
  • Some packages:
    • [required] mongodb
    • [required] libkrb5-dev
  • Some environment variables:
    • [required] NODE_ENV set to production.
    • [optional] GOOGLE_SECRET and GOOGLE_CLIENTID API token in order to allow google oauth
    • [optional] GITHUB_SECRET and GITHUB_CLIENTID API token in order to allow github oauth

Development

First you need to install node and npm. You should install them via nvm. Then you run:

export NODE_ENV=development
npm install

You start the server with:

npm run build-server && npm run server

To start the client:

npm start

Note that, as for now, the project does not contain any fixture and if you do not use any external authentication provider (Google or Github), you cannot use the Dilia UI to create an account to connect with. Therefore, you have to create an user by sending a POST request directly to the Dilia server.

curl -H "Content-Type: application/json"      \
     -X POST                                  \
     -d '{"username": "test","password": "test", "email": "[email protected]"}' \
     http://localhost:8000/api/users

The server response —in case of success— is OK.

Vagrant

This repository also includes a Vagrantfile for easy set up and quick development. It will setup nvm, node, npm, performs a build of the server and the client and also install mongo-express and node-inspector which are usefull for debugging. With vagrant, simply run:

vagrant up

Within the vm (vagrant ssh), then you do:

cd /vagrant
export NODE_ENV='development' && npm run server

And navigate to http://localhost:8000/.

Dilia includes a client that can talk to lycan. When using the vagrant solution, you will end up with lycan running on your host machine and dilia on the virtual machine.

In order to allow dilia to connect to lycan, you also need to start (once) a shell with:

vagrant ssh -- -R 7777:localhost:7777

This will forward the local port 7777 to the remote machine at port 7777.

Text editor setup

Atom

If you use atom, you might consider installing those packages:

  • atom-typescript
  • linter-tslint
  • language-pegjs
  • language-glsl
  • autocomplete-paths
  • autocomplete-glsl
  • docblockr
  • color-picker

For fun :)

  • file-icons