Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
W
walint
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
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
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
hub
walint
Commits
bb5277dc
Commit
bb5277dc
authored
3 years ago
by
stuebinm
Browse files
Options
Downloads
Patches
Plain Diff
add documentation on what lints are supported
parent
1b286eb0
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Lints.md
+53
-0
53 additions, 0 deletions
Lints.md
with
53 additions
and
0 deletions
Lints.md
0 → 100644
+
53
−
0
View file @
bb5277dc
# Currently Supported Lints
Note: Most lints (even those not related to properties) are currently defined in
`lib/Properties.hs`
.
## General Tiledmap Requirements
-
maps must have layers "start" and "floorLayer", and at least one layer wich
has as Property "exitUrl"
-
maps must be orthogonal, tile size must be 32 × 32
-
maps must not define their own scripts (unless allowed to do so in
the configuration file)
## Tilesets
-
tiles must have size 32 × 32 pixels
-
tilesets must have a property "copyright" (though there is currently
no restriction on what licenses are allowed)
-
entire tilesets should not be larger than 4096 × 4096 pixels
## Layer
In general, all properties are type checked, and unknown properties are
rejected. Properties "url" and "allowApi" are rejected.
### Jitsi
-
"jitsiRoom" must be set if any of the other jitsi-related properties
are also set
-
"jitsiRoomAdminTag" may not be set, but will be adjusted to the
assembly name tag
-
jitsi layers may not be empty
-
if not set, setting "jitsiTrigger" will be suggested
-
"jitsiUrl", "jitsiConfig", "jitsiClientConfig" may not be used
### Audio
-
audio layers may not be empty
-
"playAudio" must be set of any other audio-related properties are also
set
## Silent Areas
-
"silent" may not be set on an empty layer
### Websites
-
layers with "openWebsite" may not be empty
-
setting "openWebsiteTrigger" will be suggested
-
local links will be recognised as assets and dependency-checked
-
other website-related properties require "openWebsite" to also be set
### Exits
-
may not be set on empty layers
-
exists to maps also in the repository will be dependency-checked
### Entries
-
"startLayer" may not be set on empty layers
-
if set, "startLayer" must be set to
`true`
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