Listing information
Welcome to the Blocklet Development Guide. This document is designed to provide all developers with a complete list of steps to develop blocklets, helping you pass the blocklet review smoothly.
Title#
Provide a title for your blocklet in blocklet.yml
or Blocklet Studio. The requirements are as follows:
- Language: English (preferred)
- Length: No more than 40 characters; try to stay within one line and avoid line breaks. If it is in other languages such as Chinese, Japanese, or Korean, no more than 20 characters (English is preferred);
- Content: Be concise and specific. Your content can be combined with application functions, homophones, visual names, innovative nouns, etc;
Logo#
See details at Providing Image.
Description#
Describe your blocklet briefly in blocklet.yml
or Blocklet Studio. The requirements are as follows:
- Language: English or Chinese;
- Length: no more than 160 characters, and if it is in other languages such as Chinese, Japanese, or Korean, no more than 80 characters (English is preferred);
- Content: Provide additional explanations or descriptions of keywords in the title, focusing on the description of core functions.
Screenshot#
See details at Providing Image.
Details#
Provide a detailed introduction to your blocklet in blocklet.md
; Focus on introducing the type of application you are building (entertainment, learning, store, tools, etc.), usage scenarios, purposes, methods, etc. For example, if you create a game, you can briefly introduce the game rules, operation buttons, etc. (Note: English is preferred). If you are creating a game in as second language such as Chinese, you must include an introduction in Chinese and English.
Installation and Running#
No complex configuration is required; it can be started and run normally.
Other Instructions#
You can include any optional links related to your blocklet. For example:
- Add a homepage address: To provide a more detailed explanation of how your Blocklet works; you can give a direct link to the Blocklet website by setting the homepage field in
blocklet.yml
or Blocklet Studio; - Provide support address: The Blocklet Store provides a built-in user support experience under the "Support" tab of Blocklets, but you can use a dedicated support website by including a link in the community field of
blocklet.yml
or Blocklet Studio; - Provide source code address: If your Blocklet is open-source, you can set the repository field in
blocklet.yml
or Blocklet Studio; to the actual repository address.