Cloudyweb is

• CloudyPanel: administration panel for operator
• CloudyService: web service for client

Continuous Integration:

• python >= 3.4
• pip
• virtualenv/wrapper (optional)

Create a virtual python environment for the project. If you're not using virtualenv or virtualenvwrapper you may skip this step.

mkvirtualenv -p /usr/bin/python3 cloudyweb
workon cloudyweb

virtualenv -p /usr/bin/python3 cloudyweb-env
cd cloudyweb-env
source bin/activate

Obtain the url to your git repository.

git clone <URL_TO_GIT_RESPOSITORY>

Copy the __local_settings.py template as local_settings.py You are free to overwrite any existing settings.py for your local development.

The following command only works on Mac/Linux. Please do the above manually for Windows.

cp cloudyweb/{__,}local_settings.py

Navigate to the root directory of the repository using the command line on your computer (you may have to navigate folder by folder until you reach it):

cd cloudyweb

Then, type the following into your command line:

pip install -r requirements/dev.txt

python manage.py migrate

python manage.py runserver 0.0.0.0:8000

Open browser to http://127.0.0.1:8000

python manage.py test

To use CloudyWeb in the CloudyGame Project with Unreal Engine and Cloudy Launcher, some set up needs to be done. We assume that all deployment is done locally on one computer.

1. Create a robot user with administrative rights.
   • Type: python manage.py createsuperuser.
2. Add at least one game into the database.
   • Open browser to http://127.0.0.1:8000/admin, and log in with the created robot user.
   • Click on "Games", then click on "Add game" on the top right.
   • Enter the game details. For the address, enter 127.0.0.1.
3. Grant game ownership to the robot user.
   • Open browser to http://127.0.0.1:8000/admin, and log in with the created robot user.
   • Click on "Game ownerships", then click on "Add game ownership" on the top right.
   • Give the robot user game ownership for all the games you have added.
4. The database is now set up. You can proceed to use Cloudy Launcher and Unreal Engine (with the plugins).

$ curl -X POST http://127.0.0.1:8000/api-token-auth/registrations/ --data "email=john@doe.com&username=john&password=doe"
==> {"username":"john","email":"","first_name":"","last_name":""}

$ curl -X POST http://127.0.0.1:8000/api-token-auth/tokens/ --data "username=john&password=doe"
==> {"token":"7f1334b4b27202afe8ef3e078dfc849291e908b9"}

$ curl -X GET http://127.0.0.1:8000/users/ -H 'Authorization: Token abcdefghijklmnopqrstuvwxyz123456790'
==> [{"username":"john","email":"","first_name":"","last_name":""}, ...]

• Create Games
  • request method: POST
  • url: '/games/'
  • data: {'name': 'game1', 'publisher': 'pub1', 'max_limit': 4, 'address': 'http://0.0.0.0', 'description': '', 'thumbnail':''}
  • access right: operator only
• Read Games
  • request method: GET
  • url:
    • '/games/'
    • '/games/4/' where 4 is game__id
    • '/games/?owned=1' to get owned games (0 to get all)
    • '/games/?name=game4&id=1&publisher=pub1'
  • access right: available for all
  • returns {'id', 'name', 'publisher', 'max_limit', 'address', 'description', 'thumbnail'}
• Update Games
  • request method: PATCH
  • url: '/games/3/' where 3 is game__id
  • data: {} data that you want to update only, refer to create games
  • access right: operator only
• Delete Games
  • request method: DELETE
  • url: '/games/3/' where 3 is game__id
  • access right: operator only

• Add Game to "My Collection"
  • request method: POST
  • url: '/game-ownership/'
  • data: {'game': '1', 'user': 'john'} where game is game__id and user is user__name
  • access right: operator or their own
• Read Game Ownership
  • request method: GET
  • url:
    • '/game-ownership/'
    • '/game-ownership/?user=user1'
    • '/game-ownership/?game=1'
    • '/game-ownership/3/' where 3 is game-ownership__id
  • access right: operator or their own
  • returns {'id', 'user', 'game'}
• Delete Game Ownership
  • request method: DELETE
  • url: '/game-ownership/3/' where 3 is game-ownership__id
  • access right: operator or their own

• Join Game
  • request method: POST
  • url: '/game-session/'
  • data: {'user': 'user1', 'game': '1'}
  • access right: operator or their own
• Read Game Session
  • request method: GET
  • url:
    • '/game-session/'
    • '/game-session/4/' were 4 is game-session__id
    • '/game-session/?user=user1'
    • '/game-session/?game=3'
  • access right: operator or their own
  • returns {'id', 'user', 'game', 'controller', 'streaming_port'}
• Quit Game
  • request method: DELETE
  • url: '/game-session/3/'
  • access right: operator or their own

• Create or Update Save Data
  • request method: POST
  • url: '/save-data/'
  • data: {'saved_file': '', 'game': '1', 'user': 'user1'}
  • access right: operator or their own
• Read Save Data
  • request method: GET
  • url:
    • '/save-data/'
    • '/save-data/4/'
    • '/games/?game=1'
    • '/games/?user=user1'
  • access right: operator or their own
  • returns {'id', 'saved_file', 'user', 'game'}
• Delete Save Data
  • request method: DELETE
  • url: '/save-data/3/'
  • access right: operator or their own

• /users/
• '/games/'
• '/game-ownership/'
• '/game-session/'
• '/save-data/'