diff --git a/docs/maps.en.md b/docs/maps.en.md index 4787ff7146116b8c5ce51e850c9978db57772261..47bc86645e6ea0ea1ae62f6ced066e18a1059f26 100644 --- a/docs/maps.en.md +++ b/docs/maps.en.md @@ -92,6 +92,15 @@ that is the case, the back office will notify you and show you an appropriate error along with a short explanation — so in case your map doesn't change even after waiting and multiple reloads, please take a look there and check. +#### Automatic notification +You can also be notified automatically when there is a new linter result. +To do this, create a file named `.mapservice` in the root directory of your repo. +In this file you enter in which channel of the CCCV rocket chat the bot should write: +`{"rocket_channel" : "#<CHANNEL>"}`. The channel can also be a person, +in this case you enter `{"rocket_channel" : "@nick"}` in the file. + +Important: The account `Rocket.Cat` needs to be able to access your channel. + ### Links between maps Within your repository you can use normal, relative links — e.g. to get from one map in `main.json` to another at `garden/secret-base.json`, just enter the @@ -428,9 +437,9 @@ Your map repository should then look something like this: ## Testing -We will offer a test instance whose behaviour should be as close as possible to +A test instance whose behaviour should be as close as possible to the "real" infrastructure used during the event so you can test your map -beforehand. It is currently still a work in progress and should go live soon. +beforehand is available under [wa.tabascoeye.de](https://wa.tabascoeye.de). ## Self-Hosting diff --git a/docs/maps.md b/docs/maps.md index 935d7d4d7cdf89b6e7529cd47a5150cc21ddc5e0..6be41a3c21bce699e91160818a6791e5b0d5923b 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -100,6 +100,16 @@ einfach im falschen Format ist. In diesem Fall wird euch das im Maschinenraum angezeigt und entsprechend begründet — falls sich eure Karte also auch nach mehrmaligem Neuladen nicht verändert hat, schaut bitte einmal dort nach. +#### Automatische Benachrichtigung +Ihr könnt euch auch automatisch benachrichtigen lassen, wenn es ein neues Linter-Ergebnis gibt. +Dazu legt ihr im Hauptverzeichnis eures Repos eine Datei namens `.mapservice` an. In dieser +tragt ihr dann ein, in welchen Channel des CCCV-Rocketchats der Bot schreiben soll: +`{"rocket_channel" : "#<CHANNEL>"}`. Der Channel kann dabei auch eine Person sein, dann +tragt ihr `{"rocket_channel" : "@nick"}` in die Datei ein. + +Wichtig: Der Account `Rocket.Cat` muss auf euren Channel zugreifen können. + + ### Links zwischen einzelnen Karten Innerhalb eures Repositories könnt ihr ganz normale relative Links benutzen — @@ -459,8 +469,8 @@ Hier ein Beispiel wie ein Verzeichnis mit Karten exemplarisch aussehen könnte: ## Testen Eine Testinstanz, auf der ihr eure Maps direkt testen könnt und die sich (soweit -möglich und sinnvoll) wie die "echte" Instanz für das Event verhält, ist aktuell -noch in Arbeit und kommt in Kürze. +möglich und sinnvoll) wie die "echte" Instanz für das Event verhält, ist unter [wa.tabascoeye.de](https://wa.tabascoeye.de) +zu finden. ## Eigene Instanzen Wir werden sämtliche Instanzen für die rC3.world betreiben, versucht bitte nicht,