pgmdev / website Goto Github PK
View Code? Open in Web Editor NEWWebsite and documentation for PGM
Home Page: https://pgm.dev
License: Apache License 2.0
Website and documentation for PGM
Home Page: https://pgm.dev
License: Apache License 2.0
Cuboids are can be defined by:
<cuboid min="x,y,z" max="x,y,z"/>
<cuboid min="x,y,z", size="x,y,z"/>
-> (min + size = max)
<cuboid max="x,y,z", size="x,y,z"/>
-> (max - size = min)
Currently only min and max are documented.
for team scoped variables
<variable id="" var="" team="">
match if the variable of a specific team is a certain value or range
Currently there is no way to find the different permission nodes except going into the source code, a little segment covering all the default stuff would be nice!
/**
* Filter which checks if a {@link tc.oc.pgm.api.party.Party}'s score is within a supplied range.
*
* <p>Will ABSTAIN if the score module is not loaded.
*/
https://github.com/PGMDev/PGM/blob/a3992e87639f52f5d3c7ed6f5d2d9690f6c56d4f/core/src/main/java/tc/oc/pgm/filters/ScoreFilter.java
https://github.com/PGMDev/PGM/blob/a3992e87639f52f5d3c7ed6f5d2d9690f6c56d4f/core/src/main/java/tc/oc/pgm/filters/FilterParser.java#L509
Not really sure how the range is typed into XML.
Not sure how to fix or would attempt to, but https://pgm.dev/docs/reference/misc/formatting#chat-colors in dark mode doesn't correctly swap the numbers and letters above each coloured squared (right below "Chat Colors") when swapped to dark mode and makes it super hard to read
<king> is a module that despite being depreciated is still used by a large number of maps, especially KotH maps made originally for competitive use due to mapmakers copying the standardised hill XML used by maps such as Smoke and Cobalt. The control points page currently lists some info specific to the module under it's KotH defaults header, but the page makes no direct mention of what <king> actually is.
The main difference between <king> and <control-points> is simply the different default values that the points have. <king> also allows usage of </king> under score, which originally prevented kills from giving points on a KotH map but now has no function despite still existing within PGM as kills no longer give points by default.
The original documentation related to <king> can be found within these two archived pages of docs.oc.tc
Most recent archive that still lists info about <king>
Older archive that has less info but lists the purpose of </king> before it was depreciated
The chart found at https://pgm.dev/docs/reference/items/potions doesn't show all the potion effects available to mapmakers.
It should be updated to match the official Spigot list: https://helpch.at/docs/1.8.8/org/bukkit/potion/PotionEffectType.html
As seen in PGMDev/PGM#823.
<objective team="">
match if a specific team has completed or is holding the objective
Also users should get informed that <objective>
is now depricated and <completed>
or<captured>
should be used.
<completed>
<captured team="">
On the page https://pgm.dev/docs/modules/objectives/blitz/ the link to the Blitz XML is a dead link, returns a GitHub 404 as that no longer exists. (https://maps.oc.tc/Blitz/blitz-global.xml)
Document the newly added mercy
element for the score module PGMDev/PGM#601.
Great feature btw PGMDev/PGM@70c139f
Only whole numbers are valid.
is not true, you can use decimals in variables
<completed>
and <captured>
filters are not documented.
PGMDev/PGM#939
chidddy/PGM@2d4f331
http://docs.oc.tc/modules/filters#objectiveFilter
We have which is a more generic version that has any="true/false", and a team (only allowed to be set if any=false). The completed and captured filters are the versions of objective with any="true" and any="false" respectively, the first one allowing for a team to be specified.
The current documentation doesn't present them:
https://pgm.dev/docs/modules/mechanics/filters/#objective-filter
The projectiles module for the projectile feature is broken... It refers to https://pgm.dev/docs/reference/entities/entity-types
as all the entities a projectile can be but half of the names listed there don't work or have to be changed to work
e.g. Primed TNT -> TNTprimed
Ender pearl > Enderpearl
Wither Skull > Witherskull
Creeper -> ?
[this one doesn't work]
On top that no entities fired can't have nbt attached to them... oversight?
Merged in PR PGMDev/PGM#751
The Player Count Filter doesn't currently have an example, which would be helpful.
Merged in PR PGMDev/PGM#762
Looks like it uses apply ordering so the first one that passes is used.
On https://pgm.dev/docs/modules/mechanics/filters it mentions Elytra which is not supported in 1.8 minecraft, so wouldn't be supported in the current PGM. Hence should be removed.
<observing/>
is missing as the inverse of <participating/>
.
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/filters/matcher/player/ParticipatingFilter.java
<alive/>
and <dead/>
are missing as well.
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/filters/matcher/player/PlayerStateFilter.java
Examples found on issue PGMDev/PGM#744
The default recovery-rate and decay-rate for control points is defined by the incremental flag. Even if deprecated, incremental = true/false still defines the other rates.
If incremental is true, recovery rate is 1, decay rate is 0, and owned-decay-rate is also 0
If incremental is false, recovery rate and decay rate are both infinite, and owned-decay-rate is 0
Additionally, the explanations on recovery-rate and decay-rate are a bit lacking, it should say that both recovery-rate and decay-rate apply when a point is naturally going back to its current state, and one applies when the owner team is dominating (having their players on the point) while the other applies when no one is dominating (either multiple teams or no team), and that capture rules are what determine this
<rank>
Match if the player or team's rank is within the specified range.<rank>
and <score>
can also have an team attribute.
https://docs.oc.tc/modules/filters#rank_score
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/filters/parse/FilterParser.java#L539-L543
<countdown>
https://docs.oc.tc/modules/filters#countdown
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/filters/parse/FilterParser.java#L519-L527
<fill>
Fill actionsubtitle
attribute of <message>
action is called subtitle
and not text
.https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/action/ActionParser.java#L225
spread-teammates
attribute of spawn
Spawn players as far away as possible from any players, event teammates.
<holding/>
, <carrying/>
and <wearing/>
are dynamic filters.
exposed
If true an action can be triggered using /action trigger [action]
You specify an objective id and it returns true if the objective has been completed, false otherwise.
Example: <objective>blue-monument</objective>
PGMDev/PGM#671 has examples and explenations
<time overtime="1m" max-overtime="15m">12m</time>
The match will last 12 minutes, if when timelimit reaches 0 the teams are tied, a one-minute overtime starts. If the tie is broken and no team makes a comeback, the 1m ticks down. The overtime will last a maximum of 15 minutes, when approaching 15 minutes it will tick down and will end regardless.
Cores now have an option to show-progress
like destroyables, should be added to the documentation (see PGMDev/PGM#581 (comment))
The events plugin now available at https://github.com/PGMDev/Events has little documentation in it's readme, it'd be nice for pgm.dev to get a section of documentation about that XML format, and possibly setting up config files etc
A recent commit from mrcookie allows flag posts to be named these should be documented.
<after duration="" message="">
Also <after>
should not be listed as an operator but under "Mechanisms".
https://docs.oc.tc/modules/filters#countdown
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/filters/parse/FilterParser.java#L529-L537
As seen in PGMDev/PGM#810
<match-started/>
Filter if the match has started (running or finished).
<match-running/>
Filter if the match is running.
<match-finished/>
Filter if the match is over.
There is also <match-phase>
match phases are: running
, finished
, started
, starting
and idle
. Users should be informed to use the above more specific filters rather then <match-phase>
.
https://docs.oc.tc/modules/filters#matcherelements
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/filters/parse/FilterParser.java#L551-L587
(From PGMDev/PGM#502)
Sometimes searching for things can be kinda obscure, adding a search-bar that would search kewords to it would greatly help finding some hidden stuff
Back in the OCN website there was an addition that allowed players to translate the rule set so that Spanish speakers and other linguistic communities will be able to better understand the rules in their own language. We should restore this feature so that we can get back a more international audience.
Currently the score victory condition isn't mentioned in the docs
https://pgm.dev/docs/modules/objectives/scoring/#time-limit
PGMDev/PGM#542
The docs use the example: <score>[5-10]</score>
, this is incorrect, you must use <score>[5,10]</score>
, it could probably also use an example for infinity: <score>[5, oo)</score>
(5 or more)
https://github.com/PGMDev/Website/blob/master/docs/reference/items/inventory.mdx
https://pgm.dev/docs/reference/items/inventory
Item ID 31, 31:0 is labeled as a "Dead Shrub" when it is in fact the Grass item. The Dead Bush item has the ID of 32.
Very minor but it confused me for a minute so I thought I'd share. Never figured out how to sign off commits or I'd open a PR
See commit and Pablo's comments: PGMDev/PGM#581 (comment)
It would need to be clear that this is the closest it has gotten to leaking not the current state.
Clicking "Get Started" on the home page returns the following URL https://pgm.dev/docs/guides/migrate
As seen in PGMDev/PGM#809.
The <dimension>
tag detailed here is currently not implemented in PGM and may cause confusion for map makers.
See: PGMDev/PGM#640
https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/map/WorldInfoImpl.java#L34
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.