partey_workadventure/docs/dev
David Négrier 6540f15c5b
Refactoring Woka management (#1810)
* Wrap websockets with HyperExpress

* Add endpoints on pusher to resolve wokas

* getting textures urls from pusher

* Adding OpenAPI documentation for the pusher.

The pusher now exposes a "/openapi" endpoint and a "/swagger-ui/" endpoint.

* revert FRONT_URL

* playerTextures metadata is being loaded via Phaser.Loader

* fetch textures every time character or customize scene is open

* Heavy changes: refactoring the pusher to always send the textures (and the front to accept them)

* Sending character layer details to admin

* Cleaning commented code

* Fixing regex

* Fix woka endpoints on pusher

* Change error wording on pusher

* Working on integration of the woka-list with the new admin endpoint.

* Switching from "name" to "id" in texture object + using zod for woka/list validation

* Add position on default woka data

* Remove async on pusher option method

* Fix woka list url

* add options for /register

* Fxiing loading the Woka list

* Actually returning something in logout-callback

* Copying messages to back too

* remove customize button if no body parts are available (#1952)

* remove customize button if no body parts are available

* remove unused position field from PlayerTexturesCollection interface

* removed unused label field

* fix LocalUser test

* little PlayerTextures class refactor

* Fixing linting

* Fixing missing Openapi packages in prod

* Fixing back build

Co-authored-by: Hanusiak Piotr <piotr@ltmp.co>
Co-authored-by: David Négrier <d.negrier@thecodingmachine.com>

* Add returns on pusher endpoints

Co-authored-by: Alexis Faizeau <a.faizeau@workadventu.re>
Co-authored-by: Hanusiak Piotr <piotr@ltmp.co>
Co-authored-by: Piotr Hanusiak <wacneg@gmail.com>
2022-03-11 17:02:58 +01:00
..
images Developer documentation regarding scripting API 2021-12-09 12:13:16 +01:00
contributing-to-scripting-api.md Developer documentation regarding scripting API 2021-12-09 12:13:16 +01:00
how-to-translate.md Implement typesafe-i18n 2022-01-24 18:59:28 +01:00
README.md Refactoring Woka management (#1810) 2022-03-11 17:02:58 +01:00
wokas.md Refactoring Woka management (#1810) 2022-03-11 17:02:58 +01:00

Developer documentation

This (work in progress) documentation provides a number of "how-to" guides explaining how to work on the WorkAdventure code.

This documentation is targeted at developers looking to open Pull Requests on WorkAdventure.

If you "only" want to design dynamic maps, please refer instead to the scripting API documentation.

Contributing

Check out the contributing guide

Front documentation

Pusher documentation

The Pusher is exposing its HTTP API as "OpenAPI" endpoint. You can browse this API at http://pusher.workadventure.localhost/swagger-ui/.