Skip to content

A specification for Housing Actions with Typescript Support & JSON Schemas.

License

Notifications You must be signed in to change notification settings

housingdevs/housing-actions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Housetils Logo

housing-actions

A specification for Hypixel Housing actions!


Housing Actions is a specification for the Hypixel Housing action coding system. We aim to make our standard easy to use, accessible & readable. Any app can implement this specification, and it'll work with other apps too!

Warning

A lot of features listed here are not yet implemented & the spec is likely to change often. Not recommended for use in production.

Roadmap

  • Actions implemented
  • Event Actions implemented
  • Action Holders implemented
  • Example implementations
  • Documentation

Example

This is what a Conditional would look like that sends a message when you have 5 kills.

[
    {
        "type":"CONDITIONAL", 
        "conditions": [
            {
                "type":"PLAYER_STAT",
                "stat":"Kills",
                "mode":"EQUAL",
                "amount": 5
            }
        ],
        "match_any_condition": false,
        "if_actions": [
            {
                "type":"SEND_MESSAGE",
                "message":"Hello!"
            }
        ],
        "else_actions": [] 
   }
]

Questions

  • How do I implement certain systems like functions? It just says null!
    • At this time, there is no standard for it. We recommend that developers make it the name of the item and make it select the first occurence of it in the list.
  • Where was this format derived?
    • The format was taken from decrypted NBT tags on Item Actions, we've worked up from there and changed some things for the best consistency possible.

About

A specification for Housing Actions with Typescript Support & JSON Schemas.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •