Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Augmentile
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Auglement
Augmentile
Commits
6d666b17
Verified
Commit
6d666b17
authored
4 years ago
by
Nik | Klampfradler
Browse files
Options
Downloads
Patches
Plain Diff
Add note about external content URLs to readme
parent
541838b0
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#7317
passed
4 years ago
Stage: test
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+25
-0
25 additions, 0 deletions
README.md
with
25 additions
and
0 deletions
README.md
+
25
−
0
View file @
6d666b17
...
...
@@ -52,6 +52,8 @@ have been made to the map concepts.
the Work Adventure client API, the
[
Matrix Widget API
](
https://github.com/matrix-org/matrix-widget-api
)
is available to scripts
*
**Resources**
: Resources like images, tilesets, and media can be
referenced using
`mxc://`
URLs
## Managing game and maps in a room
...
...
@@ -99,6 +101,29 @@ Care should be taken when referencing such maps from other maps in the room, or
using such maps as starting map in the widget. Users could abuse this possibility
to add inappropriate content or even scripts that introduce security risks.
#### Referencing URLs to maps
Instead of loading the entire map JSON into the room state, maps can be referenced
as URLs.
To link an external map to a map name, simply put a JSON object containing
only the key
`url`
:
```
sh
curl
\
-X
PUT
\
-H
"Authorization: Bearer AccessToken"
\
-H
"Content-Type: application/json"
\
-d
"{'url': 'https://example.com/mymap.json'}
\
https://matrix.org/_matrix/client/r0/rooms/%21roomid%3Amatrix.org/state/team.auglement.augmentile.map/mymap
```
URLs can also be used everywhere else where maps are referenced, e.g. in
`exitUrl`
in other
maps or in URL parameters of Aug
\[
m
\]
entile.
Apart from regular
`https://`
URLs,
`mxc://`
URLs are also allowed to reference files uploaded
as media to Matrix.
### Adding the game as room widget
Using the Element client, the widget can be added with the
`/addwidget`
command.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment