Overzicht
Een pet is een geanimeerde sprite, een klein personage dat beweegt doordat afbeeldingen snel achter elkaar worden afgespeeld. Wanneer je er een indient, kan die worden uitgelicht in de community Pets-galerij, zodat iedereen hem kan gebruiken en ervan kan genieten.
Er zijn twee manieren om een pet in te dienen. De snelste is via Petdex: je plakt één URL en je bent klaar. De andere is via GitHub, voor sprites die je zelf host als spritesheet en sprite.json. Je kunt een bestaande Petdex-pet indienen of een originele pet van jezelf maken.
Beide methoden zitten in de PicoPixel-app, dus je moet eerst ingelogd zijn.
Voordat je begint
Alles gebeurt in de PicoPixel-app. Zo kom je bij het indieningsscherm:
- Open de app op app.picopixel.io.
- Log in als je dat nog niet bent; dat kan met Google of GitHub. Als je dit overslaat, word je gevraagd in te loggen voordat je kunt indienen.
- Klik op je account onderaan de linkerzijbalk.
- Kies "Your account".
- Open "Submit Sprite".
Het Submit Sprite-scherm biedt de twee methoden die hieronder worden beschreven.
Je moet ingelogd zijn om iets in te dienen. Als je niet bent aangemeld, vraagt de app je dat te doen voordat je verder kunt.
Indienen via Petdex
Dit is de aanbevolen en snelste methode. Petdex is een externe petdirectory op petdex.crafter.run waar je pets kunt bekijken, maken en hosten. Elke pet daar heeft een deelbare URL met de vorm https://petdex.crafter.run/pets/<pet-id>.
Zo dien je in:
- Zoek of maak de pet op Petdex en kopieer de URL.
- Kies op het Submit Sprite-scherm "Submit via Petdex".
- Plak de pet-URL in het veld "Petdex URL".
- Voeg eventueel een toelichting toe in het veld "Notes".
- Verzend het.
Indienen via Petdex is de snelste route; het heeft niet voor niets de labels RECOMMENDED en FASTEST. Eén URL is alles wat je nodig hebt.
Indienen via GitHub
Gebruik deze methode wanneer je de sprite zelf host. Je levert de ruwe bestanden aan in plaats van een Petdex-link.
- Zet je spritesheet-afbeelding en een bijpassende
sprite.jsonin een openbare GitHub-repository. - Kies op het Submit Sprite-scherm "Submit via GitHub".
- Plak de repository-URL (
https://github.com/...). - Vul "Credits / Author" in zodat je werk wordt toegeschreven.
- Voeg eventueel een toelichting toe in het veld "Notes" en verzend daarna.
De spritesheet en sprite.json moeten een specifiek formaat volgen. Hieronder lees je hoe dat formaat is opgebouwd.
Je eigen unieke pet maken
In plaats van een uitgelichte Petdex-pet opnieuw te gebruiken, kun je een originele maken. AI-tools zoals OpenAI Codex of AI-afbeeldingsgeneratoren zijn een praktische manier om vanaf nul een spritesheet voor een personage te maken.
Een spritesheet is één afbeelding (PNG of WebP) met een regelmatig raster, ook wel een atlas genoemd. Plaats één animatie per rij en maak elk frame precies even groot.
Elk frame moet precies dezelfde breedte en hoogte hebben. Als de rastercellen niet overeenkomen, worden de frames verkeerd uitgesneden en kan de animatie verspringen.
Het bestand sprite.json beschrijft de spritesheet. Het heeft twee hoofdonderdelen:
- atlas, de rasterindeling:
columns,rows,frameWidthenframeHeight. - states, de lijst met animatietoestanden. Elke toestand heeft een
id, eenlabel, derowwaarop hij staat, het aantalframes, een optioneledurationMs, eengroupen eencaption.
Veelgebruikte toestanden zijn idle, wave, jump, run-right, run-left, running, waiting, failed en review. Een sprite heeft minstens twee toestanden nodig, dus maak in elk geval idle plus één beweging.
Een goede workflow: genereer de frames op een consistente grootte, plaats ze in een regelmatig raster met één animatie per rij, beschrijf daarna het raster en de animatietoestanden in sprite.json en dien in via Petdex of GitHub.
Het concept van sprites, toestanden, fases en hergebruik wordt uitgebreider uitgelegd in LVGL Sprites.
Wat er daarna gebeurt
Nadat je hebt ingediend, beoordeelt het PicoPixel-team je pet en kan het contact opnemen als er iets verduidelijkt moet worden. Goedgekeurde pets verschijnen in de Pets-galerij, met jouw naam erbij. Vanaf daar kan iedereen in de community je creatie vinden en gebruiken.
Waar nu heen
- LVGL Sprites, hoe sprite-toestanden en frames werken.
- Event-editor, voeg interactiviteit toe aan je ontwerpen.
- Een sjabloon indienen, deel een PicoPixel-ontwerp waarmee anderen kunnen starten.
- Content melden, meld een pet of sjabloon dat de regels overtreedt.
- Pets-galerij, bekijk communitypets.