# workadventure

**Repository Path**: mirrors_thecodingmachine/workadventure

## Basic Information

- **Project Name**: workadventure
- **Description**: A collaborative web application (virtual office) presented as a 16-bit RPG video game
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-01-05
- **Last Updated**: 2026-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](https://github.com/thecodingmachine/workadventure/workflows/Continuous%20Integration/badge.svg) [![Discord](https://img.shields.io/discord/821338762134290432?label=Discord)](https://discord.gg/G6Xh9ZM9aR) ![Awesome](https://awesome.re/badge.svg)

![WorkAdventure office image](README-MAP.png)

# WorkAdventure


WorkAdventure is a platform that allows you to design **fully customizable collaborative virtual worlds** (metaverse). 

With your own avatar, you can **interact spontaneously** with your colleagues, clients, partners (using a **video-chat system**, triggered when you approach someone).
Imagine **all types of immersive experiences** (recruitments, onboarding, trainings, digital workplace, internal/external events) on desktop, mobile or tablet.

_The little plus? The platform is **GDPR** and **open source**!_

**See more features for your [virtual office](https://workadventu.re/virtual-offices/virtual-meetings/?utm_source=github)!**

**Pricing for our [SaaS version](https://workadventu.re/pricing/?utm_source=github)!**


[![Workadventure live demo example](https://workadventu.re/wp-content/uploads/2024/02/Button-Live-Demo.png)](https://play.staging.workadventu.re/@/tcm/workadventure/wa-village/?utm_source=github)
[![Workadventure Website](https://workadventu.re/wp-content/uploads/2024/02/Button-Website.png)](https://workadventu.re/?utm_source=github)


###### Support our team!
[![Discord Logo](https://workadventu.re/wp-content/uploads/2024/02/Icon-Discord.png)](https://discord.com/invite/G6Xh9ZM9aR)
[![X Social Logo](https://workadventu.re/wp-content/uploads/2024/02/Icon-X.png)](https://twitter.com/Workadventure_)
[![LinkedIn Logo](https://workadventu.re/wp-content/uploads/2024/02/Icon-LinkedIn.png)](https://www.linkedin.com/company/workadventu-re/)


![Stats repo](https://github-readme-stats.vercel.app/api?username={username}&theme=transparent)



## Contributors

Thanks to everyone who contributes to WorkAdventure!

<!-- contributors:start -->
<a href="https://github.com/moufmouf"><img src="https://avatars.githubusercontent.com/u/1290952?v=4&amp;s=48" width="48" height="48" alt="moufmouf"></a> <a href="https://github.com/gparant"><img src="https://avatars.githubusercontent.com/u/23724509?v=4&amp;s=48" width="48" height="48" alt="gparant"></a> <a href="https://github.com/Waclaw-I"><img src="https://avatars.githubusercontent.com/u/14911927?v=4&amp;s=48" width="48" height="48" alt="Waclaw-I"></a> <a href="https://github.com/Kharhamel"><img src="https://avatars.githubusercontent.com/u/10496706?v=4&amp;s=48" width="48" height="48" alt="Kharhamel"></a> <a href="https://github.com/nolway"><img src="https://avatars.githubusercontent.com/u/3711182?v=4&amp;s=48" width="48" height="48" alt="nolway"></a> <a href="https://github.com/matthintosh"><img src="https://avatars.githubusercontent.com/u/6673744?v=4&amp;s=48" width="48" height="48" alt="matthintosh"></a> <a href="https://github.com/Maison-hub"><img src="https://avatars.githubusercontent.com/u/73071779?v=4&amp;s=48" width="48" height="48" alt="Maison-hub"></a> <a href="https://github.com/alexarts74"><img src="https://avatars.githubusercontent.com/u/117470490?v=4&amp;s=48" width="48" height="48" alt="alexarts74"></a> <a href="https://github.com/angerenage"><img src="https://avatars.githubusercontent.com/u/37471613?v=4&amp;s=48" width="48" height="48" alt="angerenage"></a> <a href="https://github.com/cesar-cardinale"><img src="https://avatars.githubusercontent.com/u/37698963?v=4&amp;s=48" width="48" height="48" alt="cesar-cardinale"></a>
<a href="https://github.com/HugoAverty"><img src="https://avatars.githubusercontent.com/u/1681508?v=4&amp;s=48" width="48" height="48" alt="HugoAverty"></a> <a href="https://github.com/lukashass"><img src="https://avatars.githubusercontent.com/u/32853499?v=4&amp;s=48" width="48" height="48" alt="lukashass"></a> <a href="https://github.com/jadekeina"><img src="https://avatars.githubusercontent.com/u/127255892?v=4&amp;s=48" width="48" height="48" alt="jadekeina"></a> <a href="https://github.com/Lurkars"><img src="https://avatars.githubusercontent.com/u/2760570?v=4&amp;s=48" width="48" height="48" alt="Lurkars"></a> <a href="https://github.com/apps/dependabot"><img src="https://avatars.githubusercontent.com/in/29110?v=4&amp;s=48" width="48" height="48" alt="dependabot[bot]"></a> <a href="https://github.com/HimeShaman"><img src="https://avatars.githubusercontent.com/u/37311765?v=4&amp;s=48" width="48" height="48" alt="HimeShaman"></a> <a href="https://github.com/npeguin"><img src="https://avatars.githubusercontent.com/u/2227721?v=4&amp;s=48" width="48" height="48" alt="npeguin"></a> <a href="https://github.com/Powopaf"><img src="https://avatars.githubusercontent.com/u/123662077?v=4&amp;s=48" width="48" height="48" alt="Powopaf"></a> <a href="https://github.com/pizkaz"><img src="https://avatars.githubusercontent.com/u/78648379?v=4&amp;s=48" width="48" height="48" alt="pizkaz"></a> <a href="https://github.com/jonnytest1"><img src="https://avatars.githubusercontent.com/u/13507796?v=4&amp;s=48" width="48" height="48" alt="jonnytest1"></a>
<a href="https://github.com/tabascoeye"><img src="https://avatars.githubusercontent.com/u/111893?v=4&amp;s=48" width="48" height="48" alt="tabascoeye"></a> <a href="https://github.com/anbraten"><img src="https://avatars.githubusercontent.com/u/6918444?v=4&amp;s=48" width="48" height="48" alt="anbraten"></a> <a href="https://github.com/ValdoTR"><img src="https://avatars.githubusercontent.com/u/14997703?v=4&amp;s=48" width="48" height="48" alt="ValdoTR"></a> <a href="https://github.com/apps/copilot-swe-agent"><img src="https://avatars.githubusercontent.com/in/1143301?v=4&amp;s=48" width="48" height="48" alt="Copilot"></a> <a href="https://github.com/taksan"><img src="https://avatars.githubusercontent.com/u/96873?v=4&amp;s=48" width="48" height="48" alt="taksan"></a> <a href="https://github.com/EvaVillarroya"><img src="https://avatars.githubusercontent.com/u/95913483?v=4&amp;s=48" width="48" height="48" alt="EvaVillarroya"></a> <a href="https://github.com/Arata1202"><img src="https://avatars.githubusercontent.com/u/142312848?v=4&amp;s=48" width="48" height="48" alt="Arata1202"></a> <a href="https://github.com/albanbruder"><img src="https://avatars.githubusercontent.com/u/36596731?v=4&amp;s=48" width="48" height="48" alt="albanbruder"></a> <a href="https://github.com/klauserber"><img src="https://avatars.githubusercontent.com/u/9998995?v=4&amp;s=48" width="48" height="48" alt="klauserber"></a> <a href="https://github.com/Informatic"><img src="https://avatars.githubusercontent.com/u/1131102?v=4&amp;s=48" width="48" height="48" alt="Informatic"></a>
<a href="https://github.com/Lithimlin"><img src="https://avatars.githubusercontent.com/u/25646100?v=4&amp;s=48" width="48" height="48" alt="Lithimlin"></a> <a href="https://github.com/mktn87"><img src="https://avatars.githubusercontent.com/u/5143373?v=4&amp;s=48" width="48" height="48" alt="mktn87"></a> <a href="https://github.com/MaximilianoVeiga"><img src="https://avatars.githubusercontent.com/u/53234944?v=4&amp;s=48" width="48" height="48" alt="MaximilianoVeiga"></a> <a href="https://github.com/nguyenk"><img src="https://avatars.githubusercontent.com/u/2227554?v=4&amp;s=48" width="48" height="48" alt="nguyenk"></a> <a href="https://github.com/bestian"><img src="https://avatars.githubusercontent.com/u/109048?v=4&amp;s=48" width="48" height="48" alt="bestian"></a> <a href="https://github.com/RaimeXLP"><img src="https://avatars.githubusercontent.com/u/41763410?v=4&amp;s=48" width="48" height="48" alt="RaimeXLP"></a> <a href="https://github.com/fcecagno"><img src="https://avatars.githubusercontent.com/u/502164?v=4&amp;s=48" width="48" height="48" alt="fcecagno"></a> <a href="https://github.com/ercanucan"><img src="https://avatars.githubusercontent.com/u/7704593?v=4&amp;s=48" width="48" height="48" alt="ercanucan"></a> <a href="https://github.com/psy"><img src="https://avatars.githubusercontent.com/u/1132707?v=4&amp;s=48" width="48" height="48" alt="psy"></a> <a href="https://github.com/mvanhorn"><img src="https://avatars.githubusercontent.com/u/455140?v=4&amp;s=48" width="48" height="48" alt="mvanhorn"></a>
<a href="https://github.com/ZacharyJia"><img src="https://avatars.githubusercontent.com/u/7402471?v=4&amp;s=48" width="48" height="48" alt="ZacharyJia"></a> <a href="https://github.com/fvztdk"><img src="https://avatars.githubusercontent.com/u/1136222?v=4&amp;s=48" width="48" height="48" alt="fvztdk"></a> <a href="https://github.com/0xr2po"><img src="https://avatars.githubusercontent.com/u/117746006?v=4&amp;s=48" width="48" height="48" alt="0xr2po"></a> <a href="https://github.com/ThomasPerez91"><img src="https://avatars.githubusercontent.com/u/92369255?v=4&amp;s=48" width="48" height="48" alt="ThomasPerez91"></a> <a href="https://github.com/Pix3lqu4ntum"><img src="https://avatars.githubusercontent.com/u/101702705?v=4&amp;s=48" width="48" height="48" alt="Pix3lqu4ntum"></a> <a href="https://github.com/MisterErwin"><img src="https://avatars.githubusercontent.com/u/1916723?v=4&amp;s=48" width="48" height="48" alt="MisterErwin"></a> <a href="https://github.com/klinshy"><img src="https://avatars.githubusercontent.com/u/79143155?v=4&amp;s=48" width="48" height="48" alt="klinshy"></a> <a href="https://github.com/joberthel"><img src="https://avatars.githubusercontent.com/u/34104366?v=4&amp;s=48" width="48" height="48" alt="joberthel"></a> <a href="https://github.com/fetsorn"><img src="https://avatars.githubusercontent.com/u/12858105?v=4&amp;s=48" width="48" height="48" alt="fetsorn"></a> <a href="https://github.com/LindezaGrey"><img src="https://avatars.githubusercontent.com/u/39629455?v=4&amp;s=48" width="48" height="48" alt="LindezaGrey"></a>
<a href="https://github.com/Eyramds"><img src="https://avatars.githubusercontent.com/u/51328648?v=4&amp;s=48" width="48" height="48" alt="Eyramds"></a> <a href="https://github.com/wpramio"><img src="https://avatars.githubusercontent.com/u/58149308?v=4&amp;s=48" width="48" height="48" alt="wpramio"></a> <a href="https://github.com/Palid"><img src="https://avatars.githubusercontent.com/u/3636685?v=4&amp;s=48" width="48" height="48" alt="Palid"></a> <a href="https://github.com/beingeek"><img src="https://avatars.githubusercontent.com/u/25414115?v=4&amp;s=48" width="48" height="48" alt="beingeek"></a> <a href="https://github.com/mo8it"><img src="https://avatars.githubusercontent.com/u/76752051?v=4&amp;s=48" width="48" height="48" alt="mo8it"></a> <a href="https://github.com/Harikesh04"><img src="https://avatars.githubusercontent.com/u/91447902?v=4&amp;s=48" width="48" height="48" alt="Harikesh04"></a> <a href="https://github.com/cbluoss"><img src="https://avatars.githubusercontent.com/u/7562705?v=4&amp;s=48" width="48" height="48" alt="cbluoss"></a> <a href="https://github.com/Moini"><img src="https://avatars.githubusercontent.com/u/3240233?v=4&amp;s=48" width="48" height="48" alt="Moini"></a> <a href="https://github.com/restray"><img src="https://avatars.githubusercontent.com/u/27992458?v=4&amp;s=48" width="48" height="48" alt="restray"></a> <a href="https://github.com/oliverlorenz"><img src="https://avatars.githubusercontent.com/u/403147?v=4&amp;s=48" width="48" height="48" alt="oliverlorenz"></a>
<a href="https://github.com/ozraru"><img src="https://avatars.githubusercontent.com/u/34647405?v=4&amp;s=48" width="48" height="48" alt="ozraru"></a> <a href="https://github.com/x0rp01s0n"><img src="https://avatars.githubusercontent.com/u/43322985?v=4&amp;s=48" width="48" height="48" alt="x0rp01s0n"></a> <a href="https://github.com/lbehm"><img src="https://avatars.githubusercontent.com/u/421093?v=4&amp;s=48" width="48" height="48" alt="lbehm"></a> <a href="https://github.com/malteriechmann"><img src="https://avatars.githubusercontent.com/u/656568?v=4&amp;s=48" width="48" height="48" alt="malteriechmann"></a> <a href="https://github.com/Wikinaut"><img src="https://avatars.githubusercontent.com/u/1151915?v=4&amp;s=48" width="48" height="48" alt="Wikinaut"></a> <a href="https://github.com/kaeff"><img src="https://avatars.githubusercontent.com/u/344781?v=4&amp;s=48" width="48" height="48" alt="kaeff"></a> <a href="https://github.com/piitaya"><img src="https://avatars.githubusercontent.com/u/5878303?v=4&amp;s=48" width="48" height="48" alt="piitaya"></a> <a href="https://github.com/lryjnks"><img src="https://avatars.githubusercontent.com/u/33368776?v=4&amp;s=48" width="48" height="48" alt="lryjnks"></a> <a href="https://github.com/niklasarnitz"><img src="https://avatars.githubusercontent.com/u/24507162?v=4&amp;s=48" width="48" height="48" alt="niklasarnitz"></a> <a href="https://github.com/DexAsHisH"><img src="https://avatars.githubusercontent.com/u/29312117?v=4&amp;s=48" width="48" height="48" alt="DexAsHisH"></a>
<a href="https://github.com/guysoft"><img src="https://avatars.githubusercontent.com/u/325670?v=4&amp;s=48" width="48" height="48" alt="guysoft"></a> <a href="https://github.com/matzegebbe"><img src="https://avatars.githubusercontent.com/u/3482021?v=4&amp;s=48" width="48" height="48" alt="matzegebbe"></a> <a href="https://github.com/tbnobody"><img src="https://avatars.githubusercontent.com/u/1753222?v=4&amp;s=48" width="48" height="48" alt="tbnobody"></a> <a href="https://github.com/felixilgatto"><img src="https://avatars.githubusercontent.com/u/57217359?v=4&amp;s=48" width="48" height="48" alt="felixilgatto"></a> <a href="https://github.com/izeau"><img src="https://avatars.githubusercontent.com/u/838867?v=4&amp;s=48" width="48" height="48" alt="izeau"></a> <a href="https://github.com/spiccinini"><img src="https://avatars.githubusercontent.com/u/500841?v=4&amp;s=48" width="48" height="48" alt="spiccinini"></a> <a href="https://github.com/bufferoverflow"><img src="https://avatars.githubusercontent.com/u/378909?v=4&amp;s=48" width="48" height="48" alt="bufferoverflow"></a> <a href="https://github.com/campey"><img src="https://avatars.githubusercontent.com/u/1193860?v=4&amp;s=48" width="48" height="48" alt="campey"></a> <a href="https://github.com/dsavina"><img src="https://avatars.githubusercontent.com/u/22031211?v=4&amp;s=48" width="48" height="48" alt="dsavina"></a> <a href="https://github.com/emmanuel-ferdman"><img src="https://avatars.githubusercontent.com/u/35470921?v=4&amp;s=48" width="48" height="48" alt="emmanuel-ferdman"></a>
<a href="https://github.com/Floupp"><img src="https://avatars.githubusercontent.com/u/17725553?v=4&amp;s=48" width="48" height="48" alt="Floupp"></a> <a href="https://github.com/apps/github-actions"><img src="https://avatars.githubusercontent.com/in/15368?v=4&amp;s=48" width="48" height="48" alt="github-actions[bot]"></a> <a href="https://github.com/gscariott"><img src="https://avatars.githubusercontent.com/u/50051604?v=4&amp;s=48" width="48" height="48" alt="gscariott"></a> <a href="https://github.com/JH220"><img src="https://avatars.githubusercontent.com/u/50051569?v=4&amp;s=48" width="48" height="48" alt="JH220"></a> <a href="https://github.com/kidager"><img src="https://avatars.githubusercontent.com/u/3314980?v=4&amp;s=48" width="48" height="48" alt="kidager"></a> <a href="https://github.com/lotfiidir"><img src="https://avatars.githubusercontent.com/u/16717662?v=4&amp;s=48" width="48" height="48" alt="lotfiidir"></a> <a href="https://github.com/mpauly-exnaton"><img src="https://avatars.githubusercontent.com/u/99654531?v=4&amp;s=48" width="48" height="48" alt="mpauly-exnaton"></a> <a href="https://github.com/rlespinasse"><img src="https://avatars.githubusercontent.com/u/1280212?v=4&amp;s=48" width="48" height="48" alt="rlespinasse"></a> <a href="https://github.com/s00500"><img src="https://avatars.githubusercontent.com/u/1556271?v=4&amp;s=48" width="48" height="48" alt="s00500"></a> <a href="https://github.com/sharkwouter"><img src="https://avatars.githubusercontent.com/u/5042659?v=4&amp;s=48" width="48" height="48" alt="sharkwouter"></a>
<a href="https://github.com/swiesend"><img src="https://avatars.githubusercontent.com/u/3512490?v=4&amp;s=48" width="48" height="48" alt="swiesend"></a> <a href="https://github.com/ttefke"><img src="https://avatars.githubusercontent.com/u/30950329?v=4&amp;s=48" width="48" height="48" alt="ttefke"></a> <a href="https://github.com/Amirault"><img src="https://avatars.githubusercontent.com/u/8234509?v=4&amp;s=48" width="48" height="48" alt="Amirault"></a> <a href="https://github.com/BAWES"><img src="https://avatars.githubusercontent.com/u/5470101?v=4&amp;s=48" width="48" height="48" alt="BAWES"></a> <a href="https://github.com/davidprzzz"><img src="https://avatars.githubusercontent.com/u/61026412?v=4&amp;s=48" width="48" height="48" alt="davidprzzz"></a> <a href="https://github.com/dmaechler"><img src="https://avatars.githubusercontent.com/u/2805175?v=4&amp;s=48" width="48" height="48" alt="dmaechler"></a> <a href="https://github.com/kaelsky"><img src="https://avatars.githubusercontent.com/u/31901905?v=4&amp;s=48" width="48" height="48" alt="kaelsky"></a> <a href="https://github.com/Mewp"><img src="https://avatars.githubusercontent.com/u/971479?v=4&amp;s=48" width="48" height="48" alt="Mewp"></a> <a href="https://github.com/shug0"><img src="https://avatars.githubusercontent.com/u/2612496?v=4&amp;s=48" width="48" height="48" alt="shug0"></a> <a href="https://github.com/souzaramon"><img src="https://avatars.githubusercontent.com/u/25514401?v=4&amp;s=48" width="48" height="48" alt="souzaramon"></a>
<a href="https://github.com/Zilliq11"><img src="https://avatars.githubusercontent.com/u/9016031?v=4&amp;s=48" width="48" height="48" alt="Zilliq11"></a> <a href="https://github.com/heyjuvi"><img src="https://avatars.githubusercontent.com/u/4604723?v=4&amp;s=48" width="48" height="48" alt="heyjuvi"></a>
<!-- contributors:end -->
<!-- contributors:hidden:start
abestanis
chasethechicken
clementderre
clementvieilly
clementvieilly75
datalog-mindhack
evrardjp
felixdoerre
greenyolong
grl78
jozzzzzz
mlima95
mstock
nekkah-rabah
nonopotter
qlouis1
stweil
t10r
tcm-ran
wesetaca
ydiarra
znerol
zobadaniel
contributors:hidden:end -->

## Community resources

1. Want to build your own map, check out our **[map building documentation](https://docs.workadventu.re/map-building/)**
2. Check out resources developed by the WorkAdventure community at **[awesome-workadventure](https://github.com/workadventure/awesome-workadventure)**

## Setting up a production environment

We support 2 ways to set up a production environment:

- using Docker Compose
- or using a Helm chart for Kubernetes

Please check the [Setting up a production environment](docs/others/self-hosting/install.md) guide for more information.

> [!NOTE]
> WorkAdventure also provides a [hosted version](https://workadventu.re/?utm_source=github) of the application. Using the hosted version is
> the easiest way to get started and helps us to keep the project alive.

## Setting up a development environment

> [!NOTE]
> These installation instructions are for local development only. They will not work on
> remote servers as local environments do not have HTTPS certificates.

Install Docker and clone this repository.

> [!WARNING]
> If you are using Windows, make sure the End-Of-Line character is not modified by the cloning process by setting
> the `core.autocrlf` setting to false: `git config --global core.autocrlf false`

Run:

```
cp .env.template .env
docker-compose up
```

The environment will start with the OIDC mock server enabled by default.

You should now be able to browse to http://play.workadventure.localhost/ and see the application.
You can view the Traefik dashboard at http://traefik.workadventure.localhost

(Test user is "User1" and password is "pwd")

If you want to disable the OIDC mock server (for anonymous access), you can run:

```console
$ docker-compose -f docker-compose.yaml -f docker-compose-no-oidc.yaml up
```

Note: on some OSes, you will need to add this line to your `/etc/hosts` file:

**/etc/hosts**
```
127.0.0.1 oidc.workadventure.localhost redis.workadventure.localhost play.workadventure.localhost traefik.workadventure.localhost matrix.workadventure.localhost extra.workadventure.localhost icon.workadventure.localhost map-storage.workadventure.localhost uploader.workadventure.localhost maps.workadventure.localhost api.workadventure.localhost front.workadventure.localhost
```


### Troubleshooting

See our [troubleshooting guide](docs/others/troubleshooting.md).