_Bastler/partey_workadventure
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
91ce318848
partey_workadventure/back
History
David Négrier 91ce318848 Changing license to AGPL + Commons Clause 
This is an important change.
So far, the project was labelled as licensed under the "AGPL" (improperly since no version of the AGPL was specified)

This commit changes the license to "AGPL + Commons Clause"

The [common clause](https://commonsclause.com/) is an additional restriction forbidding companies from taking WorkAdventure of the shelf, and reselling WorkAdventure.

This license does not forbid anyone from installing and using WorkAdventure, it only targets resellers (so SAAS exploitation of WorkAdventure is limited to TheCodingMachine).

This effectively makes WorkAdventure non open-source, but the source-code remains available for anyone to see and modify.
2020-06-09 10:17:21 +02:00
..
src Improving logs (adding date) 2020-06-09 09:30:12 +02:00
tests Fix test socket 2020-05-23 16:32:14 +02:00
.dockerignore Fixing Dockerfiles 2020-04-11 15:11:22 +02:00
.eslintrc.json Create backend 2020-04-04 04:08:12 +02:00
.gitignore Add io socket message to share user position. 2020-04-04 12:42:02 +02:00
Dockerfile Triggerring CI rerun 2020-04-12 15:50:14 +02:00
jasmine.json added jasmine in the back 2020-04-06 15:48:19 +02:00
LICENSE.txt Changing license to AGPL + Commons Clause 2020-06-09 10:17:21 +02:00
package.json Changing license to AGPL + Commons Clause 2020-06-09 10:17:21 +02:00
position-test.js BIG WIP of refactoring my work in TS 2020-04-07 10:08:04 +02:00
README.md Fix typo 2020-04-04 23:29:36 +02:00
server.ts Create backend 2020-04-04 04:08:12 +02:00
tsconfig.json Stricter compiler 2020-05-16 16:11:58 +02:00
yarn.lock Tracking nb users connected and server load 2020-05-28 22:00:56 +02:00

README.md

Back Features

Login

To start your game, you must authenticate on the server back. When you are authenticated, the back server return token and room starting.

POST => /login 
Params : 
    email: email of user.

Join a room

When a user is connected, the user can join a room. So you must send emit join-room with information user:

Socket.io => 'join-room'

    userId: user id of gamer
    roomId: room id when user enter in game
    position: {
        x: position x on map
        y: position y on map
    }

All data users are stocked on socket client.

Send position user

When user move on the map, you can share new position on back with event user-position. The information sent:

Socket.io => 'user-position'

    userId: user id of gamer
    roomId: room id when user enter in game
    position: {
        x: position x on map
        y: position y on map
    }

All data users are updated on socket client.

Receive positions of all users

The application sends position of all users in each room in every few 10 milliseconds. The data will pushed on event user-position:

Socket.io => 'user-position'

    [
        {
            userId: user id of gamer
            roomId: room id when user enter in game
            position: {
                x: position x on map
                y: position y on map
            }
        },
        ...
    ]

<<< back