Lisäosan luominen

Tällä sivulla kuvataan perusteet lisäosan luomisesta Scratch-lisäosiin. Ennen kuin etenet, lue lisäosien perusteista ja poista käytöstä kaikki Scratch-lisäosien ilmentymät, jotta vältytään ristiriidoilta.

Vaatimukset

Scratch-lisäosat ei vaadi kehittämiseen mitään ohjelmistoa, paitsi tekstieditorin ja Chromium-pohjaisen selaimen (121+), mutta on suositeltavaa, että asennat myös Gitin, Firefoxin (121+) ja Visual Studio Coden.

Asennus

Asenna laajennus kehitystä varten Asennus lähdekoodista -sivun ohjeiden mukaan.

Lisäosakansion luominen

Jokaisella lisäosalla on oma sisäinen nimitunnisteensa, jota käyttävät laajennus ja muut lisäosat.

Lisäosien ei pidä käyttää nimitunnistetta, joka on ollut käytössä vakaassa versiossa, mutta sittemmin poistettu. Niitä ovat:

• a11y
• data-category-tweaks
• featured-dangos
• fix-buttons
• forum-time-zones
• image-uploader
• redirect-mobile-forums
• scratchstats
• tutorials-button

Avaa addons.json-tiedosto addons-kansiossa, lisää uuden lisäosan nimitunniste tiedoston alaosan lähelle ja luo sitten samanniminen alakansio.

Lisäosan manifest-tiedosto

Jokaisella lisäosalla on oma manifest-tiedostonsa, johon on kirjattu, miten lisäosa näytetään asetussivulla, kaikki lisäosan asetukset sekä suoritettavat käyttäjäskriptit tai -tyylit ja sivu, jolla ne suoritetaan.

Jokaisen lisäosan manifest-tiedoston nimi on addon.json, ja tiedosto sijaitsee lisäosan kansiossa. Tässä on tiivistetty lisäosan manifest-tiedosto:

{
  "name": "My addon",
  "description": "TODO",
  "tags": ["community"]
}

Lisätietoja tiedoista, jotka voidaan määrittää manifest-tiedostossa, löytyy lisäosien manifest-tiedoston referenssistä.

Lisäosa ei tee vielä mitään, mutta se näkyy ponnahdusikkunassa ja asetussivulla laajennuksen päivittämisen jälkeen.

Käyttäjäskriptit ja käyttäjätyylit

Käyttäjäskriptit ja käyttäjätyylit saavat lisäosan toimimaan. Käyttäjäskriptit ajavat JavaScript-koodia ja käyttäjätyylit lisäävät CSS-tyylejä. Lisäosat voivat olla käyttäjätyylien ja -skriptien yhdistelmiä.

Käyttäjäskripteillä on pääsy addon-rajapintoihin, joiden avulla ne voivat suorittaa tiettyjä Scratchiin liittyviä tehtäviä helpommin, kuten hakea tällä hetkellä sisäänkirjautuneen käyttäjän.

Kun käyttäjäskripti tai -tyyli lisätään lisäosan kansioon, se täytyy ilmoittaa lisäosan manifest-tiedostossa. Muuten sitä ei suoriteta.

Lisäosan asetukset

Manifest-tiedoston settings-olion avulla lisäosalle voidaan lisätä asetuksia, kuten kytkimiä, tekstikenttiä tai värinvalitsimia, jotta käyttäjät voivat mukauttaa sitä asetussivulla.

Lue addon.settings-rajapinnan oppaasta, kuinka käyttäjäskripteistä ja -tyyleistä päästään käsiksi käyttäjän valintoihin.

Ennen osallistumista

Jos haluat lähettää lisäosasi Scratch-lisäosien GitHub-tietosäilöön, jotta se voitaisiin lisätä lisäosakirjastoon, varmista, että se toimii odotetusti muiden lisäosien kanssa ja yksinään eikä se riko muita lisäosia. Lisäosan manifest-tiedostossa on oltava hyvä nimi ja kuvaus, versionAdded-kohdassa pitäisi olla laajennuksen seuraava versio ja lisäosan ei pidä olla oletuksena käytössä. Lisäosien tulisi tukea dynaamista käyttöönottoa ja käytöstäpoistoa, mutta sitä ei vaadita. Varmista, että koodi on ymmärrettävää: turhat kommentit ovat parempia kuin koodi ilman kommentteja.

Vetopyynnön lähettäminen

Noudata osallistujien toimintaohjeissa kerrottuja vaiheita. Yksinkertaisesti sanottuna haarauta tietosäilö, jos et sitä vielä ole tehnyt, varastoi uusi lisäosasi ja lähetä vetopyyntö.

Jos lisäosasi ei ole valmis tai tarvitset jossakin apua, luo luonnosvetopyyntö.

Muista, että sinua saatetaan pyytää tekemään joitain muutoksia ja tarkastusvaihe saattaa olla hidas. Luultavasti lisäosasi kuitenkin hyväksytään, jos se täyttää vähimmäisvaatimukset.