Xatframe

From xat wiki
Revision as of 02:00, 2 June 2020 by Daniel (talk | contribs) (Removed examples as it'll go out of date quickly, will replace with a pic of gallery later probably & removing xatframe/library link)

To further customize the outer background of your chat, you can provide a link to an HTML document that will be embedded via iframe (known as a "xatframe") behind your chat. Within the embedded page, you can use any combination of HTML/CSS/JavaScript that you like including animations, generated content, etc.

This replaces the custom CSS styling that is currently used to customize chats, which no longer works on the new website.

Adding a xatframe to your chat

To do this, hover over "group" at the top right and click "customize" and enter your chat password. On the "appearance" tab, you will see a box labelled "xatframe". Put the link to the page you want to embed behind your chat.

You must also use an outer background when using a xatframe so that there is a fallback if users have xatframes disabled.

Setting up a xatframe

If you want to create your own embedded webpage, you will first need to have somewhere to host your webpage. For this, we recommend you use github.io as it is easy to set up and is already pre-unblocked. If you wish to use your own domain, you will need to have it unblocked by making a ticket.

For more information on setting up GitHub pages, you can visit their website.

xatframe rules

You must ensure the xatframe you use complies with the rules below, even if taken from a third party.

Note: xat reserves the right to change these rules without notice.

IMPORTANT: Failure to follow these rules may result in your chat group being deleted or permanently delisted and having all of its media removed. xat may also apply a block to your account, depending on the offence.

  • Must be suitable for viewing by all ages.
  • No IP trackers or content that can be used to track IP addresses.
  • Do not store any cookies etc. without permission.
  • No chats to be embedded in iframe.
  • Do not use animations that may be intrusive to the chatting experience.
  • Flashing images should not be used.
  • Do not use malicious code of any kind (e.g. with mouse clicks or key presses).
  • No commercial adverts or content of that nature.